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

This software is in beta !

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.series.get_one_series('usgdp')

# com
from macrobond_data_api.com import ComClient

with ComClient() as api:
    series = api.series.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.7.tar.gz (59.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-0.0.7-py3-none-any.whl (105.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: macrobond-data-api-0.0.7.tar.gz
  • Upload date:
  • Size: 59.7 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.7.tar.gz
Algorithm Hash digest
SHA256 3bda11b4a45640423875bfbc7d2a39b7636e1f91f3f99b66a3439df0a03aaa50
MD5 c5072347ea0bf490f5379a775f83262c
BLAKE2b-256 288fdbda6fe75de95cf0cfc1e49ad75420f46ef2cfefd145f6d264dc0f88b589

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9f713a8f1f810b3d9cb3b7c64c367836bd2a5c6c0d9ae0d39b74a333e0789e02
MD5 c5be3099bb014993e752d3067e4f878e
BLAKE2b-256 8ff7933e1108339b295c22e052021276d35015e84f5cf6493f1610400983a0be

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