Features

Implementation of REST endpoints
Simple handling of authentication
Response exception handling
Implement websockets (note only python3.6+)

update

2024 02/26

add Api: margin.get_interest_rates:Get Interest Rates.

2024 02/19

trade.get_hf_filled_list: same to trade.get_hf_transaction_records Get HF Filled List
- The trade.get_hf_transaction_records method will be removed at some time in the future
trade.get_hf_completed_orders: same to trade.get_filled_hf_order Get HF Completed order list
- The trade.get_filled_hf_order method will be removed at some time in the future

2024 02/07

margin.get_etf_info: Get Leveraged Token Info.
margin.get_margin_account_Detail: Get Account Detail - Cross Margin.
margin.get_isolated_margin_account_detail: Get Account Detail - Isolated Margin.
margin.get_margin_currencies: Get Cross/Isolated Margin Risk Limit/Currency config.
trade.create_oco_order: Place Order.
trade.cancel_oco_order: Cancel Order by orderId.
trade.cancel_oco_order_by_clientOid: Cancel Order by clientOid.
trade.cancel_all_oco_orders: Cancel Multiple Orders.
trade.get_oco_order_by_orderId: Get Order Info by orderId.
trade.get_oco_order_by_client_oid: Get Order Info by clientOid.
trade.get_oco_orders: Get Order List.
trade.get_oco_order_details: Get Order Details by orderId.
trade.cancel_all_hf_orders: Cancel all HF orders.
customized websocket: ./kucoin/example_customized_ws_private.py | kucoin/example_customized_ws_public.py

sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)

set api TCP_NODELAY：After instantiating the client, you can cancel the Nagle algorithm through client.TCP_NODELAY=1 (default is 0)

kucoin/example_client_TCP_NODELAY.py

Quick Start

To test on the Sandbox with KuCoin Sandbox.

Generate an API Key or Generate an API Key in Sandbox and enable it.

pip install kucoin-python

#  MarketData
from kucoin.client import Market
client = Market(url='https://api.kucoin.com')
# client = Market()

# or connect to Sandbox
# client = Market(url='https://openapi-sandbox.kucoin.com')
# client = Market(is_sandbox=True)

# get symbol kline
klines = client.get_kline('BTC-USDT','1min')

# get symbol ticker
server_time = client.get_server_timestamp()

api_key = '<api_key>'
api_secret = '<api_secret>'
api_passphrase = '<api_passphrase>'

# Trade
from kucoin.client import Trade
client = Trade(key='', secret='', passphrase='', is_sandbox=False, url='')

# or connect to Sandbox
# client = Trade(api_key, api_secret, api_passphrase, is_sandbox=True)

# place a limit buy order
order_id = client.create_limit_order('BTC-USDT', 'buy', '1', '8000')

# place a market buy order   Use cautiously
order_id = client.create_market_order('BTC-USDT', 'buy', size='1')

# cancel limit order 
client.cancel_order('5bd6e9286d99522a52e458de')

# User
from kucoin.client import User
client = User(api_key, api_secret, api_passphrase)

# or connect to Sandbox
# client = User(api_key, api_secret, api_passphrase, is_sandbox=True)

address = client.get_withdrawal_quota('KCS')