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.3.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.3-py3-none-any.whl (115.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: macrobond-data-api-1.0.3.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.3.tar.gz
Algorithm Hash digest
SHA256 523e9435e73e9616d2c1274a40899ae0b21af8d7e81d56b796981010db2e7661
MD5 22be56251b362134ec90e03feb8f8417
BLAKE2b-256 9752d57ca6d0894c5e38b5ce0dd89d03579ad734eed5326906d9f47e233060c2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8a502ddaa1a9a7626cb17a95055d9ff33dd850086690da783cb8e6ce7dbc4ab1
MD5 e5835d3c610d46a2f8ee087e0eae9317
BLAKE2b-256 e85c91c268fb95b23d53192fa2790fad50a43a5024b3ac658205ef1f8876a708

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