Various Examples

The following example prints out the names of all the endpoints queried:

from yfrake import client
import asyncio

@client.session
async def main():
    results = client.get_all(symbol='msft')
    async for resp in results.gather():
        print(f'Endpoint: {resp.endpoint}')

if __name__ == '__main__':
    asyncio.run(main())

The following example prints out either the error or the data property of the ClientResponse objects:

from yfrake import client
import asyncio

@client.session
async def main():
    queries = [
        dict(endpoint='quote_type', symbol='msft'),
        dict(endpoint='price_overview', symbol='gme_to_the_moon'),
        dict(endpoint='key_statistics', symbol='tsla')
    ]
    results = client.batch_get(queries)
    await results.wait()
    for resp in results:
        if resp.error:
            print(f'Error: {resp.error}')
        else:
            print(f'Data: {resp.data}')

if __name__ == '__main__':
    asyncio.run(main())

The following example creates a batch request of 3 endpoints for 3 symbols:

from yfrake import client

@client.session
def main():
    all_queries = list()
    for symbol in ['msft', 'aapl', 'tsla']:
        queries = [
            dict(endpoint='quote_type', symbol=symbol),
            dict(endpoint='price_overview', symbol=symbol),
            dict(endpoint='key_statistics', symbol=symbol)
        ]
        all_queries.extend(queries)

    results = client.batch_get(all_queries)
    results.wait()

    count = len(results)
    print(f'ClientResponse objects: {count}')  # 9

if __name__ == '__main__':
    main()

The following example demonstrates the usage of the get method inside a non-decorated function (or coroutine):

from yfrake import client

def make_the_request(symbol):
    resp = client.get('quote_type', symbol=symbol)
    resp.wait()
    return resp

@client.session
def main():
    resp = make_the_request('msft')
    print(f'Data: {resp.data}')

if __name__ == '__main__':
    main()