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.3.tar.gz (52.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.3-py3-none-any.whl (97.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: macrobond-data-api-0.0.3.tar.gz
  • Upload date:
  • Size: 52.7 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.3.tar.gz
Algorithm Hash digest
SHA256 c8cb6fde93d2c670d378ba7859e8456f03e7f4d6e28063177702e9ddae24d935
MD5 61b2a66ccaa7b9bc64fe627a94459109
BLAKE2b-256 aab5e383d62495a4d9b352ebebfe065dc0be753658d897e95ee8280455caef0e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5ab37711ee7e4a27ee440c4443259c5fde917663a9e1c0f0b75825db767d6845
MD5 d904065d0da9c5583eba76a6fbb053ce
BLAKE2b-256 aa939adec6676d0db47592207df5ebe8efe16d43d611d77c352e2342f8cefcfb

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