Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sdediego/coindesk-api-client
Coindesk API client module
https://github.com/sdediego/coindesk-api-client
api-client bitcoin blockchain coindesk cryptocurrency python
Last synced: 4 days ago
JSON representation
Coindesk API client module
- Host: GitHub
- URL: https://github.com/sdediego/coindesk-api-client
- Owner: sdediego
- License: mit
- Created: 2018-02-19T22:42:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-07T18:44:05.000Z (about 5 years ago)
- Last Synced: 2024-10-12T20:41:19.985Z (about 1 month ago)
- Topics: api-client, bitcoin, blockchain, coindesk, cryptocurrency, python
- Language: Python
- Homepage:
- Size: 64.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CoinDesk API client
Powered by [![CoinDesk]()](https://www.coindesk.com/api/)
Client written in Python3 for CoinDesk API service.
### Features
- Get Bitcoin current price
- Get Bitcoin historical price
### Getting Started
These instructions will get you a copy of the project on your local system.
#### Dependencies
CoinDesk API client uses a number of open source projects to work properly:
* [aiohttp] - Asynchronous HTTP client/server for asyncio and Python
* [furl] - URL parsing and manipulation made easy
* [jsonschema] - An implementation of JSON Schema validation for Python
* [requests] - Python HTTP for Humans
And of course CoinDesk API client itself is open source with a [public repository][coindesk-api-client] on GitHub.
#### Installation
Intall the package from [Pypi][pypi] using the command:
```sh
pip install -U coindesk
```
#### Quick Start
A series of simple examples:
Get currentprice price for Bitcoin in json format
```python
from coindesk.client import CoindeskAPIClient
api_client = CoindeskAPIClient.start('currentprice')
response = api_client.get()
```
Get currentprice price for Bitcoin in other currency than USD
```python
from coindesk.client import CoindeskAPIClient
api_client = CoindeskAPIClient.start('currentprice', {'currency': 'EUR'})
response = api_client.get()
```
Get historical price for Bitcoin in json format
```python
from coindesk.client import CoindeskAPIClient
api_client = CoindeskAPIClient.start('historical')
response = api_client.get()
```
Get historical price for Bitcoin providing optional parameters
```python
from coindesk.client import CoinDeskAPIClient
api_client = CoindeskAPIClient.start('historical', {'currency': 'EUR', 'for': 'yesterday'})
response = api_client.get()
```
Make a request with custom parameters either for currentprice or historical
```python
from coindesk.client import CoinDeskAPIClient
api_client = CoindeskAPIClient.start('currentprice', retries=5, redirects=False, timeout=10)
response = api_client.get()
```
Get raw http response either for currentprice or historical
```python
from coindesk.client import CoinDeskAPIClient
api_client = CoindeskAPIClient.start('currentprice')
response = api_client.get(raw=True)
```
Get supported currencies to fetch Bitcoin price in
```python
from coindesk.client import CoindeskAPIClient
api_client = CoindeskAPIClient()
supported_currencies = api_client.get_supported_currencies()
```
Full documentation for CoinDesk API is available at https://www.coindesk.com/api/.
License
----
MIT
**Free Software. Hell Yeah!**
[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen.)
[coindesk-api-client]:
[pypi]:
[aiohttp]:
[furl]:
[jsonschema]:
[requests]: