Skip to main content

Exposes a common API in Python for the Macrobobond 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 Macrobobond 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.4.tar.gz (52.8 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.4-py3-none-any.whl (97.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: macrobond-data-api-0.0.4.tar.gz
  • Upload date:
  • Size: 52.8 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.4.tar.gz
Algorithm Hash digest
SHA256 4564316634b102759e4ad07fcac6b6704c7ae430fd4b5d27165d8ecf9e7d7d23
MD5 f50baabe87e41b6bfb2d55dbdc8a5402
BLAKE2b-256 434c0476e14b3ef831973bb994d0b92b1352cc641959476822a1c29aa223299c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 eeb72e1b0f3d1b38a6efbdcc961261fe53382461a69ace7f865ac5742cf3651c
MD5 91fd3e546beee397bd4981bafef33bb5
BLAKE2b-256 8b60b28dfebd3f314640bb807f36068b0d05c4664416f41a4b461e33180d5877

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