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-2.0.4.tar.gz (78.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-2.0.4-py3-none-any.whl (125.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: macrobond-data-api-2.0.4.tar.gz
  • Upload date:
  • Size: 78.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for macrobond-data-api-2.0.4.tar.gz
Algorithm Hash digest
SHA256 a81b4f0780d4b5e14ebb7e5416a929c922244e6827211b28c437b09ee075cfb1
MD5 47860bcf618a3d5e13fd5bb6762cc409
BLAKE2b-256 a986d297918dd71235a2232e00b97007d09d83b012777d0a13037bb997cbd5d5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-2.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 242e2f02143e0456cadc4ce4e47a3ba4319469e5a2615f4c0437a26a7131d95a
MD5 6e0f13ec1e7b09fce19a76fa82d78eb2
BLAKE2b-256 1bc1b9e7eb6a572b68ccb43a50743d91a9e814b8b16166fd1dbd56cb181b1978

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