3126123: Created page with "In this document, we provide a brief tutorial on using CoinMarketCap Pro API to access cryptocurrency data. We'll display how to access exchange trading volume and cryptocurre..."

2023-02-27T23:13:06Z

Created page with "In this document, we provide a brief tutorial on using CoinMarketCap Pro API to access cryptocurrency data. We'll display how to access exchange trading volume and cryptocurre..."

New page

In this document, we provide a brief tutorial on using CoinMarketCap Pro API to access cryptocurrency data. We'll display how to access exchange trading volume and cryptocurrency OHLCV data, but using other endpoints is essentially similar. You can find the CMC API documentation [https://coinmarketcap.com/api/documentation/v1/#section/Introduction here].

The only dependencies necessary to run the illustration are <code>load_dotenv</code> and <code>requests</code>.
[[File:Snip1.png|center|346x346px]]
Define a class which will contain the logic for accessing the API. The user can either pass <code>api_key</code> parameter directly to the <code>__init__</code> method or set it as an environment variable. The implementation supports <code>.env</code> files as <code>load_dotenv</code> is called. Make sure to manually create the env file populated with your API key. The base URL is automatically selected based on the existence of a paid API key, but can be overridden if the parameter is set by the user.
[[File:Snip2.png|center]]
Add the <code>session</code> property, which persists the API key across all requests. Furthermore, a <code>Session</code> instance uses a connection pool and reuses the TCP connection, which will lead to a significant increase in performance.
[[File:Snip3.png|center]]
Define a private method, <code>__make_req</code>, which will be used by public methods to send requests to the API. <code>__make_req</code> receives the endpoint address, a dictionary of parameters, which must comply the format explained in the endoint's documentation, and the version of the endpoint. If the API returns an error, it'll be automatically raised. Otherwise, the response will be converted to a <code>dict</code> object and returned.
[[File:Snip4.png|center]]
Time to add the public methods. We'll define methods for cryptocurrency OHLCV and exchange quotes endpoints.
[[File:Snip5.png|center]]
The user can access the data now.
[[File:Snip6.png|center]]
The code results in:
<nowiki>{'status': {'timestamp': '2022-09-06T14:55:37.113Z', 'error_code': 0, 'error_message': None, 'elapsed': 22, 'credit_count': 1, 'notice': None}, 'data': {'binance': {'quotes': [{'timestamp': '2022-09-06T14:50:12.000Z', 'quote': {'USD': {'volume_24h': 73522805073.14716, 'timestamp': '2022-09-06T14:50:12.000Z'}}, 'num_market_pairs': 1702}], 'id': 270, 'name': 'Binance', 'slug': 'binance'}, 'kraken': {'quotes': [{'timestamp': '2022-09-06T14:50:11.000Z', 'quote': {'USD': {'volume_24h': 708319460.386547, 'timestamp': '2022-09-06T14:50:11.000Z'}}, 'num_market_pairs': 619}], 'id': 24, 'name': 'Kraken', 'slug': 'kraken'}}}</nowiki>
Finally, you need to mind the number calls made in a limited interval and potentially add pauses to the code, so the rate limit is not hit. As suggested by CMC, an [[wikipedia:Exponential_backoff|exponential backoff algorithm]] could be used. While in this tutorial we used the CMC API, fetching data from any other API would be quite similar.

The source code for this article can be found [https://github.com/HumanRupert/algorand_handout here].

Cryptocurrency data collection in python - Revision history

3126123: Created page with "In this document, we provide a brief tutorial on using CoinMarketCap Pro API to access cryptocurrency data. We'll display how to access exchange trading volume and cryptocurre..."