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

Uploaded Python 3

File details

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

File metadata

  • Download URL: macrobond-data-api-0.0.2.tar.gz
  • Upload date:
  • Size: 52.9 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.2.tar.gz
Algorithm Hash digest
SHA256 c2e34086b7d5fa029e295c13ee6d706d391557e70946047b02776594bc05bd03
MD5 6e363788384152d66dff3ab79e7aa20d
BLAKE2b-256 0c44aadb47ee5b53c171526426f79ac02c20b7eb38c5ee24459edd5a2bd4f7fa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a9a0c175d6a1e46bd0a1406593fe89e2b1a3a1932be7f6d843ba7c9c321965a2
MD5 51dc019af9cf9541bc426d15b21ee9e8
BLAKE2b-256 60128caa455fbb519aaa937ad9b594c5ac2e678f4bc0f518b2ae778b94e4c236

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