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

pip3 install datamaxi

Configuration

Access to DataMaxi+ is protected by API Key. If you are interested to try DataMaxi+, you can simply sign up for DataMaxi+ through this login/singup page and get free API key for two months.

Option Explanation
api_key Your API key
base_url If base_url is not provided, it defaults to api.datamaxiplus.com.
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 "limit_usage" and "data" keys
show_header Return response as dictionary including "header" and "data" keys

Environment Variables

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

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

Quickstart

DataMaxi+ Python package currently includes the following clients:

  • Binance
  • Bithumb
  • Bybit
  • Coinone
  • Huobi
  • Okx
  • Upbit
  • Defillama
  • Naver
  • Google

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

# CEX
from datamaxi.binance import Binance
from datamaxi.bithumb import Bithumb
from datamaxi.bybit import Bybit
from datamaxi.coinone import Coinone
from datamaxi.huobi import Huobi
from datamaxi.okx import Okx
from datamaxi.upbit import Upbit

# DeFi
from datamaxi.defillama import Defillama

# Trend
from datamaxi.naver import Naver
from datamaxi.google import Google

and initialize them.

# CEX
binance = Binance(api_key=api_key)
bithumb = Bithumb(api_key=api_key)
bybit = Bybit(api_key=api_key)
coinone = Coinone(api_key=api_key)
huobi = Huobi(api_key=api_key)
okx = Okx(api_key=api_key)
upbit = Upbit(api_key=api_key)

# DeFi
defillama = Defillama(api_key=api_key)

# Trend
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
pip3 install -r requirements/requirements-test.txt

python3 -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.3.0.tar.gz (12.2 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.3.0-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for datamaxi-0.3.0.tar.gz
Algorithm Hash digest
SHA256 ff38a33dc757b4840ff5a382ad02a11c613e5b1db2d7602accaa3797cd103edc
MD5 aea44fc11be52cdfeb64b51dda207237
BLAKE2b-256 97feb8091f1ae37b55b9d0a88df957c01fc1ea2a81c46fe4ed88916f09bf42a1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: datamaxi-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 16.9 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 08e8bdd69a627949c6ddafcd7f4ed5a4148606379079620a5010f625b5a138f0
MD5 6881b582dc122a99cc599a29c9efcb6e
BLAKE2b-256 6f5594382e9cd4e904ee0f6cf0af3248a9117e3db12cbc959c73c946e966e0ef

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