From 5dd24eb76f463587b26da4a8562a162d3d04b387 Mon Sep 17 00:00:00 2001 From: bryan Date: Thu, 18 Apr 2024 20:54:34 +0900 Subject: [PATCH] Fix URL (neverest.finance > datamaxiplus.com) --- README.md | 43 +++++++++++++++++----------------- datamaxi/binance/__init__.py | 4 ++-- datamaxi/defillama/__init__.py | 40 +++++++++++++++---------------- datamaxi/lib/constants.py | 2 +- datamaxi/naver/__init__.py | 2 +- 5 files changed, 46 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index d5b0b49..4b596ea 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # 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/) @@ -6,19 +7,19 @@ [![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 [business@bisonai.com](mailto:business@bisonai.com). | 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 diff --git a/datamaxi/binance/__init__.py b/datamaxi/binance/__init__.py index 5bb57fa..63e3e02 100644 --- a/datamaxi/binance/__init__.py +++ b/datamaxi/binance/__init__.py @@ -25,7 +25,7 @@ def symbols(self) -> List[str]: `GET /v1/raw/binance/symbols` - + Returns: List of supported Binance symbols @@ -41,7 +41,7 @@ def kline( `GET /v1/raw/binance/kline` - + Args: symbol (str): Binance symbol diff --git a/datamaxi/defillama/__init__.py b/datamaxi/defillama/__init__.py index 7fbcedc..7043cde 100644 --- a/datamaxi/defillama/__init__.py +++ b/datamaxi/defillama/__init__.py @@ -29,7 +29,7 @@ def protocols(self) -> List[str]: `GET /v1/defillama/protocol` - + Returns: List of supported protocols @@ -42,7 +42,7 @@ def chains(self) -> List[str]: `GET /v1/defillama/chain` - + Returns: List of supported chains @@ -55,7 +55,7 @@ def tokens(self) -> List[str]: `GET /v1/defillama/token` - + Returns: List of supported tokens @@ -68,7 +68,7 @@ def pools(self) -> List[str]: `GET /v1/defillama/pool` - + Returns: List of supported pools @@ -81,7 +81,7 @@ def stablecoins(self) -> List[str]: `GET /v1/defillama/stablecoin` - + Returns: List of supported stablecoins @@ -95,7 +95,7 @@ def tvl(self, pandas: bool = True) -> Union[List, pd.DataFrame]: `GET /v1/defillama/tvl` - + Args: pandas (bool): Return data as pandas DataFrame @@ -114,7 +114,7 @@ def protocol_tvl( `GET /v1/defillama/tvl` - + Args: protocols (Union[str, List[str]]): single protocol or multiple protocol names @@ -136,7 +136,7 @@ def chain_tvl( `GET /v1/defillama/tvl` - + Args: chains (Union[str, List[str]]): single chain or multiple chain names @@ -158,7 +158,7 @@ def protocol_chain_tvl( `GET /v1/defillama/tvl` - + Args: protocol (str): protocol name @@ -180,7 +180,7 @@ def protocol_token_tvl( `GET /v1/defillama/tvl` - + Args: protocol (str): protocol name @@ -206,7 +206,7 @@ def protocol_chain_token_tvl( `GET /v1/defillama/tvl` - + Args: protocol (str): protocol name @@ -236,7 +236,7 @@ def protocol_mcap( `GET /v1/defillama/mcap` - + Args: protocols (Union[str, List[str]]): single protocol or multiple protocol names @@ -260,7 +260,7 @@ def token_price( `GET /v1/defillama/token` - + Args: addresses (Union[str, List[str]]): single address or multiple addresses @@ -292,7 +292,7 @@ def stablecoin_mcap( `GET /v1/defillama/stablecoin` - + Args: stablecoin (str): stablecoin name @@ -315,7 +315,7 @@ def stablecoin_chain_mcap( `GET /v1/defillama/stablecoin` - + Args: stablecoin (str): stablecoin name @@ -340,7 +340,7 @@ def stablecoin_price( `GET /v1/defillama/stablecoin/price` - + Args: stablecoins (Union[str, List[str]]): single stablecoin or multiple stablecoin names @@ -368,7 +368,7 @@ def fee( `GET /v1/defillama/fee` - + Args: protocols (Union[str, List[str]]): single protocol or multiple protocol names @@ -410,7 +410,7 @@ def revenue( `GET /v1/defillama/revenue` - + Args: protocols (Union[str, List[str]]): single protocol or multiple protocol names @@ -448,7 +448,7 @@ def fee_detail( `GET /v1/defillama/fee/detail` - + Args: protocol (str): protocol name @@ -477,7 +477,7 @@ def revenue_detail( `GET /v1/defillama/revenue/detail` - + Args: protocol (str): protocol name diff --git a/datamaxi/lib/constants.py b/datamaxi/lib/constants.py index d34a50d..59567ec 100644 --- a/datamaxi/lib/constants.py +++ b/datamaxi/lib/constants.py @@ -1 +1 @@ -BASE_URL = "http://api.neverest.finance" +BASE_URL = "http://api.datamaxiplus.com" diff --git a/datamaxi/naver/__init__.py b/datamaxi/naver/__init__.py index 2ec771f..46170b4 100644 --- a/datamaxi/naver/__init__.py +++ b/datamaxi/naver/__init__.py @@ -39,7 +39,7 @@ def trend(self, keyword: str, pandas: bool = True) -> Union[List, pd.DataFrame]: `GET /v1/naver/trend` - + Args: keyword (str): keyword to search for