Skip to main content

Exposes a common API in Python for the Macrobond Web and Client Data APIs

Project description

Macrobond Data API for Python

PyPI PyPI License: MIT Code style: black Continuous Integration

The Macrobond Data API for Python is used to access the world’s most extensive macroeconomic, aggregate financial and sector database provided by Macrobond. Exposes a common API in Python for the Macrobond Web and Client data APIs

You have to be a licensed user and have a Data+ or data feed user account in order to use the API.

Examples in Jupyter Notebooks to help you get started

API reference

Basic usage

import macrobond_data_api as mb_api

usgdp = mb_api.get_one_series("usgdp")

Advanced usage

# web
from macrobond_data_api.web import WebClient

with WebClient('client id', 'client secret') as api:
    series = api.get_one_series('usgdp')

# com
from macrobond_data_api.com import ComClient

with ComClient() as api:
    series = api.get_one_series('usgdp')

Features

The Macrobond Data API for Python uses either the Macrobond Web REST API or the Macrobond Client data API to obtain time series with values and metadata. The API consists of a set of functions in common between the underlying APIs as well as specialized functions unique to each implementation.

Installing macrobond-data-api and Supported Versions

Macrobond Data API for Python is available on PyPI:

python -m pip install macrobond-data-api

Macrobond Data API for Python officially supports Python 3.6+.

Using of system keyring

When using WebClient it is recommended to use the system keyring. This can be done easily by running the include script using this command:

python -c "from macrobond_data_api.util import *; save_credential_to_keyring()"

Supported keyrings

Contributing

We welcome community pull requests for bug fixes, enhancements, and documentation.

Getting support

Support options

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

macrobond-data-api-0.0.16.tar.gz (65.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

macrobond_data_api-0.0.16-py3-none-any.whl (113.9 kB view details)

Uploaded Python 3

File details

Details for the file macrobond-data-api-0.0.16.tar.gz.

File metadata

  • Download URL: macrobond-data-api-0.0.16.tar.gz
  • Upload date:
  • Size: 65.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for macrobond-data-api-0.0.16.tar.gz
Algorithm Hash digest
SHA256 6e945e0cf601a6b734590fb45be8dfc3d8b7aa276169c1fa076dbfea758bd03a
MD5 328287e47c6f4d429c802143356eea8f
BLAKE2b-256 a0c1523486a445bc556e292cacbc44b34d82c611dba1f58e38299a2a064df1ec

See more details on using hashes here.

File details

Details for the file macrobond_data_api-0.0.16-py3-none-any.whl.

File metadata

File hashes

Hashes for macrobond_data_api-0.0.16-py3-none-any.whl
Algorithm Hash digest
SHA256 82f9884ba30a80f0aad4012f2a8e72bd5bfee498539a97eeae0ab0cc10392b90
MD5 0a6af4299f075d47dee30084ff7fde77
BLAKE2b-256 d33ee9dea7836f20b24f14729a56bfa5768a1bd53d2319dfa5b9cdffee733a84

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page