marketstack-python

Inofficial Python OpenAPI implementation of the marketstack API based on the marketstack OpenAPI spec.

Usage

Configuration (recommended)

Set up your API key and TLS support as ENV variables.

MARKETSTACK_API_KEY="xyz"
MARKETSTACK_TLS_SUPPORT="1"

Create your client

frommarketstack.clientimportClientimportosdefcreate_client() ->tuple[Client, str]: access_key=os.getenv("MARKETSTACK_API_KEY")
assertaccess_keyisnotNoneandlen(access_key) >0, "Environment variable MARKETSTACK_API_KEY is not defined"tls_support=os.getenv("MARKETSTACK_TLS_SUPPORT")
protocol="https"iftls_support=="1"else"http"client=Client(base_url=f"{protocol}://api.marketstack.com/v1")
returnclient, access_key

Call operations

frommarketstack.api.eodimporteodclient, access_key=create_client()
response=eod.sync(
client=client,
access_key=access_key,
symbols="AAPL,AMZN",
limit=10,
)

All endpoint features are implemented and tested. For examples see the repository's tests/ directory.

Multiple asynchronous calls

importasynciofromtypingimportListfrommarketstack.api.intradayimportintraday_latestfrommarketstack.api.exchangesimportexchangesfrommarketstack.modelsimportPagedResponseListmodelsIntervalPrice, PagedResponseListmodelsExchangeasyncdefload_async(symbols: List[str]):
client, access_key=create_client()
prices_call=intraday_latest.asyncio(access_key=access_key, client=client, symbols=",".join(symbols))
exchanges_call=exchanges.asyncio(access_key=access_key, client=client)
# Type hints for future resultsprices_response: PagedResponseListmodelsIntervalPriceexchanges_response: PagedResponseListmodelsExchangeprices_response, exchanges_response=awaitasyncio.gather(prices_call, exchanges_call)

Error handling

frommarketstack.modelsimportErrorCode, ErrorResponseifisinstance(response, ErrorResponse):
assertresponse.error.code==ErrorCode.FUNCTION_ACCESS_RESTRICTED

Map to Pandas dataframe

importpandasaspddf=pd.DataFrame(map(lambdax: x.__dict__, response.data))

Developers area

Generate the client

1. Install the OpenAPI client generator

   pip install openapi-python-client

2. Regenerate the client

   ./regenerate.sh

Run the tests

1. Setup your marketstack API key in tests/test.env
2. Run the tests via pytest

   PYTHONPATH="." pytest --cov=marketstack tests/

Release update

1. Update version in setup.py
2. Package library

   python setup.py sdist

3. Publish library

   twine upload dist/marketstack-[version].tar.gz

References

• https://github.com/MichaelKim0407/tutorial-pip-package
• https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/