mirror of
https://github.com/wassname/libcryptomarket.git
synced 2026-08-22 12:10:44 +08:00
63 lines
1.7 KiB
Markdown
63 lines
1.7 KiB
Markdown
# libcryptomarket: Powerful cryptocurrency market analysis toolkit
|
|
|
|
## Objective
|
|
|
|
The library is for researchers to analysis cryptocurrency in a fast and
|
|
flexible way. Currently there are different source of API to get the
|
|
cryptocurrency market information. The sources are from websites which provides
|
|
a general comparative information among the currencies and from exchanges. The
|
|
target is to normalize the API functions from data source, and let the users
|
|
query the data without pain.
|
|
|
|
|
|
## Prerequisite
|
|
|
|
Python 3.5+
|
|
|
|
## Installation
|
|
|
|
To install the library, please run the command to install via pip
|
|
|
|
|
|
```
|
|
pip install git+https://github.com/libcryptomarket/libcryptomarket.git
|
|
```
|
|
|
|
## Usage
|
|
|
|
All the query result are converted into pandas Series or DataFrame.
|
|
|
|
### Instrument
|
|
|
|
To get a list of available currencies, run
|
|
|
|
```
|
|
from libcryptomarket.instrument import get_instruments
|
|
|
|
instruments = get_instruments()
|
|
```
|
|
|
|
### Historical
|
|
|
|
Run
|
|
|
|
```
|
|
from datetime import datetime
|
|
from libcryptomarket.historical import get_historical_prices
|
|
|
|
prices = get_historical_prices(symbol='LTCBTC',
|
|
exchange='Poloniex',
|
|
period="hour",
|
|
from_time=datetime(2017, 5, 1),
|
|
to_time=datetime(2017, 8, 1))
|
|
```
|
|
|
|
Then you can get historical price in ascending order seamlessly, even though
|
|
the limit has exceeded the source limit. The application helps continue
|
|
querying until the data reaches the requirements.
|
|
|
|
## Contribution
|
|
|
|
The project is targeting as a core but generic toolkit to query cryptocurrency
|
|
market, so we are happy if you join to contribute and make it better. Please
|
|
do not hesitate to contact us (gavincyi at gmail dot com). |