Skip to content

Commit

Permalink
Fix URL (neverest.finance > datamaxiplus.com)
Browse files Browse the repository at this point in the history
  • Loading branch information
bryan-bisonai committed Apr 18, 2024
1 parent 806733d commit 5dd24eb
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 45 deletions.
43 changes: 22 additions & 21 deletions README.md
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

Expand All @@ -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 |
Expand All @@ -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,
Expand Down Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions datamaxi/binance/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def symbols(self) -> List[str]:
`GET /v1/raw/binance/symbols`
<https://docs.neverest.finance/cex/binance/symbols>
<https://docs.datamaxiplus.com/cex/binance/symbols>
Returns:
List of supported Binance symbols
Expand All @@ -41,7 +41,7 @@ def kline(
`GET /v1/raw/binance/kline`
<https://docs.neverest.finance/cex/binance/kline>
<https://docs.datamaxiplus.com/cex/binance/kline>
Args:
symbol (str): Binance symbol
Expand Down
40 changes: 20 additions & 20 deletions datamaxi/defillama/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def protocols(self) -> List[str]:
`GET /v1/defillama/protocol`
<https://docs.neverest.finance/defillama/protocol>
<https://docs.datamaxiplus.com/defillama/protocol>
Returns:
List of supported protocols
Expand All @@ -42,7 +42,7 @@ def chains(self) -> List[str]:
`GET /v1/defillama/chain`
<https://docs.neverest.finance/defillama/chain>
<https://docs.datamaxiplus.com/defillama/chain>
Returns:
List of supported chains
Expand All @@ -55,7 +55,7 @@ def tokens(self) -> List[str]:
`GET /v1/defillama/token`
<https://docs.neverest.finance/defillama/token>
<https://docs.datamaxiplus.com/defillama/token>
Returns:
List of supported tokens
Expand All @@ -68,7 +68,7 @@ def pools(self) -> List[str]:
`GET /v1/defillama/pool`
<https://docs.neverest.finance/defillama/pool>
<https://docs.datamaxiplus.com/defillama/pool>
Returns:
List of supported pools
Expand All @@ -81,7 +81,7 @@ def stablecoins(self) -> List[str]:
`GET /v1/defillama/stablecoin`
<https://docs.neverest.finance/defillama/stablecoin>
<https://docs.datamaxiplus.com/defillama/stablecoin>
Returns:
List of supported stablecoins
Expand All @@ -95,7 +95,7 @@ def tvl(self, pandas: bool = True) -> Union[List, pd.DataFrame]:
`GET /v1/defillama/tvl`
<https://docs.neverest.finance/defillama/tvl>
<https://docs.datamaxiplus.com/defillama/tvl>
Args:
pandas (bool): Return data as pandas DataFrame
Expand All @@ -114,7 +114,7 @@ def protocol_tvl(
`GET /v1/defillama/tvl`
<https://docs.neverest.finance/defillama/tvl>
<https://docs.datamaxiplus.com/defillama/tvl>
Args:
protocols (Union[str, List[str]]): single protocol or multiple protocol names
Expand All @@ -136,7 +136,7 @@ def chain_tvl(
`GET /v1/defillama/tvl`
<https://docs.neverest.finance/defillama/tvl>
<https://docs.datamaxiplus.com/defillama/tvl>
Args:
chains (Union[str, List[str]]): single chain or multiple chain names
Expand All @@ -158,7 +158,7 @@ def protocol_chain_tvl(
`GET /v1/defillama/tvl`
<https://docs.neverest.finance/defillama/tvl>
<https://docs.datamaxiplus.com/defillama/tvl>
Args:
protocol (str): protocol name
Expand All @@ -180,7 +180,7 @@ def protocol_token_tvl(
`GET /v1/defillama/tvl`
<https://docs.neverest.finance/defillama/tvl>
<https://docs.datamaxiplus.com/defillama/tvl>
Args:
protocol (str): protocol name
Expand All @@ -206,7 +206,7 @@ def protocol_chain_token_tvl(
`GET /v1/defillama/tvl`
<https://docs.neverest.finance/defillama/tvl>
<https://docs.datamaxiplus.com/defillama/tvl>
Args:
protocol (str): protocol name
Expand Down Expand Up @@ -236,7 +236,7 @@ def protocol_mcap(
`GET /v1/defillama/mcap`
<https://docs.neverest.finance/defillama/mcap>
<https://docs.datamaxiplus.com/defillama/mcap>
Args:
protocols (Union[str, List[str]]): single protocol or multiple protocol names
Expand All @@ -260,7 +260,7 @@ def token_price(
`GET /v1/defillama/token`
<https://docs.neverest.finance/defillama/token-price>
<https://docs.datamaxiplus.com/defillama/token-price>
Args:
addresses (Union[str, List[str]]): single address or multiple addresses
Expand Down Expand Up @@ -292,7 +292,7 @@ def stablecoin_mcap(
`GET /v1/defillama/stablecoin`
<https://docs.neverest.finance/defillama/stablecoin-mcap>
<https://docs.datamaxiplus.com/defillama/stablecoin-mcap>
Args:
stablecoin (str): stablecoin name
Expand All @@ -315,7 +315,7 @@ def stablecoin_chain_mcap(
`GET /v1/defillama/stablecoin`
<https://docs.neverest.finance/defillama/stablecoin-mcap>
<https://docs.datamaxiplus.com/defillama/stablecoin-mcap>
Args:
stablecoin (str): stablecoin name
Expand All @@ -340,7 +340,7 @@ def stablecoin_price(
`GET /v1/defillama/stablecoin/price`
<https://docs.neverest.finance/defillama/stablecoin-price>
<https://docs.datamaxiplus.com/defillama/stablecoin-price>
Args:
stablecoins (Union[str, List[str]]): single stablecoin or multiple stablecoin names
Expand Down Expand Up @@ -368,7 +368,7 @@ def fee(
`GET /v1/defillama/fee`
<https://docs.neverest.finance/defillama/fee>
<https://docs.datamaxiplus.com/defillama/fee>
Args:
protocols (Union[str, List[str]]): single protocol or multiple protocol names
Expand Down Expand Up @@ -410,7 +410,7 @@ def revenue(
`GET /v1/defillama/revenue`
<https://docs.neverest.finance/defillama/revenue>
<https://docs.datamaxiplus.com/defillama/revenue>
Args:
protocols (Union[str, List[str]]): single protocol or multiple protocol names
Expand Down Expand Up @@ -448,7 +448,7 @@ def fee_detail(
`GET /v1/defillama/fee/detail`
<https://docs.neverest.finance/defillama/fee-detail>
<https://docs.datamaxiplus.com/defillama/fee-detail>
Args:
protocol (str): protocol name
Expand Down Expand Up @@ -477,7 +477,7 @@ def revenue_detail(
`GET /v1/defillama/revenue/detail`
<https://docs.neverest.finance/defillama/revenue-detail>
<https://docs.datamaxiplus.com/defillama/revenue-detail>
Args:
protocol (str): protocol name
Expand Down
2 changes: 1 addition & 1 deletion datamaxi/lib/constants.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
BASE_URL = "http://api.neverest.finance"
BASE_URL = "http://api.datamaxiplus.com"
2 changes: 1 addition & 1 deletion datamaxi/naver/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ def trend(self, keyword: str, pandas: bool = True) -> Union[List, pd.DataFrame]:
`GET /v1/naver/trend`
<https://docs.neverest.finance/naver/trend>
<https://docs.datamaxiplus.com/naver/trend>
Args:
keyword (str): keyword to search for
Expand Down

0 comments on commit 5dd24eb

Please sign in to comment.