Changelog
[Mar 27, 2025] Updates include new fields in futures contract & funding rate interfaces' return values, and adjusted input params for spot transaction details.
Endpoints:/api/v2/mix/account/accounts
Additional content:
- The return value of the futures contract account interface has been updated with a new field
available
, which represents the maximum transferable amount of combined margin in the current currency.
Endpoints:/api/v2/mix/market/current-fund-rate
Additional content:
- The return value of the interface for obtaining the current funding rate has been updated with new parameters, including fundingRateInterval, upper and lower limits of funding rate, and next update time.
Endpoints:/api/v2/spot/trade/fills
Changes content:
- The
symbol
in the request parameters has been changed from required to optional.
[Mar 22, 2025] New Response Fields in Futures Account Channel
Channel: Futures - Private Channel - Account Channel
Change: Add "crossedRiskRate"(Risk ratio in cross margin mode) and "unrealizedPL"(Unrealized PnL) in push data
[Mar 20,2025] For Spot get order information endpoints, it is adjusted to only support to get the order data within 2 hours when queried by clientOid
Endpoints: Spot get order info interfaces
Change: Querying order information based on ClientOid
only supports to get the data within last 2 hours.
[Mar 18,2025] Adjust the input parameter instructions for modifying the ApiKey permissions of a sub-account.
Endpoints: :/api/v2/broker/manage/modify-subaccount-apikey
Changes content:
- Modify the sub-account ApiKey permissions: The input parameter permType (permission type) has been changed to a required field.
[Mar 12,2025] Adjustment to the period input parameter for obtaining contract initiative buying and selling volume information.
Endpoints: :/api/v2/mix/market/long-short
Changes content:
- Change the input parameter period field from
1d
to1Dutc
.
[Mar 11,2025] API for new OI position limit information in contracts
Endpoints: :/api/v2/mix/market/oi-limit
Additional content:
- API for new OI position limit information in contracts
[Feb 19,2025] Add a description for instId in the public channel for Margin.
Changes content:
- Add a description for instId in the public channel for Margin. Only supports:
default
[Feb 18,2025] Add the userId response field to the broker sub-account recharge records.
Endpoints: :/api/v2/broker/subaccount-deposit
Changes content:
- Add the userId response field to the broker sub-account recharge records.
[Feb 07,2025] Add instructions for using the classic account simulation environment.
Additional content:
- Instructions for subscribing to simulation environment messages via Websocket.
- Instructions for using RestApi to conduct API trading in the simulation environment.
[Feb 03,2025] New addition to futures error codes:
Additional content:
- New contract error
code 22067
has been added, meaning: "Operations are prohibited during ADL processing."
[Jan 16,2025] The futures contract financial record has added an enumeration for the futureTaxType parameter.
Endpoints: :/api/v2/tax/future-record
Additional content:
- Add the enumeration type and description for the return value parameter
futureTaxType
[Jan 15,2025] Bitget to adjust the calculation of USDC-M perpetual futures index price from USD to USDC
Key adjustments
- Index price and mark price: The index price and mark price of USDC-M perpetual futures will now be denominated in USDC.
- Order book prices: Order book prices for USDC-M perpetual futures will also be denominated in USDC.
For more details, please refer to: https://www.bitget.com/support/articles/12560603820643
[Dec 24,2024] The rate limit change on Convert endpoint
/api/v2/convert/trade, The rate limit is changed from 10 req/sec/UID to 5 req/sec/UID
[Dec 16,2024] Get Spot TransferRecords endpoint adjust parameters
Endpoints: Get Account Transfer Records Change: The "idLessThan" parameter for the spot account transfer record interface has been deprecated, and a new "pageNum" parameter has been added.
[Nov 22,2024] Websocket connection limit update
Connection instructions:
Connection limit: 300 connection requests/IP/5min, Max 100 connections/IP
Subscription limit: 240 subscription requests/Hour/connection, Max 1000 channel subscription/connection
If there’s a network problem, the system will automatically disconnect the connection.
To keep the connection stable:
- Websocket will be forcibly disconnected every 24 hours, please add the reconnection mechanism in your code
- Users set a 30 seconds timer to a send string "ping", and expect a string "pong" as response. If no string "pong" received, please reconnect
- Websocket server will disconnect the connection if there is no string "ping" received for 2 min
- The Websocket server accepts up to 10 messages per second. The message includes:
- String "ping"
- JSON message, such as subscribe, unsubscribe.
- If the user sends more messages than the limit, the connection will be disconnected. The IP which is repeatedly disconnected may be blocked by the server
- We highly recommend you to subscribe less than 50 channels in one connection. The connections with less channel subscriptions will be more stable.
[Oct 17,2024] The update on calculation method for the change24h
field in the Futrues and SPOT ticker interfaces
Endpoints:
- /api/v2/spot/market/tickers, SPOT Get Ticker Information
- /api/v2/mix/market/ticker, Futures Get Single Ticker
- /api/v2/mix/market/tickers, Futures Get All Tickers
Change:
The calculation of the change24h
field in the API response will change from the price fluctuation from 00:00 in the UTC+8 time zone to the current time, to the price fluctuation over the past 24 hours from the current time.
[Sep 24,2024] The APIs for USDT-M Futures Multi-assets Mode requirements have been launched.
Endpoints: APIs for USDT-M Futures Multi-assets Mode
[Aug 28,2024] Get Merchant Advertisement List endpoint Adjust the maximum value of the 'limit' parameter to 20
Endpoints: Get Merchant Advertisement List Change: Adjust the maximum value of the 'limit' parameter to 20
[Aug 15,2024] API rate limit adjustment
Endpoints | Old rate limit | New rate limit |
---|---|---|
/api/v2/copy/mix-trader/order-close-positions | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-trader/order-current-track | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-follower/query-current-orders | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-follower/query-history-orders | 20 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-trader/order-history-track | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-trader/profits-group-coin-date | 20 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-trader/profit-history-summarys | 20 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-trader/profit-history-details | 20 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-trader/profit-details | 20 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-trader/order-modify-tpsl | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-trader/order-total-detail | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-broker/query-traders | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-follower/settings | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-follower/close-positions | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-follower/setting-tpsl | 20 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-follower/query-settings | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-follower/cancel-trader | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-trader/config-settings-base | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-follower/query-traders | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-trader/config-query-followers | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-trader/config-remove-follower | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-trader/config-query-symbols | 20 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-trader/config-setting-symbols | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/mix-broker/query-history-traces | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/spot/trade/batch-cancel-plan-order | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/spot/account/deduct-info | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/spot-follower/query-current-orders | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/spot-follower/query-settings | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/spot-follower/query-history-orders | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/spot-follower/query-traders | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/spot-trader/config-query-settings | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/spot-trader/order-history-track | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/spot-trader/profit-summarys | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/spot-trader/profit-history-details | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/spot-trader/profit-details | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/copy/spot-trader/order-total-detail | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/user/virtual-subaccount-apikey-list | 10 req/sec/UID | 5 req/sec/UID |
/api/v2/broker/account/subaccount-withdrawal | 10 req/sec/UID | 1 req/sec/UID |
/api/v2/spot/account/switch-deduct | 10 req/sec/UID | 1 req/sec/UID |
/api/v2/copy/spot-follower/order-close-tracking | 10 req/sec/UID | 1 req/sec/UID |
/api/v2/copy/spot-follower/cancel-trader | 10 req/sec/UID | 1 req/sec/UID |
/api/v2/copy/spot-follower/stop-order | 10 req/sec/UID | 1 req/sec/UID |
/api/v2/copy/spot-follower/settings | 10 req/sec/UID | 1 req/sec/UID |
/api/v2/copy/spot-follower/setting-tpsl | 10 req/sec/UID | 1 req/sec/UID |
/api/v2/copy/spot-trader/order-close-tracking | 10 req/sec/UID | 1 req/sec/UID |
/api/v2/copy/spot-trader/config-setting-symbols | 10 req/sec/UID | 1 req/sec/UID |
/api/v2/copy/spot-trader/config-remove-follower | 10 req/sec/UID | 1 req/sec/UID |
/api/v2/copy/spot-trader/order-modify-tpsl | 10 req/sec/UID | 1 req/sec/UID |
[Jul 03,2024] Withdrawal and get deposit addresses supports Bitcoin Lightning Network
Endpoints: Withdraw, Get Deposit Address, Get SubAccount Deposit Address Change: Get the deposit address to support obtaining the Bitcoin Lightning Network invoice address, and the withdrawal endpoint supports withdrawal from the Bitcoin Lightning Network invoice address
[Jun 25,2024] Adjustment on Get P2P Merchant List Interface
Parameter merchantId
has been removed from Get P2P Merchant List Interface
[Mar 15,2024] Adjustment on the time range for Get History Trigger Order
Endpoint: Get History Trigger Order
- The interval between
startTime
andendTime
has been limited to 90 days - Only historical records within the past 90 days are supported.
[Feb 6,2023] Add newSize
field in the push parameters of Spot Order Channel for Websocket
The spot order channel push now includes a new parameter newSize
, which will gradually replace the existing parameter size
in subsequent updates.
newSize
represents the order quantity, following the specified rules:
- when
orderType=limit
,newSize
represents the quantity of base coin, - when
orderType=market
andside=buy
,newSize
represents the quantity of quote coin, - when
orderType=market
andside=sell
,newSize
represents the quantity of base coin.
[Jan 19,2024] Adjustment on the time range for tax endpoints per request
Endpoints: Spot Transaction Records, Futures Transaction Records, Margin Transaction Records, P2P Transaction Records
Change: The interval between startTime
and endTime
has been adjusted from one year to 30 days
[Dec 27,2023] Adjustment for the withdrawal of Broker's sub-account
The request param dest
no longer supports the input internal_transfer
.
The request param toType
has been removed.
[Nov 16,2023] Add 'errorCode' field in batch-cancel-orders response
Added a new response parameter, errorCode, to the batch cancel order endpoint.