-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix URL (neverest.finance > datamaxiplus.com)
- Loading branch information
1 parent
806733d
commit 5dd24eb
Showing
5 changed files
with
46 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,25 @@ | ||
# DataMaxi+ Python Client | ||
|
||
[![PyPI version](https://img.shields.io/pypi/v/datamaxi)](https://pypi.python.org/pypi/datamaxi) | ||
[![Python version](https://img.shields.io/pypi/pyversions/datamaxi)](https://www.python.org/downloads/) | ||
[![Documentation](https://img.shields.io/badge/docs-latest-blue)](https://datamaxi.readthedocs.io/en/stable/) | ||
[![Code Style](https://img.shields.io/badge/code_style-black-black)](https://black.readthedocs.io/en/stable/) | ||
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/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](https://docs.neverest.finance/). | ||
The package can be used to fetch both historical and latest data using [DataMaxi+ API](https://docs.datamaxiplus.com/). | ||
This package is compatible with Python v3.8+. | ||
|
||
* [Installation](#installation) | ||
* [Configuration](#configuration) | ||
* [Environment Variables](#environment-variables) | ||
* [Quickstart](#quickstart) | ||
* [Local Development](#local-development) | ||
* [Setup](#setup) | ||
* [Testing](#testing) | ||
* [Links](#links) | ||
* [Contributing](#contributing) | ||
* [License](#license) | ||
- [Installation](#installation) | ||
- [Configuration](#configuration) | ||
- [Environment Variables](#environment-variables) | ||
- [Quickstart](#quickstart) | ||
- [Local Development](#local-development) | ||
- [Setup](#setup) | ||
- [Testing](#testing) | ||
- [Links](#links) | ||
- [Contributing](#contributing) | ||
- [License](#license) | ||
|
||
## Installation | ||
|
||
|
@@ -32,9 +33,9 @@ Access to DataMaxi+ is protected by API Key. | |
If you are interested to try DataMaxi+, you can request your API key at [[email protected]](mailto:[email protected]). | ||
|
||
| Option | Explanation | | ||
|--------------------|---------------------------------------------------------------------------------------| | ||
| ------------------ | ------------------------------------------------------------------------------------- | | ||
| `api_key` | Your API key | | ||
| `base_url` | If `base_url` is not provided, it defaults to `api.neverest.finance`. | | ||
| `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 including `"limit_usage"` and `"data"` keys | | ||
|
@@ -45,17 +46,17 @@ If you are interested to try DataMaxi+, you can request your API key at [busines | |
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` | ||
- `Binance` | ||
- `Defillama` | ||
- `Naver` | ||
- `Google` | ||
|
||
All clients accept the same parameters that are described at [Configuration](#configuration) section. | ||
First, import the clients, | ||
|
@@ -93,9 +94,9 @@ python -m pytest tests/ | |
|
||
## Links | ||
|
||
* [DataMaxi+](https://datamaxiplus.com/) | ||
* [DataMaxi+ API](https://api.neverest.finance/) | ||
* [DataMaxi+ API Documentation](https://docs.neverest.finance/) | ||
- [DataMaxi+](https://datamaxiplus.com/) | ||
- [DataMaxi+ API](https://api.datamaxiplus.com/) | ||
- [DataMaxi+ API Documentation](https://docs.datamaxiplus.com/) | ||
|
||
## Contributing | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
BASE_URL = "http://api.neverest.finance" | ||
BASE_URL = "http://api.datamaxiplus.com" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters