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

# 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.5.tar.gz (53.2 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.5-py3-none-any.whl (97.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for macrobond-data-api-0.0.5.tar.gz
Algorithm Hash digest
SHA256 ed34f369c3914ec897c5752c280578d81f2e43add54a2667047add2fc077dcbf
MD5 cc751b38b97761bd14e0449caeca8246
BLAKE2b-256 9c146f09c7b280f1031d973a513c7d6720a12644842f6c64ea15c073e738585f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7a24d9fb4514152e2dcdf497fb209459f5693b15c1f07cb35dfedf5a85acec5d
MD5 0bf6e7bb3615cfc33a6ab9e75c94074f
BLAKE2b-256 324d5e67dc6a92a4c8c1cc88563197368d95ffeaa3203cce110f916d73c63ba0

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