Official Python client for DataMaxi+ API
Project description
DataMaxi+ Python Client
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:
Datamaxi
Defillama
Naver
Google
All clients accept the same parameters that are described at Configuration section. First, import the clients,
# Main client to access crypto trading data
from datamaxi.datamaxi import Datamaxi
# DeFi
from datamaxi.defillama import Defillama
# Trend
from datamaxi.naver import Naver
from datamaxi.google import Google
and initialize them.
# Main client
maxi = Datamaxi(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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for datamaxi-0.16.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ff3968f953fa0cc6865b1165f0c81895ba52fef523782d6c0ef1bccaa50b23d |
|
MD5 | 891e9e69b167a6e5f6731e6ffacb1cd2 |
|
BLAKE2b-256 | dda74cf3097783542c4080097921380cf392a2ae10e2ad3723feded3e66b6ebf |