Skip to main content

Official Python client for DataMaxi+ API

Project description

DataMaxi+ Python Client

PyPI version Python version Documentation Code Style License: MIT

This is the official implementation of Python client for DataMaxi+ API. The package can be used to fetch both historical and latest data using DataMaxi+ API. This package is compatible with Python v3.8+.

Installation

pip install datamaxi

Configuration

Access to DataMaxi+ is protected by API Key. If you are interested to try DataMaxi+, you can request your API key at business@bisonai.com.

Option Explanation
api_key Your API key
base_url If base_url is not provided, it defaults to api.neverest.finance.
timeout Number of seconds to wait for a server response. By default requests do not time out.
proxies Proxy through which the request is queried
show_limit_usage Return response as dictionary including including "limit_usage" and "data" keys
show_header Return response as dictionary including including "header" and "data" keys

Environment Variables

You may use environment variables to configure the DataMaxi+ client to avoid any inline boilerplate.

Env Description
NEVEREST_API_KEY Used instead of api_key if none is passed.

Quickstart

DataMaxi+ Python package currently includes the following clients:

  • Binance
  • Defillama
  • Naver
  • Google

All clients accept the same parameters that are described at Configuration section. First, import the clients,

from datamaxi.binance import Binance
from datamaxi.defillama import Defillama
from datamaxi.naver import Naver
from datamaxi.google import Google

and initialize them.

binance = Binance(api_key=api_key)
defillama = Defillama(api_key=api_key)
naver = Naver(api_key=api_key)
google = Google(api_key=api_key)

Local Development

Setup

If you wish to work on local development please clone/fork the git repo and use pip install -r requirements.txt to setup the project.

Testing

# In case packages are not installed yet
pip install -r requirements/requirements-test.txt

python -m pytest tests/

Links

Contributing

We welcome contributions! If you discover a bug in this project, please feel free to open an issue to discuss the changes you would like to propose.

License

MIT License

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

datamaxi-0.1.0.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

datamaxi-0.1.0-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file datamaxi-0.1.0.tar.gz.

File metadata

  • Download URL: datamaxi-0.1.0.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for datamaxi-0.1.0.tar.gz
Algorithm Hash digest
SHA256 06f5df55fd0bb185cb7e2659499329588315973d7f2a9141fd8560787609a539
MD5 471f657f755839a79b05373e7b0cfd94
BLAKE2b-256 4856ede68512be10cef35cc60811d81c07ac45a86ccabc7c4454221c3950ab3a

See more details on using hashes here.

File details

Details for the file datamaxi-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: datamaxi-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for datamaxi-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b39b86db37330886c91f2d78793878320a84f4c7f2c98646ddc422250c41cb1a
MD5 78e084500106ca2a188d8268f9ecfd70
BLAKE2b-256 84903f76c5bf599c6b6c867241988adddf01e18e67ed452988ba2bd0820875cc

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