Skip to content

Repository files navigation

🌊 Bitkub Official API Docs 🌊

📚 The one and only official documentation for Bitkub's trading APIs 📚

OfficialREST APIWebSocket

✅ Officially supported & maintained by Bitkub's own development team

⚠️Accept no substitutes. The use of any other projects is not supported — please make sure you are visiting bitkub/bitkub-official-api-docs.


Documentation

📄 ReferenceDescription
rest-v1.mdDetails on the RESTful API V1 (deprecated)
rest-v2.mdDetails on the RESTful API V2 (deprecated)
rest-v3.mdDetails on the RESTful API V3
rest-v4.mdDetails on the RESTful API V4
websocket-public.mdDetails on the Public WebSocket API
websocket-private.mdDetails on the Private WebSocket API


Announcement

  • Fiat deposit and withdraw history older than 90 days is archived for deposits and withdraws. More details here.
  • Crypto deposit and withdraw history older than 90 days is archived for deposits and withdraws. More details here.
  • /api/v3/market/wallet and /api/v3/market/balances are deprecated. Please migrate to GET /api/v4/wallet/balances and GET /api/v4/wallet/assets as replacements.
  • Fiat v3 endpoints will be deprecated on 09 June 2026.** Please migrate to Fiat v4 endpoints as replacement: POST /api/v3/fiat/accounts, POST /api/v3/fiat/withdraw, POST /api/v3/fiat/deposit-history, POST /api/v3/fiat/withdraw-history
  • remove status: "cancelled" from my-order-info after 3 days period. remove on 9 April 2026
  • The following market endpoints will be deprecated on 9 Dec 2025. Please use v3 endpoints as replacement: GET /api/market/symbols, GET /api/market/ticker, GET /api/market/trades, GET /api/market/bids, GET /api/market/asks, GET /api/market/books, GET /api/market/depth
  • Page-based pagination will be deprecated on 8 Sep 2025 for my-order-history.
  • Order history older than 90 days is archived for my-order-history More details here.
  • order_id and txn_id formats of my-open-orders, my-order-history, my-order-info, place-bid, place-ask, cancel-order may change for some symbols due to a system upgrade, See affected symbols and detail : here
  • API Specifications for Crypto Endpoints, please refer to the documentation here: Crypto Endpoints
  • Deprecation of Order Hash for my-open-orders, my-order-history, my-order-info, place-bid, place-ask, cancel-order on 28/02/2025 onwards, More details here
  • Deposit history records are available for the last 90 days only for GET /api/v4/crypto/deposits. Records older than 90 days are archived.
  • ⚠️ 2026-05-18:market.trade.<symbol> stream will be permanently closed. Please migrate to Private WebSocket.

About

Official Documentation for Bitkub APIs

Resources

Stars

4 stars

Watchers

50 watching

Forks

Releases

Packages

Used by

Contributors