diff --git a/README.md b/README.md index 5b3a412..f78b66c 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ -cex.io-api-python -================= +# cex.io-api-python CEX.IO API integration. Python sources. -##Intro +## Intro 1. Download lib 2. Get API key and API secret on https://cex.io/trade/profile -##How to use? +## How to use? -###1. Create your python project +### 1. Create your python project -###2. Add "import cexapi" +### 2. Add "import cexapi" + +### 3. Create class -###3. Create class ```python api = cexapi.api(username,api_key,api_secret) ``` @@ -22,9 +22,10 @@ username - your username on cex.io api_key - your API key api_secret - your API secret code -###4. Methods and parameters: +### 4. Methods and parameters: + +#### a) API method parametrs -####a) API method parametrs ``` 1. couple = ("GHS\BTC" | "BF1\BTC") currency pair 2. since = integer return trades with tid >= since @@ -34,7 +35,8 @@ api_secret - your API secret code 6. price = float ``` -####b) API methods +#### b) API methods + ``` 1. ticker(couple = 'GHS/BTC') - get ticker 2. order_book(couple = 'GHS/BTC') - get order @@ -45,69 +47,82 @@ api_secret - your API secret code 7. place_order(ptype = 'buy', amount = 1, price = 1, couple = 'GHS/BTC') - create order ``` -####c) Full API documentation: https://cex.io/api +#### c) Full API documentation: https://cex.io/api -###5. Examples +### 5. Examples + +#### Connect and get balance: -####Connect and get balance: ```python import cexapi api = cexapi.api(username, api_key, api_secret) print api.balance() ``` + ```json -{'timestamp': '1383378763', 'BTC': {'available': '0.04722110', 'orders': '0.00170000'}, 'GHS': {'available': '0.01000000'} } +{"timestamp": "1383378763", "BTC": {"available": "0.04722110", "orders": "0.00170000"}, "GHS": {"available": "0.01000000"} } ``` -####Get balance: +#### Get balance: + ```python print api.balance() ``` + ```json -{'timestamp': '1383379054', 'BTC': {'available': '0.04614310', 'orders': '0.00170000'}, 'GHS': {'available': '0.02000000'}} +{"timestamp": "1383378763", "BTC": {"available": "0.04722110", "orders": "0.00170000"}, "GHS": {"available": "0.01000000"} } ``` -####Get API ticker: +#### Get API ticker: + ```python print api.ticker('GHS/BTC') ``` + ```json -{'volume': '7154.78339022', 'last': '0.1078', 'timestamp': '1383379041', 'bid': '0.10778', 'high': '0.10799999', 'low': '0.10670076', 'ask': '0.10780000000000001'} +{"volume": "7154.78339022", "last": "0.1078", "timestamp": "1383379041", "bid": "0.10778", "high": "0.10799999", "low": "0.10670076", "ask": "0.10780000000000001"} ``` -####Get order book: +#### Get order book: ```python print api.order_book('BF1/BTC') ``` + ```json -{'timestamp': '1383378967', 'bids': [['1.7', '0.30100000'], ['1.67', '0.00011000'], ['0.8', '0.02070000'], ['0.1002', '0.27748002'], ['0.1', '0.10000000'], ['0.011', '0.30500000'], ['0.009', '1.00000000'], ['0.00171', '0.00100000'], ['0.0012', '1.00000000'], ['0.00116819', '0.50000000'], ['0.001002', '33.00000000'], ['0.001001', '53.00000000'], ['0.001', '3.00000000'], ['0.00097626', '36.00000000'], ['0.0006', '85.00000000'], ['0.00058409', '0.50000000'], ['0.0004889', '0.06823960'], ['0.0003', '1.00000000'], ['0.00029204', '0.90000000'], ['0.0001', '101.00000000']], 'asks': []} +{"timestamp": "1383378967", "bids": [["1.7", "0.30100000"], ["1.67", "0.00011000"], ["0.8", "0.02070000"], ["0.1002", "0.27748002"], ["0.1", "0.10000000"], ["0.011", "0.30500000"], ["0.009", "1.00000000"], ["0.00171", "0.00100000"], ["0.0012", "1.00000000"], ["0.00116819", "0.50000000"], ["0.001002", "33.00000000"], ["0.001001", "53.00000000"], ["0.001", "3.00000000"], ["0.00097626", "36.00000000"], ["0.0006", "85.00000000"], ["0.00058409", "0.50000000"], ["0.0004889", "0.06823960"], ["0.0003", "1.00000000"], ["0.00029204", "0.90000000"], ["0.0001", "101.00000000"]], "asks": []} ``` -####Get your current active orders: +#### Get your current active orders: + ```python print api.current_orders('BF1/BTC') ``` + ```json -[{'price': '1.7', 'amount': '0.00100000', 'time': '1383378514737', 'type': 'buy', 'id': '6219104', 'pending': '0.00100000'}] +[{"price": "1.7", "amount": "0.00100000", "time": "1383378514737", "type": "buy", "id": "6219104", "pending": "0.00100000"}] ``` -####Place new order: +#### Place new order: + ```python print api.place_order('buy', 0.001, 1.7, 'BF1/BTC') ``` + ```json -{'price': '1.7', 'amount': '0.00100000', 'time': 1383378987622, 'type': 'buy', 'id': '6219145', 'pending': '0.00100000'} +{"price": "1.7", "amount": "0.00100000", "time": 1383378987622, "type": "buy", "id": "6219145", "pending": "0.00100000"} ``` -####Place another order (GHS/BTC): +#### Place another order (GHS/BTC): ```python print api.place_order('buy', 0.01, 0.10789, 'GHS/BTC') ``` + ```json -{'price': '0.10789', 'amount': '0.01000000', 'time': 1383379024072, 'type': 'buy', 'id': '6219150', 'pending': '0.00000000'} +{"price": "0.10789", "amount": "0.01000000", "time": 1383379024072, "type": "buy", "id": "6219150", "pending": "0.00000000"} ``` -####Cancel order: +#### Cancel order: + ```python print api.cancel_order(6219145) ```