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.9+.

Using of system keyring for credentials

[!NOTE] If u are using a proxy see "Using of system keyring for http proxy" first.

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

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

Using of system keyring for http proxy

For users operating behind an HTTP proxy, it is advisable to utilize the system keyring to store proxy settings and credentials. This can be conveniently accomplished by executing the included script with the following command:

python -c "from macrobond_data_api.util import *; save_proxy_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-3.0.1.tar.gz (86.9 kB view details)

Uploaded Source

Built Distribution

macrobond_data_api-3.0.1-py3-none-any.whl (136.2 kB view details)

Uploaded Python 3

File details

Details for the file macrobond_data_api-3.0.1.tar.gz.

File metadata

  • Download URL: macrobond_data_api-3.0.1.tar.gz
  • Upload date:
  • Size: 86.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for macrobond_data_api-3.0.1.tar.gz
Algorithm Hash digest
SHA256 16003d006ce1959f80c872709b9d57d2d8786be0f66a0e1446d27369bdc9c64a
MD5 0ab7cf153e173102c001eb0f9f46c390
BLAKE2b-256 5e77ebcb2b163fbfb3e2b61ee2af24f408184463deae41e2f60126b88c845cdf

See more details on using hashes here.

Provenance

The following attestation bundles were made for macrobond_data_api-3.0.1.tar.gz:

Publisher: python-publish.yml on macrobond/macrobond-data-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0ce61b5c2245832cee7d781fee7bca6a0e316d17772253ec8cb5fe03173edd8d
MD5 2ac190a35133e2562344e8f846c3ee65
BLAKE2b-256 b9897c5d83ab4b748799d7bba8498d46925459b625d6926e829c7ebf3700c111

See more details on using hashes here.

Provenance

The following attestation bundles were made for macrobond_data_api-3.0.1-py3-none-any.whl:

Publisher: python-publish.yml on macrobond/macrobond-data-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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