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.8.tar.gz (60.5 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.8-py3-none-any.whl (106.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: macrobond-data-api-0.0.8.tar.gz
  • Upload date:
  • Size: 60.5 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.8.tar.gz
Algorithm Hash digest
SHA256 29a80a23235cf6ccd6719f3b4007bffb1d75e6660fb6695afd6206122b23f48d
MD5 9e75f4f5a9a7c7428b4206fe48f19a74
BLAKE2b-256 68e758cc2aae03e02c4ee098f788aa921915424202544c8028ef873d4e4cc15b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for macrobond_data_api-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 8cd6e82a74c927f99f10c304cd95e6b9f29cfef513d390a8445bfea06f4b6dee
MD5 1b3759cb3c0dae9fe8f6bee3f4499c04
BLAKE2b-256 7457b1552b67ff7faf0c7994bb8eb0d52c2ad997b649442340da2dd7f163177e

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