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

Uploaded Python 3

File details

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

File metadata

  • Download URL: macrobond-data-api-0.0.13.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.13.tar.gz
Algorithm Hash digest
SHA256 725cfdf39c86116c63c4d0062781c985a1fb3522ccf00bac0834d422e53cdeb1
MD5 f9825b2a8b047b1eecd505282d3f82d3
BLAKE2b-256 9bf179c58207eb343ea68e7a00ad598b2ca4acc5746207bba72752811c8ca64f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-0.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 010b50669a93ec0f21a0cb0adad9652b26766447b41b600d7a056eb586c84c31
MD5 2de14fa19e3487156c998daa74474c1a
BLAKE2b-256 17d30349c85ff07fa8f738714ba64d1ee7214355ccf69c5d0afd63d394adb89d

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