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-2.0.2.tar.gz (78.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-2.0.2-py3-none-any.whl (125.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: macrobond-data-api-2.0.2.tar.gz
  • Upload date:
  • Size: 78.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for macrobond-data-api-2.0.2.tar.gz
Algorithm Hash digest
SHA256 74e1f8961da04fe5968f8c4bf5ba1edcf1740cd3f32d032a7fc1a2a2d9cbb1f1
MD5 3cbb600fd77cbb41362e234b211a234f
BLAKE2b-256 e835066a207a6037eac6d053ecc17a5c9f5e7b7af236b8c68c748552ed76725c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5b5e011025a390190410408baa7e0996e7ec6df44b077061da309e97763df8c2
MD5 54b4070f474c64da6a0d60d1b002b809
BLAKE2b-256 180aa40e210ca7a3c76758c7a30af9dedb0f2a6bce889a79da2c44a75478935a

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