Merge pull request #10 from donbagger/update-endpoints

Add contract, mapping, key info, and changelog endpoints (v1.1.0)

Author: r--w

.github/workflows/main.yaml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
       - uses: actions/checkout@v3

README.md

@@ -33,12 +33,62 @@ client = Coinpaprika.Client(api_key="YOUR-API-KEY")
 ```
 API KEY can be generated [https://coinpaprika.com/api/](https://coinpaprika.com/api/).
 
+## API Coverage
+
+### Market Data
+```python
+client.global_market()                    # Global market overview
+client.coins()                            # List all coins
+client.coin("btc-bitcoin")               # Coin details
+client.tickers()                          # All tickers
+client.ticker("btc-bitcoin")             # Ticker for specific coin
+client.historical("btc-bitcoin", start="2024-01-01")  # Historical tickers (Pro)
+```
+
+### OHLCV
+```python
+client.candle("btc-bitcoin")              # Latest 24h OHLCV
+client.ohlcv("btc-bitcoin", start="2024-01-01")  # Historical OHLCV
+client.today("btc-bitcoin")              # Today's OHLCV (updates until close)
+```
+
+### Exchanges
+```python
+client.exchange_list()                    # List exchanges
+client.exchange("binance")               # Exchange details
+client.exchange_markets("binance")       # Markets on exchange
+```
+
+### Contracts
+```python
+client.platforms()                        # List contract platforms
+client.contracts("eth-ethereum")          # Contracts on Ethereum
+client.ticker_by_contract("eth-ethereum", "0xdac1...")  # Ticker by contract
+client.historical_by_contract("eth-ethereum", "0xdac1...", start="2024-01-01")  # Historical by contract
+```
+
+### Other
+```python
+client.search(q="bitcoin")               # Search coins, exchanges, people, tags
+client.price_converter(base_currency_id="btc-bitcoin", quote_currency_id="usd-us-dollars", amount=1)
+client.coin_mappings()                    # ID mappings to CoinGecko, CMC, etc. (Pro)
+client.people("vitalik-buterin")         # Person details
+client.tags()                             # List tags
+client.tag("blockchain-service")         # Tag details
+client.twitter("btc-bitcoin")            # Twitter timeline
+client.events("btc-bitcoin")             # Coin events
+client.exchanges("btc-bitcoin")          # Exchanges for coin
+client.markets("btc-bitcoin")            # Markets for coin
+client.key_info()                         # API key usage info (requires key)
+client.changelog_ids()                    # Recent changelog IDs (Pro)
+```
+
 ## Examples
 Check out the [./examples](./examples) directory.
 
 ## Tests
 
-```test
+```bash
 pip install -r test_requirements.txt
 
 pytest tests/test_api_request.py

coinpaprika/client.py

@@ -147,3 +147,34 @@ def search(self, **params):
 
     def price_converter(self, **params):
         return self._get("price-converter", data=params)
+
+    def coin_mappings(self, **params):
+        """Get ID mappings to other data providers (CoinGecko, CoinMarketCap, etc.)."""
+        return self._get("coins/mappings", data=params)
+
+    def platforms(self):
+        """Get list of contract platforms (blockchains that support smart contracts)."""
+        return self._get("contracts")
+
+    def contracts(self, platform_id):
+        """Get all contracts/tokens on a given platform."""
+        return self._get("contracts/{}".format(platform_id))
+
+    def ticker_by_contract(self, platform_id, contract_address):
+        """Get ticker data for a token by its contract address on a given platform."""
+        return self._get("contracts/{}/{}".format(platform_id, contract_address))
+
+    def historical_by_contract(self, platform_id, contract_address, **params):
+        """Get historical ticker data for a token by contract address."""
+        return self._get(
+            "contracts/{}/{}/historical".format(platform_id, contract_address),
+            data=params,
+        )
+
+    def key_info(self):
+        """Get API key usage information (requires API key)."""
+        return self._get("key/info")
+
+    def changelog_ids(self):
+        """Get recent changelog IDs for coins that changed recently."""
+        return self._get("changelog/ids")

pyproject.toml

@@ -7,13 +7,13 @@ build-backend="setuptools.build_meta"
 
 [project]
 name = "coinpaprika-sdk"
-version = "1.0.0"
+version = "1.1.0"
 authors = [
   { name="coinpaprika", email="it@coinpaprika.com" },
 ]
 description = "Official coinpaprika API Python client"
 readme = "README.md"
-requires-python = ">=3.7"
+requires-python = ">=3.9"
 classifiers = [
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: Apache Software License",

setup.py

@@ -2,17 +2,23 @@
 
 setup(
     name='coinpaprika-sdk',
-    version='1.0.0',
+    version='1.1.0',
     author='Coinpaprika',
     author_email='it@coinpaprika.com',
     description='Official coinpaprika API Python client',
     packages=['coinpaprika'],
     url='https://github.com/coinpaprika/coinpaprika-api-python-client',
     license='Apache License 2.0',
     install_requires=['requests'],
+    python_requires='>=3.9',
     keywords='coinpaprika api cryptocurrency',
     classifiers=[
         'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
+        'Programming Language :: Python :: 3.13',
         'License :: OSI Approved :: Apache Software License',
         'Operating System :: OS Independent',
         'Intended Audience :: Developers',

tests/test_api_request.py

@@ -474,3 +474,170 @@ def test_api_exchange_markets():
         result = client.exchange_markets(exchange_id="coinbase", quotes="USD")
 
     assert result == expected
+
+
+def test_api_search():
+    expected = {"currencies": [{"id": "btc-bitcoin", "name": "Bitcoin"}]}
+    with requests_mock.mock() as m:
+        m.get(
+            "https://api.coinpaprika.com/v1/search?q=btc&c=currencies&limit=5",
+            status_code=200,
+            json=expected,
+        )
+        result = client.search(q="btc", c="currencies", limit=5)
+
+    assert result == expected
+
+
+def test_api_price_converter():
+    expected = {
+        "base_currency_id": "btc-bitcoin",
+        "quote_currency_id": "usd-us-dollars",
+        "amount": 1337,
+        "price": 37508969,
+    }
+    with requests_mock.mock() as m:
+        m.get(
+            "https://api.coinpaprika.com/v1/price-converter?base_currency_id=btc-bitcoin&quote_currency_id=usd-us-dollars&amount=1337",
+            status_code=200,
+            json=expected,
+        )
+        result = client.price_converter(
+            base_currency_id="btc-bitcoin",
+            quote_currency_id="usd-us-dollars",
+            amount=1337,
+        )
+
+    assert result == expected
+
+
+def test_api_ticker():
+    expected = {
+        "id": "btc-bitcoin",
+        "name": "Bitcoin",
+        "symbol": "BTC",
+        "quotes": {"USD": {"price": 28000}},
+    }
+    with requests_mock.mock() as m:
+        m.get(
+            "https://api.coinpaprika.com/v1/tickers/btc-bitcoin?quotes=USD",
+            status_code=200,
+            json=expected,
+        )
+        result = client.ticker(coin_id="btc-bitcoin", quotes="USD")
+
+    assert result == expected
+
+
+def test_api_platforms():
+    expected = ["btc-bitcoin", "eth-ethereum", "sol-solana"]
+    with requests_mock.mock() as m:
+        m.get(
+            "https://api.coinpaprika.com/v1/contracts",
+            status_code=200,
+            json=expected,
+        )
+        result = client.platforms()
+
+    assert result == expected
+
+
+def test_api_contracts():
+    expected = [
+        {
+            "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
+            "type": "ERC20",
+            "id": "usdt-tether",
+            "active": True,
+        },
+    ]
+    with requests_mock.mock() as m:
+        m.get(
+            "https://api.coinpaprika.com/v1/contracts/eth-ethereum",
+            status_code=200,
+            json=expected,
+        )
+        result = client.contracts(platform_id="eth-ethereum")
+
+    assert result == expected
+
+
+def test_api_ticker_by_contract():
+    expected = {
+        "id": "usdt-tether",
+        "name": "Tether",
+        "symbol": "USDT",
+        "quotes": {"USD": {"price": 1.0}},
+    }
+    with requests_mock.mock() as m:
+        m.get(
+            "https://api.coinpaprika.com/v1/contracts/eth-ethereum/0xdac17f958d2ee523a2206206994597c13d831ec7",
+            status_code=200,
+            json=expected,
+        )
+        result = client.ticker_by_contract(
+            platform_id="eth-ethereum",
+            contract_address="0xdac17f958d2ee523a2206206994597c13d831ec7",
+        )
+
+    assert result == expected
+
+
+def test_api_historical_by_contract():
+    expected = [
+        {"timestamp": "2024-01-01T00:00:00Z", "price": 1.0, "volume_24h": 50000000000},
+    ]
+    with requests_mock.mock() as m:
+        m.get(
+            "https://api.coinpaprika.com/v1/contracts/eth-ethereum/0xdac17f958d2ee523a2206206994597c13d831ec7/historical?start=2024-01-01",
+            status_code=200,
+            json=expected,
+        )
+        result = client.historical_by_contract(
+            platform_id="eth-ethereum",
+            contract_address="0xdac17f958d2ee523a2206206994597c13d831ec7",
+            start="2024-01-01",
+        )
+
+    assert result == expected
+
+
+def test_api_coin_mappings():
+    expected = [
+        {"id": "btc-bitcoin", "coingecko": "bitcoin", "coinmarketcap": 1},
+    ]
+    with requests_mock.mock() as m:
+        m.get(
+            "https://api.coinpaprika.com/v1/coins/mappings",
+            status_code=200,
+            json=expected,
+        )
+        result = client.coin_mappings()
+
+    assert result == expected
+
+
+def test_api_key_info():
+    expected = {"plan": "free", "usage": {"current_month": {"requests": 500}}}
+    with requests_mock.mock() as m:
+        m.get(
+            "https://api.coinpaprika.com/v1/key/info",
+            status_code=200,
+            json=expected,
+        )
+        result = client.key_info()
+
+    assert result == expected
+
+
+def test_api_changelog_ids():
+    expected = ["btc-bitcoin", "eth-ethereum"]
+    with requests_mock.mock() as m:
+        m.get(
+            "https://api.coinpaprika.com/v1/changelog/ids",
+            status_code=200,
+            json=expected,
+        )
+        result = client.changelog_ids()
+
+    assert result == expected