Kucoin API¶
client module¶
-
class
kucoin.client.
Client
(api_key, api_secret, passphrase, sandbox=False, requests_params=None)[source]¶ Bases:
object
-
REST_API_URL
= 'https://openapi-v2.kucoin.com'¶
-
SANDBOX_API_URL
= 'https://openapi-sandbox.kucoin.com'¶
-
API_VERSION
= 'v1'¶
-
SIDE_BUY
= 'buy'¶
-
SIDE_SELL
= 'sell'¶
-
ACCOUNT_MAIN
= 'main'¶
-
ACCOUNT_TRADE
= 'trade'¶
-
ORDER_LIMIT
= 'limit'¶
-
ORDER_MARKET
= 'market'¶
-
ORDER_LIMIT_STOP
= 'limit_stop'¶
-
ORDER_MARKET_STOP
= 'market_stop'¶
-
STOP_LOSS
= 'loss'¶
-
STOP_ENTRY
= 'entry'¶
-
STP_CANCEL_NEWEST
= 'CN'¶
-
STP_CANCEL_OLDEST
= 'CO'¶
-
STP_DECREASE_AND_CANCEL
= 'DC'¶
-
STP_CANCEL_BOTH
= 'CB'¶
-
TIMEINFORCE_GOOD_TILL_CANCELLED
= 'GTC'¶
-
TIMEINFORCE_GOOD_TILL_TIME
= 'GTT'¶
-
TIMEINFORCE_IMMEDIATE_OR_CANCEL
= 'IOC'¶
-
TIMEINFORCE_FILL_OR_KILL
= 'FOK'¶
-
__init__
(api_key, api_secret, passphrase, sandbox=False, requests_params=None)[source]¶ Kucoin API Client constructor
Parameters: - api_key (string) – Api Token Id
- api_secret (string) – Api Secret
- passphrase (string) – Api Passphrase used to create API
- sandbox (bool) – (optional) Use the sandbox endpoint or not (default False)
- requests_params (dict.) – (optional) Dictionary of requests params to use for all calls
client = Client(api_key, api_secret, api_passphrase)
-
get_currencies
()[source]¶ List known currencies
https://docs.kucoin.com/#get-currencies
currencies = client.get_currencies()
Returns: API Response [ { "currency": "BTC", "name": "BTC", "fullName": "Bitcoin", "precision": 8 }, { "currency": "ETH", "name": "ETH", "fullName": "Ethereum", "precision": 7 } ]
Raises: KucoinResponseException, KucoinAPIException
-
get_currency
(currency)[source]¶ Get single currency detail
https://docs.kucoin.com/#get-currency-detail
# call with no coins currency = client.get_currency('BTC')
Returns: API Response { "currency": "BTC", "name": "BTC", "fullName": "Bitcoin", "precision": 8, "withdrawalMinSize": "0.002", "withdrawalMinFee": "0.0005", "isWithdrawEnabled": true, "isDepositEnabled": true }
Raises: KucoinResponseException, KucoinAPIException
-
get_accounts
()[source]¶ Get a list of accounts
https://docs.kucoin.com/#accounts
accounts = client.get_accounts()
Returns: API Response [ { "id": "5bd6e9286d99522a52e458de", "currency": "BTC", "type": "main", "balance": "237582.04299", "available": "237582.032", "holds": "0.01099" }, { "id": "5bd6e9216d99522a52e458d6", "currency": "BTC", "type": "trade", "balance": "1234356", "available": "1234356", "holds": "0" } ]
Raises: KucoinResponseException, KucoinAPIException
-
get_account
(account_id)[source]¶ Get an individual account
https://docs.kucoin.com/#get-an-account
Parameters: account_id (string) – ID for account - from list_accounts() account = client.get_account('5bd6e9216d99522a52e458d6')
Returns: API Response { "currency": "KCS", "balance": "1000000060.6299", "available": "1000000060.6299", "holds": "0" }
Raises: KucoinResponseException, KucoinAPIException
-
create_account
(account_type, currency)[source]¶ Create an account
https://docs.kucoin.com/#create-an-account
Parameters: - account_type (string) – Account type - main or trade
- currency (string) – Currency code
account = client.create_account('trade', 'BTC')
Returns: API Response { "id": "5bd6e9286d99522a52e458de" }
Raises: KucoinResponseException, KucoinAPIException
-
get_account_activity
(account_id, start=None, end=None, page=None, limit=None)[source]¶ Get list of account activity
https://docs.kucoin.com/#get-account-history
Parameters: - account_id (string) – ID for account - from list_accounts()
- start (string) – (optional) Start time as unix timestamp
- end (string) – (optional) End time as unix timestamp
- page (int) – (optional) Current page - default 1
- limit (int) – (optional) Number of results to return - default 50
history = client.get_account_activity('5bd6e9216d99522a52e458d6') history = client.get_account_activity('5bd6e9216d99522a52e458d6', start='1540296039000') history = client.get_account_activity('5bd6e9216d99522a52e458d6', page=2, page_size=10)
Returns: API Response { "currentPage": 1, "pageSize": 10, "totalNum": 2, "totalPage": 1, "items": [ { "currency": "KCS", "amount": "0.0998", "fee": "0", "balance": "1994.040596", "bizType": "withdraw", "direction": "in", "createdAt": 1540296039000, "context": { "orderId": "5bc7f080b39c5c03286eef8a", "currency": "BTC" } }, { "currency": "KCS", "amount": "0.0998", "fee": "0", "balance": "1994.140396", "bizType": "trade exchange", "direction": "in", "createdAt": 1540296039000, "context": { "orderId": "5bc7f080b39c5c03286eef8e", "tradeId": "5bc7f080b3949c03286eef8a", "symbol": "BTC-USD" } } ] }
Raises: KucoinResponseException, KucoinAPIException
-
get_account_holds
(account_id, page=None, page_size=None)[source]¶ Get account holds placed for any active orders or pending withdraw requests
https://docs.kucoin.com/#get-holds
Parameters: - account_id (string) – ID for account - from list_accounts()
- page (int) – (optional) Current page - default 1
- page_size (int) – (optional) Number of results to return - default 50
holds = client.get_account_holds('5bd6e9216d99522a52e458d6') holds = client.get_account_holds('5bd6e9216d99522a52e458d6', page=2, page_size=10)
Returns: API Response { "currentPage": 1, "pageSize": 10, "totalNum": 2, "totalPage": 1, "items": [ { "currency": "ETH", "holdAmount": "5083", "bizType": "Withdraw", "orderId": "5bc7f080b39c5c03286eef8e", "createdAt": 1545898567000, "updatedAt": 1545898567000 }, { "currency": "ETH", "holdAmount": "1452", "bizType": "Withdraw", "orderId": "5bc7f518b39c5c033818d62d", "createdAt": 1545898567000, "updatedAt": 1545898567000 } ] }
Raises: KucoinResponseException, KucoinAPIException
-
create_inner_transfer
(from_account_id, to_account_id, amount, order_id=None)[source]¶ Get account holds placed for any active orders or pending withdraw requests
https://docs.kucoin.com/#get-holds
Parameters: - from_account_id (str) – ID of account to transfer funds from - from list_accounts()
- to_account_id (str) – ID of account to transfer funds to - from list_accounts()
- amount (int) – Amount to transfer
- order_id (string) – (optional) Request ID (default flat_uuid())
transfer = client.create_inner_transfer('5bd6e9216d99522a52e458d6', 5bc7f080b39c5c03286eef8e', 20)
Returns: API Response { "orderId": "5bd6e9286d99522a52e458de" }
Raises: KucoinResponseException, KucoinAPIException
-
create_deposit_address
(currency)[source]¶ Create deposit address of currency for deposit. You can just create one deposit address.
https://docs.kucoin.com/#create-deposit-address
Parameters: currency (string) – Name of currency address = client.create_deposit_address('NEO')
Returns: ApiResponse { "address": "0x78d3ad1c0aa1bf068e19c94a2d7b16c9c0fcd8b1", "memo": "5c247c8a03aa677cea2a251d" }
Raises: KucoinResponseException, KucoinAPIException
-
get_deposit_address
(currency)[source]¶ Get deposit address for a currency
https://docs.kucoin.com/#get-deposit-address
Parameters: currency (string) – Name of currency address = client.get_deposit_address('NEO')
Returns: ApiResponse { "address": "0x78d3ad1c0aa1bf068e19c94a2d7b16c9c0fcd8b1", "memo": "5c247c8a03aa677cea2a251d" }
Raises: KucoinResponseException, KucoinAPIException
-
get_deposits
(currency=None, status=None, start=None, end=None, page=None, limit=None)[source]¶ Get deposit records for a currency
https://docs.kucoin.com/#get-deposit-list
Parameters: - currency (string) – Name of currency (optional)
- status (string) – optional - Status of deposit (PROCESSING, SUCCESS, FAILURE)
- start (string) – (optional) Start time as unix timestamp
- end (string) – (optional) End time as unix timestamp
- page (int) – (optional) Page to fetch
- limit (int) – (optional) Number of transactions
deposits = client.get_deposits('NEO')
Returns: ApiResponse { "currentPage": 1, "pageSize": 5, "totalNum": 2, "totalPage": 1, "items": [ { "address": "0x5f047b29041bcfdbf0e4478cdfa753a336ba6989", "memo": "5c247c8a03aa677cea2a251d", "amount": 1, "fee": 0.0001, "currency": "KCS", "isInner": false, "walletTxId": "5bbb57386d99522d9f954c5a@test004", "status": "SUCCESS", "createdAt": 1544178843000, "updatedAt": 1544178891000 }, { "address": "0x5f047b29041bcfdbf0e4478cdfa753a336ba6989", "memo": "5c247c8a03aa677cea2a251d", "amount": 1, "fee": 0.0001, "currency": "KCS", "isInner": false, "walletTxId": "5bbb57386d99522d9f954c5a@test003", "status": "SUCCESS", "createdAt": 1544177654000, "updatedAt": 1544178733000 } ] }
Raises: KucoinResponseException, KucoinAPIException
-
get_withdrawals
(currency=None, status=None, start=None, end=None, page=None, limit=None)[source]¶ Get deposit records for a currency
https://docs.kucoin.com/#get-withdrawals-list
Parameters: - currency (string) – Name of currency (optional)
- status (string) – optional - Status of deposit (PROCESSING, SUCCESS, FAILURE)
- start (string) – (optional) Start time as unix timestamp
- end (string) – (optional) End time as unix timestamp
- page (int) – (optional) Page to fetch
- limit (int) – (optional) Number of transactions
withdrawals = client.get_withdrawals('NEO')
Returns: ApiResponse { "currentPage": 1, "pageSize": 10, "totalNum": 1, "totalPage": 1, "items": [ { "id": "5c2dc64e03aa675aa263f1ac", "address": "0x5bedb060b8eb8d823e2414d82acce78d38be7fe9", "memo": "", "currency": "ETH", "amount": 1.0000000, "fee": 0.0100000, "walletTxId": "3e2414d82acce78d38be7fe9", "isInner": false, "status": "FAILURE", "createdAt": 1546503758000, "updatedAt": 1546504603000 } ] }
Raises: KucoinResponseException, KucoinAPIException
-
get_withdrawal_quotas
(currency)[source]¶ Get withdrawal quotas for a currency
https://docs.kucoin.com/#get-withdrawal-quotas
Parameters: currency (string) – Name of currency quotas = client.get_withdrawal_quotas('ETH')
Returns: ApiResponse { "currency": "ETH", "availableAmount": 2.9719999, "remainAmount": 2.9719999, "withdrawMinSize": 0.1000000, "limitBTCAmount": 2.0, "innerWithdrawMinFee": 0.00001, "isWithdrawEnabled": true, "withdrawMinFee": 0.0100000, "precision": 7 }
Raises: KucoinResponseException, KucoinAPIException
-
create_withdrawal
(currency, amount, address, memo=None, is_inner=False, remark=None)[source]¶ Process a withdrawal
https://docs.kucoin.com/#apply-withdraw
Parameters: - currency (string) – Name of currency
- amount (number) – Amount to withdraw
- address (string) – Address to withdraw to
- memo (string) – (optional) Remark to the withdrawal address
- is_inner (bool) – (optional) Remark to the withdrawal address
- remark (string) – (optional) Remark
withdrawal = client.create_withdrawal('NEO', 20, '598aeb627da3355fa3e851')
Returns: ApiResponse { "withdrawalId": "5bffb63303aa675e8bbe18f9" }
Raises: KucoinResponseException, KucoinAPIException
-
cancel_withdrawal
(withdrawal_id)[source]¶ Cancel a withdrawal
https://docs.kucoin.com/#cancel-withdrawal
Parameters: withdrawal_id (string) – ID of withdrawal client.cancel_withdrawal('5bffb63303aa675e8bbe18f9')
Returns: None Raises: KucoinResponseException, KucoinAPIException
-
create_market_order
(symbol, side, size=None, funds=None, client_oid=None, remark=None, stp=None)[source]¶ Create a market order
One of size or funds must be set
https://docs.kucoin.com/#place-a-new-order
Parameters: - symbol (string) – Name of symbol e.g. KCS-BTC
- side (string) – buy or sell
- size (string) – (optional) Desired amount in base currency
- funds (string) – (optional) Desired amount of quote currency to use
- client_oid (string) – (optional) Unique order id (default flat_uuid())
- remark (string) – (optional) remark for the order, max 100 utf8 characters
- stp (string) – (optional) self trade protection CN, CO, CB or DC (default is None)
order = client.create_market_order('NEO', Client.SIDE_BUY, size=20)
Returns: ApiResponse { "orderOid": "596186ad07015679730ffa02" }
Raises: KucoinResponseException, KucoinAPIException, MarketOrderException
-
create_limit_order
(symbol, side, price, size, client_oid=None, remark=None, time_in_force=None, stop=None, stop_price=None, stp=None, cancel_after=None, post_only=None, hidden=None, iceberg=None, visible_size=None)[source]¶ Create an order
https://docs.kucoin.com/#place-a-new-order
Parameters: - symbol (string) – Name of symbol e.g. KCS-BTC
- side (string) – buy or sell
- price (string) – Name of coin
- size (string) – Amount of base currency to buy or sell
- client_oid (string) – (optional) Unique order_id default flat_uuid()
- remark (string) – (optional) remark for the order, max 100 utf8 characters
- stp (string) – (optional) self trade protection CN, CO, CB or DC (default is None)
- time_in_force (string) – (optional) GTC, GTT, IOC, or FOK (default is GTC)
- stop (string) – (optional) stop type loss or entry - requires stop_price
- stop_price (string) – (optional) trigger price for stop order
- cancel_after (string) – (optional) number of seconds to cancel the order if not filled required time_in_force to be GTT
- post_only (bool) – (optional) indicates that the order should only make liquidity. If any part of the order results in taking liquidity, the order will be rejected and no part of it will execute.
- hidden (bool) – (optional) Orders not displayed in order book
- iceberg (bool) – (optional) Only visible portion of the order is displayed in the order book
- visible_size (bool) – (optional) The maximum visible size of an iceberg order
order = client.create_limit_order('KCS-BTC', Client.SIDE_BUY, '0.01', '1000')
Returns: ApiResponse { "orderOid": "596186ad07015679730ffa02" }
Raises: KucoinResponseException, KucoinAPIException, LimitOrderException
-
cancel_order
(order_id)[source]¶ Cancel an order
https://docs.kucoin.com/#cancel-an-order
Parameters: order_id (string) – Order id res = client.cancel_order('5bd6e9286d99522a52e458de)
Returns: ApiResponse { "cancelledOrderIds": [ "5bd6e9286d99522a52e458de" ] }
Raises: KucoinResponseException, KucoinAPIException KucoinAPIException If order_id is not found
-
cancel_all_orders
(symbol=None)[source]¶ Cancel all orders
https://docs.kucoin.com/#cancel-all-orders
res = client.cancel_all_orders()
Returns: ApiResponse { "cancelledOrderIds": [ "5bd6e9286d99522a52e458de" ] }
Raises: KucoinResponseException, KucoinAPIException
-
get_orders
(symbol=None, status=None, side=None, order_type=None, start=None, end=None, page=None, limit=None)[source]¶ Get list of orders
https://docs.kucoin.com/#list-orders
Parameters: - symbol (string) – (optional) Name of symbol e.g. KCS-BTC
- status (string) – (optional) Specify status active or done (default done)
- side (string) – (optional) buy or sell
- order_type (string) – (optional) limit, market, limit_stop or market_stop
- start (string) – (optional) Start time as unix timestamp
- end (string) – (optional) End time as unix timestamp
- page (int) – (optional) Page to fetch
- limit (int) – (optional) Number of orders
orders = client.get_orders(symbol='KCS-BTC', status='active')
Returns: ApiResponse { "currentPage": 1, "pageSize": 1, "totalNum": 153408, "totalPage": 153408, "items": [ { "id": "5c35c02703aa673ceec2a168", "symbol": "BTC-USDT", "opType": "DEAL", "type": "limit", "side": "buy", "price": "10", "size": "2", "funds": "0", "dealFunds": "0.166", "dealSize": "2", "fee": "0", "feeCurrency": "USDT", "stp": "", "stop": "", "stopTriggered": false, "stopPrice": "0", "timeInForce": "GTC", "postOnly": false, "hidden": false, "iceberge": false, "visibleSize": "0", "cancelAfter": 0, "channel": "IOS", "clientOid": null, "remark": null, "tags": null, "isActive": false, "cancelExist": false, "createdAt": 1547026471000 } ] }
Raises: KucoinResponseException, KucoinAPIException
-
get_historical_orders
(symbol=None, side=None, start=None, end=None, page=None, limit=None)[source]¶ List of KuCoin V1 historical orders.
https://docs.kucoin.com/#get-v1-historical-orders-list
Parameters: - symbol (string) – (optional) Name of symbol e.g. KCS-BTC
- side (string) – (optional) buy or sell
- start (string) – (optional) Start time as unix timestamp
- end (string) – (optional) End time as unix timestamp
- page (int) – (optional) Page to fetch
- limit (int) – (optional) Number of orders
orders = client.get_historical_orders(symbol='KCS-BTC')
Returns: ApiResponse { "currentPage": 1, "pageSize": 50, "totalNum": 1, "totalPage": 1, "items": [ { "symbol": "SNOV-ETH", "dealPrice": "0.0000246", "dealValue": "0.018942", "amount": "770", "fee": "0.00001137", "side": "sell", "createdAt": 1540080199 } ] }
Raises: KucoinResponseException, KucoinAPIException
-
get_order
(order_id)[source]¶ Get order details
https://docs.kucoin.com/#get-an-order
Parameters: order_id (str) – orderOid value order = client.get_order('5c35c02703aa673ceec2a168')
Returns: ApiResponse { "id": "5c35c02703aa673ceec2a168", "symbol": "BTC-USDT", "opType": "DEAL", "type": "limit", "side": "buy", "price": "10", "size": "2", "funds": "0", "dealFunds": "0.166", "dealSize": "2", "fee": "0", "feeCurrency": "USDT", "stp": "", "stop": "", "stopTriggered": false, "stopPrice": "0", "timeInForce": "GTC", "postOnly": false, "hidden": false, "iceberge": false, "visibleSize": "0", "cancelAfter": 0, "channel": "IOS", "clientOid": null, "remark": null, "tags": null, "isActive": false, "cancelExist": false, "createdAt": 1547026471000 }
Raises: KucoinResponseException, KucoinAPIException
-
get_fills
(order_id=None, symbol=None, side=None, order_type=None, start=None, end=None, page=None, limit=None)[source]¶ Get a list of recent fills.
https://docs.kucoin.com/#list-fills
Parameters: - order_id (string) – (optional) generated order id
- symbol (string) – (optional) Name of symbol e.g. KCS-BTC
- side (string) – (optional) buy or sell
- order_type (string) – (optional) limit, market, limit_stop or market_stop
- start (string) – Start time as unix timestamp (optional)
- end (string) – End time as unix timestamp (optional)
- page (int) – optional - Page to fetch
- limit (int) – optional - Number of orders
fills = client.get_fills()
Returns: ApiResponse { "currentPage":1, "pageSize":1, "totalNum":251915, "totalPage":251915, "items":[ { "symbol":"BTC-USDT", "tradeId":"5c35c02709e4f67d5266954e", "orderId":"5c35c02703aa673ceec2a168", "counterOrderId":"5c1ab46003aa676e487fa8e3", "side":"buy", "liquidity":"taker", "forceTaker":true, "price":"0.083", "size":"0.8424304", "funds":"0.0699217232", "fee":"0", "feeRate":"0", "feeCurrency":"USDT", "stop":"", "type":"limit", "createdAt":1547026472000 } ] }
Raises: KucoinResponseException, KucoinAPIException
-
get_symbols
()[source]¶ Get a list of available currency pairs for trading.
https://docs.kucoin.com/#symbols-amp-ticker
symbols = client.get_symbols()
Returns: ApiResponse [ { "symbol": "BTC-USDT", "name": "BTC-USDT", "baseCurrency": "BTC", "quoteCurrency": "USDT", "baseMinSize": "0.00000001", "quoteMinSize": "0.01", "baseMaxSize": "10000", "quoteMaxSize": "100000", "baseIncrement": "0.00000001", "quoteIncrement": "0.01", "priceIncrement": "0.00000001", "enableTrading": true } ]
Raises: KucoinResponseException, KucoinAPIException
-
get_ticker
(symbol=None)[source]¶ Get symbol tick
https://docs.kucoin.com/#get-ticker
Parameters: symbol (string) – (optional) Name of symbol e.g. KCS-BTC all_ticks = client.get_ticker() ticker = client.get_ticker('ETH-BTC')
Returns: ApiResponse { "sequence": "1545825031840", # now sequence "price": "3494.367783", # last trade price "size": "0.05027185", # last trade size "bestBid": "3494.367783", # best bid price "bestBidSize": "2.60323254", # size at best bid price "bestAsk": "3499.12", # best ask price "bestAskSize": "0.01474011" # size at best ask price }
Raises: KucoinResponseException, KucoinAPIException
-
get_fiat_prices
(base=None, symbol=None)[source]¶ Get fiat price for currency
https://docs.kucoin.com/#get-fiat-price
Parameters: - base (string) – (optional) Fiat,eg.USD,EUR, default is USD.
- symbol (string) – (optional) Cryptocurrencies.For multiple cyrptocurrencies, please separate them with comma one by one. default is all
prices = client.get_fiat_prices()
Returns: ApiResponse { "BTC": "3911.28000000", "ETH": "144.55492453", "LTC": "48.45888179", "KCS": "0.45546856" }
Raises: KucoinResponseException, KucoinAPIException
-
get_24hr_stats
(symbol)[source]¶ Get 24hr stats for a symbol. Volume is in base currency units. open, high, low are in quote currency units.
Parameters: symbol (string) – (optional) Name of symbol e.g. KCS-BTC stats = client.get_24hr_stats('ETH-BTC')
Returns: ApiResponse Without a symbol param
{ "symbol": "BTC-USDT", "changeRate": "0.0128", # 24h change rate "changePrice": "0.8", # 24h rises and falls in price (if the change rate is a negative number, # the price rises; if the change rate is a positive number, the price falls.) "open": 61, # Opening price "close": 63.6, # Closing price "high": "63.6", # Highest price filled "low": "61", # Lowest price filled "vol": "244.78", # Transaction quantity "volValue": "15252.0127" # Transaction amount }
Raises: KucoinResponseException, KucoinAPIException
-
get_markets
()[source]¶ Get supported market list
https://docs.kucoin.com/#get-market-list
markets = client.get_markets()
Returns: ApiResponse { "data": [ "BTC", "ETH", "USDT" ] }
Raises: KucoinResponseException, KucoinAPIException
-
get_order_book
(symbol)[source]¶ Get a list of bids and asks aggregated by price for a symbol.
Returns up to 100 depth each side. Fastest Order book API
https://docs.kucoin.com/#get-part-order-book-aggregated
Parameters: symbol (string) – Name of symbol e.g. KCS-BTC orders = client.get_order_book('KCS-BTC')
Returns: ApiResponse { "sequence": "3262786978", "bids": [ ["6500.12", "0.45054140"], # [price, size] ["6500.11", "0.45054140"] ], "asks": [ ["6500.16", "0.57753524"], ["6500.15", "0.57753524"] ] }
Raises: KucoinResponseException, KucoinAPIException
-
get_full_order_book
(symbol)[source]¶ Get a list of all bids and asks aggregated by price for a symbol.
This call is generally used by professional traders because it uses more server resources and traffic, and Kucoin has strict access frequency control.
https://docs.kucoin.com/#get-full-order-book-aggregated
Parameters: symbol (string) – Name of symbol e.g. KCS-BTC orders = client.get_order_book('KCS-BTC')
Returns: ApiResponse { "sequence": "3262786978", "bids": [ ["6500.12", "0.45054140"], # [price size] ["6500.11", "0.45054140"] ], "asks": [ ["6500.16", "0.57753524"], ["6500.15", "0.57753524"] ] }
Raises: KucoinResponseException, KucoinAPIException
-
get_full_order_book_level3
(symbol)[source]¶ Get a list of all bids and asks non-aggregated for a symbol.
This call is generally used by professional traders because it uses more server resources and traffic, and Kucoin has strict access frequency control.
https://docs.kucoin.com/#get-full-order-book-atomic
Parameters: symbol (string) – Name of symbol e.g. KCS-BTC orders = client.get_order_book('KCS-BTC')
Returns: ApiResponse { "sequence": "1545896707028", "bids": [ [ "5c2477e503aa671a745c4057", # orderId "6", # price "0.999" # size ], [ "5c2477e103aa671a745c4054", "5", "0.999" ] ], "asks": [ [ "5c24736703aa671a745c401e", "200", "1" ], [ "5c2475c903aa671a745c4033", "201", "1" ] ] }
Raises: KucoinResponseException, KucoinAPIException
-
get_trade_histories
(symbol)[source]¶ List the latest trades for a symbol
https://docs.kucoin.com/#get-trade-histories
Parameters: symbol (string) – Name of symbol e.g. KCS-BTC orders = client.get_trade_histories('KCS-BTC')
Returns: ApiResponse [ { "sequence": "1545896668571", "price": "0.07", # Filled price "size": "0.004", # Filled amount "side": "buy", # Filled side. The filled side is set to the taker by default. "time": 1545904567062140823 # Transaction time }, { "sequence": "1545896668578", "price": "0.054", "size": "0.066", "side": "buy", "time": 1545904581619888405 } ]
Raises: KucoinResponseException, KucoinAPIException
-
get_kline_data
(symbol, kline_type='5min', start=None, end=None)[source]¶ Get kline data
For each query, the system would return at most 1500 pieces of data. To obtain more data, please page the data by time.
Parameters: - symbol (string) – Name of symbol e.g. KCS-BTC
- kline_type (string) – type of symbol, type of candlestick patterns: 1min, 3min, 5min, 15min, 30min, 1hour, 2hour, 4hour, 6hour, 8hour, 12hour, 1day, 1week
- start (int) – Start time as unix timestamp (optional) default start of day in UTC
- end (int) – End time as unix timestamp (optional) default now in UTC
https://docs.kucoin.com/#get-historic-rates
klines = client.get_kline_data('KCS-BTC', '5min', 1507479171, 1510278278)
Returns: ApiResponse [ [ "1545904980", //Start time of the candle cycle "0.058", //opening price "0.049", //closing price "0.058", //highest price "0.049", //lowest price "0.018", //Transaction amount "0.000945" //Transaction volume ], [ "1545904920", "0.058", "0.072", "0.072", "0.058", "0.103", "0.006986" ] ]
Raises: KucoinResponseException, KucoinAPIException
-
get_ws_endpoint
(private=False)[source]¶ Get websocket channel details
Parameters: private (bool) – Name of symbol e.g. KCS-BTC https://docs.kucoin.com/#websocket-feed
ws_details = client.get_ws_endpoint(private=True)
Returns: ApiResponse { "code": "200000", "data": { "instanceServers": [ { "pingInterval": 50000, "endpoint": "wss://push1-v2.kucoin.net/endpoint", "protocol": "websocket", "encrypt": true, "pingTimeout": 10000 } ], "token": "vYNlCtbz4XNJ1QncwWilJnBtmmfe4geLQDUA62kKJsDChc6I4bRDQc73JfIrlFaVYIAE0Gv2--MROnLAgjVsWkcDq_MuG7qV7EktfCEIphiqnlfpQn4Ybg==.IoORVxR2LmKV7_maOR9xOg==" } }
Raises: KucoinResponseException, KucoinAPIException
-
exceptions module¶
-
exception
kucoin.exceptions.
KucoinAPIException
(response)[source]¶ Bases:
exceptions.Exception
Exception class to handle general API Exceptions
code values
message format