wassname/libcryptomarket
1
0
Fork 0
mirror of https://github.com/wassname/libcryptomarket.git synced 2026-09-09 11:25:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Gavin.Chan
2018-03-02 14:50:39 +00:00
parent 6c8f0188ea
commit c1c3741ac4
1 changed files with 44 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+44 -69
View File
@@ -30,84 +30,59 @@ or development version
pip install git+https://github.com/libcryptomarket/libcryptomarket.git
```
## Exchanges supported
## API Usage
| Exchange | Public API | Private API |
This library is to extend the library [ccxt](https://github.com/ccxt/ccxt) on
more powerful functions. So the supported exchanges are same as ccxt while
a few exchanges are extended with the following features. You just need to
import the exchange from libcryptomarket.
### Candles
```
from datetime import datetime
import libcryptomarket
poloniex = libcryptomarket.poloniex()
candles = libcryptomarket.fetch_candles(
symbol="ETH/BTC",
start_time=datetime(2018, 1, 1),
end_time=datetime(2018, 1, 30),
frequency="30m")
```
### Latest candles
```
from datetime import datetime
import libcryptomarket
poloniex = libcryptomarket.poloniex()
candles = libcryptomarket.fetch_latest_candles(
symbols=["ETH/BTC", "LTC/BTC"],
frequency="30m",
frequency_count=5)
```
### Supported exchanges
| Exchange | candles | latest_candles |
|---|---|---|
| [Bitfinex](https://docs.bitfinex.com/v2/docs/ws-general) | v | x |
| [BitMEX](https://www.bitmex.com/api/explorer/) | v | x |
| [Bittrex](https://bittrex.com/home/api) | v | x |
| [CoinMarketCap](https://coinmarketcap.com/api/) | v | x |
| [GDAX](https://docs.gdax.com/#api) | v | x |
| [Poloniex](https://poloniex.com/support/api/) | v | v |
| Poloniex | v | v |
| Bitfinex | v | v |
| GDAX | v | v |
## Basic Usage
### Generic API
## Console Usage
You can just make a simple call to query the same function from different
exchanges. For example, if you want to get the historical data from GDAX and
Bitfinex in a 5 minute timeframe, just call
Console usage is for exporting historical data.
### Request candles
```
In [1]: from libcryptomarket.api import GdaxApi, BitfinexApi
In [2]: from libcryptomarket.core import historical_ticker
In [3]: from datetime import datetime
In [4]: ticker1 = historical_ticker(source=GdaxApi(), symbol="BTC-USD", period=300, start_time=datetime(2017, 12, 30, 12, 0, 0), end_time=datetime(2017, 12, 31, 12, 0, 0))
In [5]: ticker2 = historical_ticker(source=BitfinexApi(), symbol="tBTCUSD", period="5m", start_time=datetime(2017, 12, 30, 12, 0, 0), end_time=datetime(2017, 12, 31, 12, 0, 0))
request-candles --exchange poloniex --symbols ETH/BTC LTC/BTC --frequency 30m --start-time 2018-01-01 --end-time 2018-01-31 --output test.csv
```
The historical data query automatically rolls over if the exchange response
chunk a long period data. It can guarantee that you do not need to write your
own logic to get a long period of data.
### Exchange API
You can easily initialize an exchange API client and call any method stated
in the exchange API official documentation. The return value is always
the native response from library `requests`.
For example, to get GDAX order book information,
```
In [1]: from libcryptomarket.api import GdaxApi
In [2]: exchange = GdaxApi()
In [3]: exchange.products_book(product_id="BTC-USD").json()
Out[3]:
{'asks': [['14903.01', '22.60310282', 18]],
'bids': [['14903', '3.4933731', 2]],
'sequence': 4757644393}
```
Also, to buy order in Poloniex,
```
In [1]: from libcryptomarket.api import PoloniexApi
In [2]: exchange = PoloniexApi(public_key="<your public key>", private_key="<your private key>")
In [3]: exchange.buy(currencyPair="BTC_LTC", rate=0.001, amount=0.1, postOnly=1)
```
The exchange API methods are always delimited by underscore.
| Exchange | Method | libcryptomarket | URL |
|---|---|---|---|
| [Bitfinex](https://docs.bitfinex.com/v2/docs/ws-general) | [candles](https://docs.bitfinex.com/v2/reference#rest-public-candles) | `BitfinexApi().candles(timeframe="1m", symbol="tBTCUSD", session="hist")` | https://api.bitfinex.com/v2/candles/trade:1m:tBTCUSD/hist |
| [BitMEX](https://www.bitmex.com/api/explorer/) | [trades/bucketed](https://www.bitmex.com/api/explorer/#!/Trade/Trade_getBucketed) | `BitmexApi().trade_bucketed(binSize="1m", symbol="XBTUSD")` | https://www.bitmex.com/api/v1/trade/bucketed?binSize=1m&symbol=XBTUSD |
| [Bittrex](https://bittrex.com/home/api) | [/public/getorderbook](https://bittrex.com/home/api) | `BittrexApi().get_order_book(market="BTC-LTC", type="both")` | https://bittrex.com/api/v1.1/public/getorderbook?market=BTC-LTC&type=both |
| [CoinMarketCap](https://coinmarketcap.com/api/) | [ticket/<id>/](https://coinmarketcap.com/api/) | `CoinMarketCapApi().ticker(id="bitcoin", convert="EUR")` | https://api.coinmarketcap.com/v1/ticker/bitcoin/?convert=EUR |
| [GDAX](https://docs.gdax.com/#api) | [/products/<product-id>/candles](https://docs.gdax.com/#get-historic-rates) | `GdaxApi().products_candles(product_id="BTC-USD")` | https://api.gdax.com/products/BTC-USD/candles |
| [Poloniex](https://poloniex.com/support/api/) | [returnOrderBook](https://poloniex.com/support/api/#returnOrderBook) | `PoloniexApi().return_order_book(currencyPair="BTC_NXT", depth=10)` | https://poloniex.com/public?command=returnOrderBook&currencyPair=BTC_NXT&depth=10 |
## Contribution
The project is targeting as a core but generic toolkit to query cryptocurrency