charles-achilefu / Kucoin.jl

Kucoin API with Julia

Welcome to Kucoin.jl

This is a Julia wrapper for the Kucoin exchange API.

🚧 Work In Progress! 🚧

REST API

• [] add sandbox environment docs_link

User API

• [] user info docs_link
• [] create an account docs_link
• list accounts docs_link
• [] get an account docs_link
• [] get account ledgers docs_link
• [] get account balance of a sub-account docs_link
• [] get the aggregated balance of all sub-accounts docs_link
• [] get the transferable docs_link
• [] transfer between master user and sub-user docs_link
• [] inner transfer docs_link
• [] create deposit address docs_link
• [] get deposit addresses v2 docs_link
• [] get deposit addresses docs_link
• [] get deposit list docs_link
• [] get v1 historical deposits list docs_link
• [] get withdrawals list docs_link
• [] get v1 historical withdrawals list docs_link
• [] get withdrawal quotas docs_link
• [] apply withdraw docs_link
• [] cancel withdraw docs_link
• [] basic user fee docs_link
• actual fee rate of the trading pair docs_link

Trade API

• place a new order docs_link
• [] place a margin order docs_link
• [] place bulk orders docs_link
• [] cancel an order docs_link
• [] cancel single order by clientOid docs_link
• cancel all orders docs_link
• [] list orders docs_link
• [] get v1 historical orders list docs_link
• [] recent orders docs_link
• [] get an order docs_link
• [] get single active order by clientOid docs_link
• [] list fills docs_link
• [] recent fills docs_link
• [] place a new stop order docs_link
• [] cancel a stop order docs_link
• [] cancel stop orders docs_link
• [] get a single stop order info docs_link
• [] list stop orders docs_link
• [] get a single stop order by clientOid docs_link
• [] cancel a single stop order by clientOid docs_link

Market data API

• get symbols list docs_link
• [] get ticker docs_link
• get all tickers docs_link
• [] get 24hr stats docs_link
• [] get market list docs_link
• [] get part order book aggregated docs_link
• [] get full order book aggregated docs_link
• [] get trade histories docs_link
• [] get klines docs_link
• [] get currencies docs_link
• [] get currency detail docs_link
• [] get currency detail recommend docs_link
• [] get fiat price docs_link
• [] get fiat price docs_link

Margin trade API

• [] get mark price docs_link
• [] get margin configuration info docs_link
• [] get margin account docs_link
• [] post borrow order docs_link
• [] get borrow order docs_link
• [] get repay record docs_link
• [] get repayment record docs_link
• [] one click repayment docs_link
• [] repay a single order docs_link
• [] post lend order docs_link
• [] cancel lend order docs_link
• [] set auto lend docs_link
• [] get active order docs_link
• [] get lent history docs_link
• [] get active lend order list docs_link
• [] get settled lend order history docs_link
• [] get account lend record docs_link
• [] lending market data docs_link
• [] margin trade data docs_link

Others

• [] server time docs_link
• [] service status docs_link

WebSockets API

• apply connect token docs_link
• create connection docs_link
• ping docs_link
• subscribe docs_link
• unsubscribe docs_link
• [] multiplex docs_link

Usage

REST API

using UUIDs: uuid1
using Kucoin: ApiData, place_limit_order, get_all_tickers

println(get_all_tickers())

api_data = ApiData(;
        key="api-key",
        secret="api-secret",
        passphrase="api-passphrase",
    )
result = place_limit_order(
    api_data;
    price="100",
    size="0.452",
    time_in_force="FOK",
    client_order_id=string(uuid1()),
    side="sell",
    symbol="KCS-USDT",
)
println(result)

WebSockets API

Public channels

using Kucoin: WebSocketClient, subscribe, unsubscribe

ws_client = WebSocketClient()
subscribe(ws_client, "/market/ticker:BTC-USDT")
for _ in 1:5
    take!(ws_client)
end
unsubscribe(ws_client, "/market/ticker:BTC-USDT")
for _ in 1:5
    take!(ws_client)
end

Private channels

using Kucoin: ApiData, WebSocketClient, subscribe, unsubscribe

api_data = ApiData(;
        key="api-key",
        secret="api-secret",
        passphrase="api-passphrase",
    )

ws_client = WebSocketClient(api_data)
subscribe(ws_client, "/account/balance")
for _ in 1:5
    take!(ws_client)
end
unsubscribe(ws_client, "/account/balance")
for _ in 1:5
    take!(ws_client)
end