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.8.tar.gz (66.7 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.8-py3-none-any.whl (115.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: macrobond-data-api-1.0.8.tar.gz
  • Upload date:
  • Size: 66.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for macrobond-data-api-1.0.8.tar.gz
Algorithm Hash digest
SHA256 0de42e9427017eb6edf978c9c4e1a20590716218b9fe1aa303ff819e30f5d3e4
MD5 f496c1fd2e6f9fdc76b543500cf885fa
BLAKE2b-256 20f23788860eb269f5ed87a602aa0c45d718d65ab61de5b1884d158183f2b7c6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 d63104238298722fc944fbdb0346f05ac97e7757ba2c6c2b1e3e3a7c9e56ce14
MD5 b2fc99f99248d2557637dd355ada6505
BLAKE2b-256 a97b6ef3ad560a394a570c4d638736d2e75b31e301cc308b1ac558625f27abd4

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