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.6.tar.gz (59.3 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.6-py3-none-any.whl (103.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: macrobond-data-api-0.0.6.tar.gz
  • Upload date:
  • Size: 59.3 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.6.tar.gz
Algorithm Hash digest
SHA256 c756d21a9aa4604ae92b6bbace179a76c01e6cb32566fb50e4c6115276e647e0
MD5 4c37dd942cc9acc56bf1e3db545d3e9e
BLAKE2b-256 4b7acad0450054dbfaf8574c01c5a0df451a60496ea4297a63d5cde1df95e4f2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 33f63396e954bd1ef8209794eccf49ddbd506ef6a2faa1bbcdf9dce9a56e9a08
MD5 fc03021731f64cb3ab864a73d247e378
BLAKE2b-256 ad9377af8417bcf595142ad95a37e288c0a80471795da94b256cc3b20fc08b6a

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