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-1.0.5.tar.gz (66.6 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-1.0.5-py3-none-any.whl (115.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: macrobond-data-api-1.0.5.tar.gz
  • Upload date:
  • Size: 66.6 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-1.0.5.tar.gz
Algorithm Hash digest
SHA256 36a00ff5c029ae2556474e626e1154539bac7ca248e185758fdf67577c880f95
MD5 3d64acf46b4d49ef10a670fd2cdf7d7c
BLAKE2b-256 04787255fbc71d630dd03c73006dc9901e9d03f210d1b78e5a4dcd0c019dc006

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 90cd77296cca6123d95a619825012d4b1cdcb2d5e95d94eea791314ef3f033dc
MD5 7f0150fc34114ae5e46b3d48f934c5ed
BLAKE2b-256 d1b601d000948d38e05183f58f5505391b056d0799015d62f6a13363e56d10d3

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