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.9.tar.gz (60.9 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.9-py3-none-any.whl (107.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: macrobond-data-api-0.0.9.tar.gz
  • Upload date:
  • Size: 60.9 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.9.tar.gz
Algorithm Hash digest
SHA256 fa2df5c92eb13abff884b41a29ef2900cf2448b2da12d6f2217ca49fb387dfb5
MD5 606cc27d1cfe05e3203fe997a651bb68
BLAKE2b-256 ea00b11cce1c664a68e5a8d43d9b3e171ce45da84d795f3c54a1fd6eecf3aaea

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-0.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 1a6b9560791e750899940fa2f43431ef88a54649dfd9cffefcb5aafa802c1077
MD5 bae90d47002784b11b8107e3df27dd36
BLAKE2b-256 5f2265ffd195d7be5f7b3a9602d988933a54e8912e7e1876fa4c253d737f97d3

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