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.

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.12.tar.gz (63.5 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.12-py3-none-any.whl (110.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for macrobond-data-api-0.0.12.tar.gz
Algorithm Hash digest
SHA256 d23d6a05c233e0576abe521ba7e751af7136ee82637268d244088d06626c455d
MD5 76127992d79a97ff80c48604ff4c3757
BLAKE2b-256 e75677e09d7bd51fed0637f6c761ee1de46ea86b997dec77710bc052d3e42b2c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-0.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 7f2f32c4a19f693411f064ae7519d1d1d6880daad0509ea51d12c4d8b22b50b8
MD5 0af53be88c8736320a4c76cd6df7c713
BLAKE2b-256 cc266f4fc1543acd92df851c25a00954de3951f828bd92a626ec37e8841b1614

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