# Table of Contents - [Bitget API Introduction | Bitget API](#bitget-api-introduction-bitget-api) - [Futures Trading API | Bitget API](#futures-trading-api-bitget-api) - [Spot Trading API | Bitget API](#spot-trading-api-bitget-api) - [Broker Trading API | Bitget API](#broker-trading-api-bitget-api) - [Copy Trading API | Bitget API](#copy-trading-api-bitget-api) - [Margin Trading API | Bitget API](#margin-trading-api-bitget-api) - [Affiliate Introduction | Bitget API](#affiliate-introduction-bitget-api) - [Inst Loan | Bitget API](#inst-loan-bitget-api) - [Earn API | Bitget API](#earn-api-bitget-api) - [Quick Start | Bitget API](#quick-start-bitget-api) - [Query Announcements | Bitget API](#query-announcements-bitget-api) - [简介 | Bitget API](#-bitget-api) - [API Domain | Bitget API](#api-domain-bitget-api) - [V2 API Update Guide | Bitget API](#v2-api-update-guide-bitget-api) - [SDK | Bitget API](#sdk-bitget-api) - [Changelog | Bitget API](#changelog-bitget-api) - [Signature | Bitget API](#signature-bitget-api) - [Websocket API | Bitget API](#websocket-api-bitget-api) - [Unified Trading Account | Bitget API](#unified-trading-account-bitget-api) - [FAQ | Bitget API](#faq-bitget-api) - [合约交易API | Bitget API](#-api-bitget-api) - [VIP Fee Rate | Bitget API](#vip-fee-rate-bitget-api) - [Get Coin Info | Bitget API](#get-coin-info-bitget-api) - [现货交易API | Bitget API](#-api-bitget-api) --- # Bitget API Introduction | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/common/intro#__docusaurus_skipToContent_fallback) On this page Bitget API Introduction ======================= API Introduction[​](https://www.bitgetapp.com/api-doc/common/intro#api-introduction "Direct link to API Introduction") ----------------------------------------------------------------------------------------------------------------------- Welcome to Bitget Developer document! This document is the only official document of Bitget API. We will constantly update the functionalities of Bitget API here. Please pay attention to it regularly. You can switch to access different APIs business line by clicking the upper menu, and you can switch the document language by clicking the language button on the upper right. On the right side of the document usually displays example of request parameters and response results. Updates[​](https://www.bitgetapp.com/api-doc/common/intro#updates "Direct link to Updates") -------------------------------------------------------------------------------------------- Regarding API additions, updates, and offline information, Bitget will issue announcements in advance to notify you. It is recommended that you follow and subscribe to our announcements to obtain relevant information in time. You can click [Latest News](javascript:;) to subscribe to announcements. Further more, an API to get notification could be found [here](https://www.bitgetapp.com/api-doc/common/notice/Get-All-Notices) Contact Us[​](https://www.bitgetapp.com/api-doc/common/intro#contact-us "Direct link to Contact Us") ----------------------------------------------------------------------------------------------------- If you have any questions or suggestions, you can contact us by: * Telegram [Join](https://t.me/bitgetOpenapi) ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback * [API Introduction](https://www.bitgetapp.com/api-doc/common/intro#api-introduction) * [Updates](https://www.bitgetapp.com/api-doc/common/intro#updates) * [Contact Us](https://www.bitgetapp.com/api-doc/common/intro#contact-us) --- # Futures Trading API | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/contract/intro#__docusaurus_skipToContent_fallback) Futures Trading API =================== This section introduces the API documentation for Futures trading. For more details, please refer to the menu on the left. Please note that there are 3 product types under Futures trading for RestAPI and Websocket | Product Type | Desc | | --- | --- | | USDT-FUTURES | USDT-M Futures, Futures settled in USDT | | USDC-FUTURES | USDC-M Futures, Futures settled in USDC | | COIN-FUTURES | Coin-M Futures, Futures settled in cryptocurrencies | ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback --- # Spot Trading API | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/spot/intro#__docusaurus_skipToContent_fallback) On this page Spot Trading API ================ This section introduces the API documentation for spot trading. For more details, please refer to the menu on the left. Updates[​](https://www.bitgetapp.com/api-doc/spot/intro#updates "Direct link to Updates") ------------------------------------------------------------------------------------------ Bitget will announce information about API updates and deprecations in advance. We recommend that you follow and subscribe to our announcements to stay informed and receive updates promptly You can click [Latest News](javascript:;) to subscribe to announcements. Further more, an API to get notification could be found [here](https://www.bitgetapp.com/api-doc/common/notice/Get-All-Notices) Contact Us[​](https://www.bitgetapp.com/api-doc/spot/intro#contact-us "Direct link to Contact Us") --------------------------------------------------------------------------------------------------- If you have any questions or suggestions, you can contact us by the following approaches: * [Telegram](https://t.me/bitgetOpenapi) ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback * [Updates](https://www.bitgetapp.com/api-doc/spot/intro#updates) * [Contact Us](https://www.bitgetapp.com/api-doc/spot/intro#contact-us) --- # Broker Trading API | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/broker/intro#__docusaurus_skipToContent_fallback) On this page Broker Trading API ================== Stay Updated[​](https://www.bitgetapp.com/api-doc/broker/intro#stay-updated "Direct link to Stay Updated") ----------------------------------------------------------------------------------------------------------- For information regarding API additions, updates, or deprecations, Bitget will issue announcements in advance. We recommend you follow and subscribe to our announcements to receive timely updates. You can click [Latest News](javascript:;) to subscribe to announcements. Contact Us[​](https://www.bitgetapp.com/api-doc/broker/intro#contact-us "Direct link to Contact Us") ----------------------------------------------------------------------------------------------------- If you have any questions or suggestions, you can contact us here: * Telegram [Join](https://t.me/bitgetOpenapi) Quick Start =========== Access Preparation[​](https://www.bitgetapp.com/api-doc/broker/intro#access-preparation "Direct link to Access Preparation") ----------------------------------------------------------------------------------------------------------------------------- This document is intended to clarify the API usage for ND-brokers(non-disclosed broker) . If you have certain R&D and operation capabilities, and want to build a trading platform and manage your user independently, the independent broker service Yes is the best choice. You are responsible for front-end development and user operations, while Bitget provides you with back-end technology and market liquidity to empower your transaction value-added services. * Brokers could create APIKey at [API Keys Management](javascript:;) after login, make sure to set an IP whitelist while creating the APIKey * Brokers can create their own sub-accounts through this API, control permissions, create sub-account APIKeys, and place orders through sub-account APIKey. ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback * [Stay Updated](https://www.bitgetapp.com/api-doc/broker/intro#stay-updated) * [Contact Us](https://www.bitgetapp.com/api-doc/broker/intro#contact-us) * [Access Preparation](https://www.bitgetapp.com/api-doc/broker/intro#access-preparation) --- # Copy Trading API | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/copytrading/intro#__docusaurus_skipToContent_fallback) Copy Trading API ================ Updates[​](https://www.bitgetapp.com/api-doc/copytrading/intro#updates "Direct link to Updates") ------------------------------------------------------------------------------------------------- Regarding API additions, updates, and offline information, Bitget will issue announcements in advance to notify you. It is recommended that you follow and subscribe to our announcements to obtain relevant information in time. You can click [Latest News](javascript:;) to subscribe to announcements. Further more, an API to get notification could be found [here](https://www.bitgetapp.com/api-doc/common/notice/Get-All-Notices) Contact Us[​](https://www.bitgetapp.com/api-doc/copytrading/intro#contact-us "Direct link to Contact Us") ---------------------------------------------------------------------------------------------------------- If you have any questions or suggestions, you can contact us by: * Telegram [Join](https://t.me/bitgetOpenapi) ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback --- # Margin Trading API | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/margin/intro#__docusaurus_skipToContent_fallback) On this page Margin Trading API ================== This Page is about Spot-Margin API Updates[​](https://www.bitgetapp.com/api-doc/margin/intro#updates "Direct link to Updates") -------------------------------------------------------------------------------------------- Regarding API additions, updates, and offline information, Bitget will issue announcements in advance to notify you. It is recommended that you follow and subscribe to our announcements to obtain relevant information in time. You can click [Latest News](javascript:;) to subscribe to announcements. Further more, an API to get notification could be found [here](https://www.bitgetapp.com/api-doc/common/notice/Get-All-Notices) Contact Us[​](https://www.bitgetapp.com/api-doc/margin/intro#contact-us "Direct link to Contact Us") ----------------------------------------------------------------------------------------------------- If you have any questions or suggestions, you can contact us by: * Telegram [Join](https://t.me/bitgetOpenapi) ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback * [Updates](https://www.bitgetapp.com/api-doc/margin/intro#updates) * [Contact Us](https://www.bitgetapp.com/api-doc/margin/intro#contact-us) --- # Affiliate Introduction | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/affiliate/intro#__docusaurus_skipToContent_fallback) On this page Affiliate Introduction ====================== This section introduces the APIs related to agents, including the following functions: * Get Agent's Direct Customer Registration List * Get Agent's Direct Customer Recharge List * Get Agent's Direct Customer Trading Volume List * Get Agent's Direct Customer Balance * Get Agent's Direct Customer Commission Details * Get Agent's Commission Payment Details (Including Subordinate/Partner Commissions) Please contact your BD or RM to apply for access permissions to the above APIs. Updates[​](https://www.bitgetapp.com/api-doc/affiliate/intro#updates "Direct link to Updates") ----------------------------------------------------------------------------------------------- Regarding API additions, updates, and offline information, Bitget will issue announcements in advance to notify you. It is recommended that you follow and subscribe to our announcements to obtain relevant information in time. You can click [Latest News](javascript:;) to subscribe to announcements. Further more, an API to get notification could be found [here](https://www.bitgetapp.com/api-doc/common/notice/Get-All-Notices) Contact Us[​](https://www.bitgetapp.com/api-doc/affiliate/intro#contact-us "Direct link to Contact Us") -------------------------------------------------------------------------------------------------------- If you have any questions or suggestions, you can contact us by: * Telegram [Join](https://t.me/bitgetOpenapi) ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback * [Updates](https://www.bitgetapp.com/api-doc/affiliate/intro#updates) * [Contact Us](https://www.bitgetapp.com/api-doc/affiliate/intro#contact-us) --- # Inst Loan | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/instloan/intro#__docusaurus_skipToContent_fallback) Inst Loan ========= This section introduces APIs related to institutional loan. For details, please refer to the function menu on the left. Updates[​](https://www.bitgetapp.com/api-doc/instloan/intro#updates "Direct link to Updates") ---------------------------------------------------------------------------------------------- Regarding API additions, updates, and offline information, Bitget will issue announcements in advance to notify you. It is recommended that you follow and subscribe to our announcements to obtain relevant information in time. You can click [Latest News](javascript:;) to subscribe to announcements. Further more, an API to get notification could be found [here](https://www.bitgetapp.com/api-doc/common/notice/Get-All-Notices) Contact Us[​](https://www.bitgetapp.com/api-doc/instloan/intro#contact-us "Direct link to Contact Us") ------------------------------------------------------------------------------------------------------- If you have any questions or suggestions, you can contact us by: * Telegram [Join](https://t.me/bitgetOpenapi) ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback --- # Earn API | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/earn/intro#__docusaurus_skipToContent_fallback) On this page Earn API ======== This page includes APIs about 'Earn', including below features: * Savings * SharkFin * Loan Updates[​](https://www.bitgetapp.com/api-doc/earn/intro#updates "Direct link to Updates") ------------------------------------------------------------------------------------------ Regarding API additions, updates, and offline information, Bitget will issue announcements in advance to notify you. It is recommended that you follow and subscribe to our announcements to obtain relevant information in time. You can click [Latest News](javascript:;) to subscribe to announcements. Further more, an API to get notification could be found [here](https://www.bitgetapp.com/api-doc/common/notice/Get-All-Notices) Contact Us[​](https://www.bitgetapp.com/api-doc/earn/intro#contact-us "Direct link to Contact Us") --------------------------------------------------------------------------------------------------- If you have any questions or suggestions, you can contact us by: * Telegram [Join](https://t.me/bitgetOpenapi) ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback * [Updates](https://www.bitgetapp.com/api-doc/earn/intro#updates) * [Contact Us](https://www.bitgetapp.com/api-doc/earn/intro#contact-us) --- # Quick Start | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/common/quick-start#__docusaurus_skipToContent_fallback) Quick Start =========== Access Preparation[​](https://www.bitgetapp.com/api-doc/common/quick-start#access-preparation "Direct link to Access Preparation") ----------------------------------------------------------------------------------------------------------------------------------- If you need to use the API, please log in to the [web page](javascript:;) , then apply the API key application and complete the permission configuration, and then develop and trade according to the details of this document. You can click [API Key Management](javascript:;) to create an API Key after login. Each UID can create 10 Api Keys, and each Api Key can set permissions as read only or read/write. The permissions are described as follows: * Read-Only permission: Read permission authorized to query data, such as market data. * Trade permission: Transaction permission authorized to call the interface of placing and cancelling orders. * Transfer permission: With this permission it authorized to transfer coins between accounts. * Withdraw permission: Authorized to withdraw assets from Bitget account, `noted that you can only withdraw coins through an whitelisted IP address.` After successfully created the API key, please remember the following information: * `APIKey` The identity of API transactions, generated by a random algorithm. * `SecretKey` The private key is randomly generated by the system and used for [Signature](https://www.bitgetapp.com/api-doc/common/signature) generation. * `Passphrase` The password is set by the user. It should be noted that if you forgot the Passphrase, it cannot be retrieved back, and the APIKey needs to be recreated. Interface Type[​](https://www.bitgetapp.com/api-doc/common/quick-start#interface-type "Direct link to Interface Type") ----------------------------------------------------------------------------------------------------------------------- Interfaces are mainly divided into two types: * Public Interface * Private Interface **Public Interface** The public interface can be used to obtain configuration information and market data. Public requests can be used without authentication. **Private Interface** The private interface can be used for order management and account management. Every private request must be [Signed](https://www.bitgetapp.com/api-doc/common/signature) . The private interface will be verified from server side with your API Key info. Access Restriction[​](https://www.bitgetapp.com/api-doc/common/quick-start#access-restriction "Direct link to Access Restriction") ----------------------------------------------------------------------------------------------------------------------------------- This chapter mainly focuses on access restrictions: * Rest API will return 429 status when the access exceeds the frequency limit: the request is too frequent. **Rest API** The rate limit of interfaces is based on UID or IP. You can get detailed information from the separated API document page. Frequency limit rules: 1. The rate limit of each API endpoint is marked on the doc page; 2. The rate limit of each API interface is calculated independently; 3. The overall rate limit is 6000/IP/Min ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback --- # Query Announcements | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/common/notice/Get-All-Notices#__docusaurus_skipToContent_fallback) Query Announcements =================== Frequency limit: 20 times/1s (IP) ### Description[​](https://www.bitgetapp.com/api-doc/common/notice/Get-All-Notices#description "Direct link to Description") Search for announcements within one month Description of the announcement sub-type： The announcement sub-type matches the announcement type. * annType=`latest_news` * `announcements` Latest announcement * `news` Bitget news * annType=`coin_listings` * `spot` * `futures` * `margin` * `copy_trading` * annType=`product_updates` * `spot` * `futures` * `margin` * `copy_trading` * annType=`security` * `security_information` * annType=`api_trading` * `api_announcement` * annType=`symbol_delisting` * `trading_pair_delisting` * annType=`maintenance_system_updates` * `asset_maintenance` * `system_updates` * `spot_maintenance` * `futures_maintenance` ### HTTP Request[​](https://www.bitgetapp.com/api-doc/common/notice/Get-All-Notices#http-request "Direct link to HTTP Request") * GET /api/v2/public/annoucements Request Example curl "https://api.bitget.com/api/v2/public/annoucements?language=zh_CN" ### Request Parameters[​](https://www.bitgetapp.com/api-doc/common/notice/Get-All-Notices#request-parameters "Direct link to Request Parameters") | Parameter | Type | Required | Description | | --- | --- | --- | --- | | annType | String | No | Announcement type
`latest_news`: Latest events
`coin_listings`: New coin listings
`product_updates`: Product update
`security`: Security
`api_trading`: Api trading
`maintenance_system_updates`: maintenance/system upgrades
`symbol_delisting`: Delisting information | | startTime | String | No | Start time of the query, Unix millisecond timestamp, e.g. 1690196141868
Search by announcement time | | endTime | String | No | End time of the query, Unix millisecond timestamp, e.g. 1690196141868
Search by announcement time | | cursor | String | No | Cursor ID
It is not required for the first call. For subsequent calls, pass the last annId in the previous response. | | limit | String | No | Number of entries per page
By default, it is 10 entries, and the maximum is 10 entries. | | language | String | Yes | language type
zh\_CN: Chinese
en\_US: English
Returns English if the language chosen is not supported | Response Example { "code": "00000", "msg": "success", "requestTime": 1688008631614, "data": [ { "annId": "1", "annTitle": "test0629", "annDesc": "Latest announcement", "cTime": "1688008040000", "language": "zh_CN", "annUrl": "https://www.bitget.com/zh_CN/support/articles/23685" } ]} ### Response Parameters[​](https://www.bitgetapp.com/api-doc/common/notice/Get-All-Notices#response-parameters "Direct link to Response Parameters") | Parameter | Type | Description | | --- | --- | --- | | annId | String | Announcement ID | | annTitle | String | Announcement title | | annDesc | String | Announcement description (This field is deprecated) | | cTime | String | Announcement creation time, Unix millisecond timestamp format | | language | String | language type | | annUrl | String | Announcement URL | | annType | String | Announcement type
`latest_news`: Latest events
`coin_listings`: New coin listings
`product_updates`: Product update
`security`: Security
`api_trading`: Api trading
`maintenance_system_updates`: maintenance/system upgrades
`symbol_delisting`: Delisting information | | annSubType | String | Announcement sub-type | | cTime | String | Announcement release time
In the format of Unix timestamp in milliseconds | ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback --- # 简介 | Bitget API [跳到主要内容](https://www.bitgetapp.com/zh-CN/api-doc/common/intro#__docusaurus_skipToContent_fallback) 本页总览 简介 == Bitget API 简介[​](https://www.bitgetapp.com/zh-CN/api-doc/common/intro#bitget-api-%E7%AE%80%E4%BB%8B "Bitget API 简介的直接链接") -------------------------------------------------------------------------------------------------------------------------- 欢迎使用Bitget开发者文档！ 此文档是Bitget API的唯一官方文档，Bitget API提供的能力会在此持续更新，请大家及时关注。 你可以通过点击上方菜单来切换获取不同业务的API，还可通过点击右上方的语言按钮来切换文档语言。 文档右侧是针对请求参数以及响应结果的示例。 更新关注[​](https://www.bitgetapp.com/zh-CN/api-doc/common/intro#%E6%9B%B4%E6%96%B0%E5%85%B3%E6%B3%A8 "更新关注的直接链接") --------------------------------------------------------------------------------------------------------------- 关于API新增、更新、下线等信息Bitget会提前发布公告进行通知，建议您关注和订阅我们的公告，及时获取相关信息。 您可以点击 [最新公告](javascript:;) 订阅公告。 此外，此处也提供了API获取 [通知](https://www.bitgetapp.com/zh-CN/api-doc/common/notice/Get-All-Notices) 。 联系我们[​](https://www.bitgetapp.com/zh-CN/api-doc/common/intro#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC "联系我们的直接链接") --------------------------------------------------------------------------------------------------------------- 使用过程中如有问题或者建议，您可选择以下方式联系我们： * Telegram [点击加入](https://t.me/bitgetOpenapi) ### 您的阅读体验如何？ ★ ★ ★ ★ ★ 反馈建议 * [Bitget API 简介](https://www.bitgetapp.com/zh-CN/api-doc/common/intro#bitget-api-%E7%AE%80%E4%BB%8B) * [更新关注](https://www.bitgetapp.com/zh-CN/api-doc/common/intro#%E6%9B%B4%E6%96%B0%E5%85%B3%E6%B3%A8) * [联系我们](https://www.bitgetapp.com/zh-CN/api-doc/common/intro#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC) --- # API Domain | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/common/domain#__docusaurus_skipToContent_fallback) API Domain ========== You can use different domain as below Rest API. | Domain Name | API | Description | | --- | --- | --- | | REST Domain 1 | [https://api.bitget.com](https://api.bitget.com/) | Main Domain | | websocket Domain | wss://ws.bitget.com/v2/ws/public | Main Domain, Public channel | | websocket Domain | wss://ws.bitget.com/v2/ws/private | Main Domain, Private channel | ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback --- # V2 API Update Guide | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/common/release-note#__docusaurus_skipToContent_fallback) On this page V2 API Update Guide =================== Scope of changes[​](https://www.bitgetapp.com/api-doc/common/release-note#scope-of-changes "Direct link to Scope of changes") ------------------------------------------------------------------------------------------------------------------------------ ### Interface aggregation[​](https://www.bitgetapp.com/api-doc/common/release-note#interface-aggregation "Direct link to Interface aggregation") In V1, interface changes involving modifications to input parameters are typically addressed by introducing new interfaces, ensuring minimal impact on online users. Therefore, in V2, we have optimized shortcomings such as interface redundancy and confusion in business scenarios. For detailed information on interface aggregation across all business lines, please refer to the V1 and V2 Interface Mapping Tables. ### Global symbol request rule changes[​](https://www.bitgetapp.com/api-doc/common/release-note#global-symbol-request-rule-changes "Direct link to Global symbol request rule changes") In V2, we reduced them to one parameter—**symbol**—corresponding to symbolName in V1. Additionally, business line notes such as SPBL and UMBCL were removed when passing the symbol value. ### Optimization of global query rules[​](https://www.bitgetapp.com/api-doc/common/release-note#optimization-of-global-query-rules "Direct link to Optimization of global query rules") In terms of data retrieval for query interfaces, we have abandoned the pagination method of pageSize and pageNo used in V1. In V2, we replaced it with cursor-based pagination with idLessThan and limit. Based on real-life business scenarios, a time range data query was added to most query interfaces. In addition, user ID can be used as the request parameter in precise query scenarios with some trade record, trade execution, and order-related interfaces. The basic rules and scenarios for id, startTime, endTime, idLessThan, and limit are described as follows: Basic rule: When querying data, the verification order for returned results is id > startTime + endTime > idLessThan. In other words, it first prioritizes precise queries using the id, then narrows down the data range with startTime and endTime, and finally uses the cursor idLessThan to retrieve a specified number of data entries based on the limit. ### Standardization of naming rules for business line interfaces and parameters[​](https://www.bitgetapp.com/api-doc/common/release-note#standardization-of-naming-rules-for-business-line-interfaces-and-parameters "Direct link to Standardization of naming rules for business line interfaces and parameters") In V1, there was a lack of consistency in parameters between business lines. Therefore, in V2, we have standardized the naming and format of parameters with the same meaning for scenarios spanning different business lines (spot, futures, leverage) and interface types (Rest/WebSocket). ### Clearer catalog categorization[​](https://www.bitgetapp.com/api-doc/common/release-note#clearer-catalog-categorization "Direct link to Clearer catalog categorization") In V1, the categorization of interface catalogs was too vague, resulting in an excessive number of interfaces in some catalogs. This, in turn, led to difficulties in documentation query and poor user experience. In V2, we have adjusted the categorization and naming of the interface catalogs, making them more detailed, intuitive, thus avoiding readability and retrieval issues. ### Accessibility of more in-depth information[​](https://www.bitgetapp.com/api-doc/common/release-note#accessibility-of-more-in-depth-information "Direct link to Accessibility of more in-depth information") For futures and spot trading pairs, we significantly increased the trading pair depth that can be accessed through the interfaces and standardized the tiers across different business lines. | Business Line | Version | Tier | | --- | --- | --- | | Spot | V1 | 150/200 | | Spot | V2 | 1/5/15/50/max; default: 100. The max is determined by the highest tier available for the designated trading pair. | | Future | V1 | 5/15/50/100 | | Future | V2 | 1/5/15/50/max; default: 100.The max is determined by the highest tier available for the designated trading pair. | ### Merge of futures trigger order and trailing stop-loss[​](https://www.bitgetapp.com/api-doc/common/release-note#merge-of-futures-trigger-order-and-trailing-stop-loss "Direct link to Merge of futures trigger order and trailing stop-loss") In V2, we combined the trigger order and the trailing stop-loss into one, using the field planType to differentiate the order type. The order placing conditions of the two are different. Different from the normal trigger order, the trailing stop-loss requires attention to the field callbackRatio, which is used to set the order-triggering percentage. stopSurplusTriggerPrice and stopLossTriggerPrice also require special attention as these two fields are used to determine the trail variance percentage that triggers the trailing stop-loss and take-profit orders. ### Position opening/closing in futures order placement[​](https://www.bitgetapp.com/api-doc/common/release-note#position-openingclosing-in-futures-order-placement "Direct link to Position opening/closing in futures order placement") In V2, we improved operations on positions in both one-way and hedging modes. When placing an order, the field side and tradeSide are combined for parameter entry based on the position mode and direction. Enumeration values of **side** and **tradeSide**: | Field name | Enumeration value | Description | | --- | --- | --- | | side | buy | Buying | | side | sell | selling | | tradeSide | open | Opening a position | | tradeSide | close | Closing a position | Operation rules of parameter entries in one-way or hedging modes: | Position mode | Parameter entries | Operation | Description | | --- | --- | --- | --- | | One-way mode | side: buy | Buying | In one-way mode, only one side is needed to indicate whether it is a buying or selling order | | One-way mode | side: sell | Selling | In one-way mode, only one side is needed to indicate whether it is a buying or selling order | | Hedging mode | side: buy; tradeSide: open | Opening a long position | In hedging mode, both side and tradeSide are needed to determine whether it is opening long/short or closing long/short | | Hedging mode | side: sell; tradeSide: open | Opening a short position | In hedging mode, both side and tradeSide are needed to determine whether it is opening long/short or closing long/short | | Hedging mode | side: buy; tradeSide: close | Closing a long position | In hedging mode, both side and tradeSide are needed to determine whether it is opening long/short or closing long/short | | Hedging mode | side: sell; tradeSide: close | Closing a short position | In hedging mode, both side and tradeSide are needed to determine whether it is opening long/short or closing long/short | ### Optimization of delivery futures[​](https://www.bitgetapp.com/api-doc/common/release-note#optimization-of-delivery-futures "Direct link to Optimization of delivery futures") In V2, we updated the naming rules for symbol in Coin-M delivery futures. For Coin-M delivery futures, the format of symbol is trading pair + month code + year. Examples and descriptions: | Symbol | Descriptions | | --- | --- | | BTCUSD**H**23 | H means March (Q1) and 23 means the year 2023 | | BTCUSD**M**23 | M means June (Q2) and 23 means the year 2023 | | BTCUSD**U**23 | U means September (Q3) and 23 means the year 2023 | | BTCUSD**Z**23 | Z means December (Q4) and 23 means the year 2023 | The bolded letters H, M, U, and Z are some of the month codes. Month codes: | Month code | Month | Month code | Month | | --- | --- | --- | --- | | F | January | N | July | | G | February | Q | August | | `H` | March | `U` | September | | J | April | V | October | | K | May | X | November | | `M` | June | `Z` | December | ### Optimized maximum/minimum order size logic of trading pairs[​](https://www.bitgetapp.com/api-doc/common/release-note#optimized-maximumminimum-order-size-logic-of-trading-pairs "Direct link to Optimized maximum/minimum order size logic of trading pairs") In V2, we have included parameter descriptions for maximum and minimum order sizes in interfaces that access spot and futures trading pairs. This enhancement enables users to access essential information about trading pairs, including minimum and maximum trading volumes, the maximum number of open orders (considering both trading pairs and products), price precision, amount precision, and other basic information. ### Earn interfaces coming soon[​](https://www.bitgetapp.com/api-doc/common/release-note#earn-interfaces-coming-soon "Direct link to Earn interfaces coming soon") To meet users' demand for crypto Earn products, we are about to launch interfaces for Savings and Shark Fin, covering features such as information retrieval, PnL statistics, asset analysis, subscription, and redemption. Both fixed and flexible Savings are supported, enhancing our digital asset management service. ### Crypto Loan interfaces coming soon[​](https://www.bitgetapp.com/api-doc/common/release-note#crypto-loan-interfaces-coming-soon "Direct link to Crypto Loan interfaces coming soon") Catering to the needs of investors seeking more conservative or flexible approaches to grow their wealth, we are about to launch interfaces for Crypto Loan. For users with lower risk tolerance who seek conservative and flexible borrowing solutions, we introduced the interface for Crypto Loan. Crypto Loan is a financial product that allows users to borrow fiat currency or cryptocurrencies by using their crypto assets as collateral. The Bitget Crypto Loan API aims to help users get additional funds instantly without losing control over their own crypto assets.The whole process includes staking the collateral, obtaining the loan, adding to/withdrawing from the collateral, undergoing liquidation, paying interest, repaying the loan, and redeeming the collateral. It should be noted that, due to the nature of the digital currency market, the crypto market is considerably more volatile than the traditional market. As a result, future fluctuations in coin prices will impact the overall return. Interface Mapping Tables[​](https://www.bitgetapp.com/api-doc/common/release-note#interface-mapping-tables "Direct link to Interface Mapping Tables") ------------------------------------------------------------------------------------------------------------------------------------------------------ ### Spot[​](https://www.bitgetapp.com/api-doc/common/release-note#spot "Direct link to Spot") | V1 Endpoint | V2 Endpoint | | --- | --- | | \- GET /api/spot/v1/notice/queryAllNotices | \- GET /api/v2/public/annoucements | | \- GET /api/spot/v1/public/time | \- GET /api/v2/public/time | | \- GET /api/spot/v1/public/currencies | \- GET /api/v2/spot/public/coins | | \- GET /api/spot/v1/public/products | \- GET /api/v2/spot/public/symbols | | \- GET /api/spot/v1/public/product | \- GET /api/v2/spot/public/symbols | | \- GET /api/spot/v1/market/ticker | \- GET /api/v2/spot/market/tickers | | \- GET /api/spot/v1/market/tickers | \- GET /api/v2/spot/market/tickers | | \- GET /api/spot/v1/market/fills-history | \- GET /api/v2/spot/market/fills-history | | \- GET /api/spot/v1/market/fills | \- GET /api/v2/spot/market/fills | | \- GET /api/spot/v1/market/candles | \- GET /api/v2/spot/market/candles | | \- GET /api/spot/v1/market/history-candles | \- GET /api/v2/spot/market/history-candles | | \- GET /api/spot/v1/market/depth | \- GET /api/v2/spot/market/orderbook | | \- GET /api/spot/v1/market/merge-depth | \- GET /api/v2/spot/market/orderbook | | \- GET /api/spot/v1/market/spot-vip-level | \- GET /api/v2/spot/market/vip-fee-rate | | \- POST /api/spot/v1/wallet/transfer | \- POST /api/v2/spot/wallet/transfer | | \- POST /api/spot/v1/wallet/transfer-v2 | \- POST /api/v2/spot/wallet/transfer | | \- POST /api/spot/v1/wallet/subTransfer | \- POST /api/v2/spot/wallet/subaccount-transfer | | \- POST /api/spot/v1/wallet/withdrawal | \- POST /api/v2/spot/wallet/withdrawal | | \- POST /api/spot/v1/wallet/withdrawal-v2 | \- POST /api/v2/spot/wallet/withdrawal | | \- POST /api/spot/v1/wallet/withdrawal-inner | \- POST /api/v2/spot/wallet/withdrawal | | \- POST /api/spot/v1/wallet/withdrawal-inner-v2 | \- POST /api/v2/spot/wallet/withdrawal | | \- GET /api/spot/v1/wallet/deposit-address | \- GET /api/v2/spot/wallet/deposit-address | | \- GET /api/spot/v1/wallet/deposit-list | \- GET /api/v2/spot/wallet/deposit-records | | \- GET /api/spot/v1/wallet/withdrawal-list | \- GET /api/v2/spot/wallet/withdrawal-records | | \- GET /api/user/v1/fee/query | \- GET /api/v2/public/trade-rate | | \- GET /api/spot/v1/account/getInfo | \- GET /api/v2/spot/account/info | | \- GET /api/spot/v1/account/assets | \- GET /api/v2/spot/account/assets | | \- GET /api/spot/v1/account/assets-lite | \- GET /api/v2/spot/account/assets | | \- POST /api/spot/v1/account/sub-account-spot-assets | \- GET /api/v2/spot/account/subaccount-assets | | \- POST /api/spot/v1/account/bills | \- GET /api/v2/spot/account/bills | | \- GET /api/spot/v1/account/transferRecords | \- GET /api/v2/spot/account/transferRecords | | \- POST /api/spot/v1/trade/orders | \- POST /api/v2/spot/trade/place-order | | \- POST /api/spot/v1/trade/batch-orders | \- POST /api/v2/spot/trade/batch-orders | | \- POST /api/spot/v1/trade/cancel-order | \- POST /api/v2/spot/trade/cancel-order | | \- POST /api/spot/v1/trade/cancel-order-v2 | \- POST /api/v2/spot/trade/cancel-order | | \- POST /api/spot/v1/trade/cancel-symbol-order | \- POST /api/v2/spot/trade/cancel-symbol-order | | \- POST /api/spot/v1/trade/cancel-batch-orders | \- POST /api/v2/spot/trade/batch-cancel-order | | \- POST /api/spot/v1/trade/cancel-batch-orders-v2 | \- POST /api/v2/spot/trade/batch-cancel-order | | \- POST /api/spot/v1/trade/orderInfo | \- GET /api/v2/spot/trade/orderInfo | | \- POST /api/spot/v1/trade/open-order | \- GET /api/v2/spot/trade/unfilled-orders | | \- POST /api/spot/v1/trade/history | \- GET /api/v2/spot/trade/history-orders | | \- POST /api/spot/v1/trade/fills | \- GET /api/v2/spot/trade/fills | | \- POST /api/spot/v1/plan/placePlan | \- POST /api/v2/spot/trade/place-plan-order | | \- POST /api/spot/v1/plan/modifyPlan | \- POST /api/v2/spot/trade/modify-plan-order | | \- POST /api/spot/v1/plan/cancelPlan | \- POST /api/v2/spot/trade/cancel-plan-order | | \- POST /api/spot/v1/plan/currentPlan | \- GET /api/v2/spot/trade/current-plan-order | | \- POST /api/spot/v1/plan/historyPlan | \- GET /api/v2/spot/trade/history-plan-order | | \- POST /api/spot/v1/plan/batchCancelPlan | \- POST /api/v2/spot/trade/batch-cancel-plan-order | | \- GET /api/p2p/v1/merchant/merchantList | \- GET /api/v2/p2p/merchantList | | \- GET /api/p2p/v1/merchant/merchantInfo | \- GET /api/v2/p2p/merchantInfo | | \- GET /api/p2p/v1/merchant/advList | \- GET /api/v2/p2p/advList | | \- GET /api/p2p/v1/merchant/orderList | \- GET /api/v2/p2p/orderList | | \- POST /api/user/v1/sub/virtual-create | \- POST /api/v2/user/create-virtual-subaccount | | \- POST /api/user/v1/sub/virtual-modify | \- POST /api/v2/user/modify-virtual-subaccount | | \- POST /api/user/v1/sub/virtual-api-batch-create | \- POST /api/v2/user/batch-create-subaccount-and-apikey | | \- GET /api/user/v1/sub/virtual-list | \- GET /api/v2/user/virtual-subaccount-list | | \- POST /api/user/v1/sub/virtual-api-create | \- POST /api/v2/user/create-virtual-subaccount-apikey | | \- POST /api/user/v1/sub/virtual-api-modify | \- POST /api/v2/user/modify-virtual-subaccount-apikey | | \- GET /api/user/v1/sub/virtual-api-list | \- GET /api/v2/user/virtual-subaccount-apikey-list | | \- GET /api/spot/v1/convert/currencies | \- GET /api/v2/convert/currencies | | \- POST /api/spot/v1/convert/quoted-price | \- POST /api/v2/convert/quoted-price | | \- POST /api/spot/v1/convert/trade | \- POST /api/v2/convert/trade | | \- GET /api/spot/v1/convert/convert-record | \- GET /api/v2/convert/convert-record | | \- GET /api/user/v1/tax/spot-record | \- GET /api/v2/tax/spot-record | | \- GET /api/user/v1/tax/future-record | \- GET /api/v2/tax/future-record | | \- GET /api/user/v1/tax/margin-record | \- GET /api/v2/tax/margin-record | | \- GET /api/user/v1/tax/p2p-record | \- GET /api/v2/tax/p2p-record | ### Future[​](https://www.bitgetapp.com/api-doc/common/release-note#future "Direct link to Future") | V1 Endpoint | V2 Endpoint | | --- | --- | | \- GET /api/mix/v1/market/ticker | \- GET /api/v2/mix/market/ticker | | \- GET /api/mix/v1/market/tickers | \- GET /api/v2/mix/market/tickers | | \- GET /api/mix/v1/market/contract-vip-level | \- GET /api/v2/mix/market/vip-fee-rate | | \- GET /api/mix/v1/market/fills | \- GET /api/v2/mix/market/fills | | \- GET /api/mix/v1/market/fills-history | \- GET /api/v2/mix/market/fills-history | | \- GET /api/mix/v1/market/candles | \- GET /api/v2/mix/market/candles | | \- GET /api/mix/v1/market/history-candles | \- GET /api/v2/mix/market/history-candles | | \- GET /api/mix/v1/market/history-index-candles | \- GET /api/v2/mix/market/history-index-candles | | \- GET /api/mix/v1/market/history-mark-candles | \- GET /api/v2/mix/market/history-mark-candles | | \- GET /api/mix/v1/market/funding-time | \- GET /api/v2/mix/market/funding-time | | \- GET /api/mix/v1/market/history-fundRate | \- GET /api/v2/mix/market/history-fund-rate | | \- GET /api/mix/v1/market/current-fundRate | \- GET /api/v2/mix/market/current-fund-rate | | \- GET /api/mix/v1/market/open-interest | \- GET /api/v2/mix/market/open-interest | | \- GET /api/mix/v1/market/queryPositionLever | \- GET /api/v2/mix/market/query-position-lever | | \- GET /api/mix/v1/account/account | \- GET /api/v2/mix/account/account | | \- GET /api/mix/v1/account/accounts | \- GET /api/v2/mix/account/accounts | | \- POST /api/mix/v1/account/sub-account-contract-assets | \- GET /api/v2/mix/account/sub-account-assets | | \- POST /api/mix/v1/account/open-count | \- GET /api/v2/mix/account/open-count | | \- POST /api/mix/v1/account/setLeverage | \- POST /api/v2/mix/account/set-leverage | | \- POST /api/mix/v1/account/setMargin | \- POST /api/v2/mix/account/set-margin | | \- POST /api/mix/v1/account/setMarginMode | \- POST /api/v2/mix/account/set-margin-mode | | \- POST /api/mix/v1/account/setPositionMode | \- POST /api/v2/mix/account/set-position-mode | | \- GET /api/mix/v1/position/singlePosition | \- GET /api/v2/mix/position/single-position | | \- GET /api/mix/v1/position/singlePosition-v2 | \- GET /api/v2/mix/position/single-position | | \- GET /api/mix/v1/position/allPosition | \- GET /api/v2/mix/position/all-position | | \- GET /api/mix/v1/position/allPosition-v2 | \- GET /api/v2/mix/position/all-position | | \- GET /api/mix/v1/account/accountBill | \- GET /api/v2/mix/account/bill | | \- GET /api/mix/v1/account/accountBusinessBill | \- GET /api/v2/mix/account/bill | | \- GET /api/mix/v1/market/index | \- GET /api/v2/mix/market/symbol-price | | \- GET /api/mix/v1/market/mark-price | \- GET /api/v2/mix/market/symbol-price | | \- GET /api/mix/v1/market/contracts | \- GET /api/v2/mix/market/contracts | | \- GET /api/mix/v1/market/symbol-leverage | \- GET /api/v2/mix/market/contracts | | \- GET /api/mix/v1/market/open-limit | \- GET /api/v2/mix/market/contracts | | \- POST /api/mix/v1/plan/placePlan | \- POST /api/v2/mix/order/place-plan-order | | \- POST /api/mix/v1/plan/placeTrailStop | \- POST /api/v2/mix/order/place-plan-order | | \- POST /api/mix/v1/plan/modifyPlan | \- POST /api/v2/mix/order/modify-plan-order | | \- POST /api/mix/v1/plan/modifyPlanPreset | \- POST /api/v2/mix/order/modify-plan-order | | \- POST /api/mix/v1/plan/cancelPlan | \- POST /api/v2/mix/order/cancel-plan-order | | \- POST /api/mix/v1/plan/cancelSymbolPlan | \- POST /api/v2/mix/order/cancel-plan-order | | \- POST /api/mix/v1/order/cancel-batch-orders | \- POST /api/v2/mix/order/batch-cancel-orders | | \- POST /api/mix/v1/order/cancel-all-orders | \- POST /api/v2/mix/order/batch-cancel-orders | | \- POST /api/mix/v1/order/cancel-symbol-orders | \- POST /api/v2/mix/order/batch-cancel-orders | | \- GET /api/mix/v1/order/current | \- GET /api/v2/mix/order/orders-pending | | \- GET /api/mix/v1/order/marginCoinCurrent | \- GET /api/v2/mix/order/orders-pending | | \- GET /api/mix/v1/order/history | \- GET api/v2/mix/order/orders-history | | \- GET /api/mix/v1/order/historyProductType | \- GET api/v2/mix/order/orders-history | | \- GET /api/mix/v1/order/fills | \- GET /api/v2/mix/order/fills | | \- GET /api/mix/v1/order/allFills | \- GET /api/v2/mix/order/fills | | \- POST /api/mix/v1/order/placeOrder | \- POST /api/v2/mix/order/place-order | | \- POST /api/mix/v1/order/placeOrder | \- POST /api/v2/mix/order/click-backhand | | \- POST /api/mix/v1/order/batch-orders | \- POST /api/v2/mix/order/batch-place-order | | \- POST /api/mix/v1/order/cancel-order | \- POST /api/v2/mix/order/cancel-order | | \- POST /api/mix/v1/order/modifyOrder | \- POST /api/v2/mix/order/modify-order | | \- POST /api/mix/v1/order/close-all-positions | \- POST /api/v2/mix/order/close-positions | | \- GET /api/mix/v1/order/detail | \- GET /api/v2/mix/order/detail | | N/A | \- GET /api/v2/mix/order/orders-plan-pending | | N/A | \- GET /api/v2/mix/order/orders-plan-history | ### Margin[​](https://www.bitgetapp.com/api-doc/common/release-note#margin "Direct link to Margin") | V1 Endpoint | V2 Endpoint | | --- | --- | | \- GET /api/margin/v1/cross/public/interestRateAndLimit | \- GET /api/v2/margin/cross/interest-rate-and-limit | | \- GET /api/margin/v1/isolated/public/interestRateAndLimit | \- GET /api/v2/margin/isolated/interest-rate-and-limit | | \- GET /api/margin/v1/cross/public/tierData | \- GET /api/v2/margin/cross/tier-data | | \- GET /api/margin/v1/isolated/public/tierData | \- GET /api/v2/margin/isolated/tier-data | | \- GET /api/margin/v1/public/currencies | \- GET /api/v2/margin/currencies | | \- GET /api/margin/v1/cross/account/assets | \- GET /api/v2/margin/cross/account/assets | | \- GET /api/margin/v1/isolated/account/assets | \- GET /api/v2/margin/isolated/account/assets | | \- POST /api/margin/v1/cross/account/borrow | \- POST /api/v2/margin/cross/account/borrow | | \- POST /api/margin/v1/isolated/account/borrow | \- POST /api/v2/margin/isolated/account/borrow | | \- POST /api/margin/v1/cross/account/repay | \- POST /api/v2/margin/cross/account/repay | | \- GET /api/margin/v1/isolated/account/repay | \- POST /api/v2/margin/cross/account/repay | | \- GET /api/margin/v1/cross/account/riskRate | \- GET /api/v2/margin/cross/account/risk-rate | | \- POST /api/margin/v1/isolated/account/riskRate | \- GET /api/v2/margin/cross/account/risk-rate | | \- POST /api/margin/v1/cross/account/maxBorrowableAmount | \- GET /api/v2/margin/cross/account/max-borrowable-amount | | \- GET /api/margin/v1/isolated/account/maxBorrowableAmount | \- GET /api/v2/margin/isolated/account/max-borrowable-amount | | \- GET /api/margin/v1/cross/account/maxTransferOutAmount | \- GET /api/v2/margin/cross/account/max-transfer-out-amount | | \- GET /api/margin/v1/isolated/account/maxTransferOutAmount | \- GET /api/v2/margin/isolated/account/max-transfer-out-amount | | \- POST /api/margin/v1/isolated/account/flashRepay | \- POST /api/v2/margin/isolated/account/flash-repay | | \- POST /api/margin/v1/isolated/account/queryFlashRepayStatus | \- POST /api/v2/margin/isolated/account/query-flash-repay-status | | \- POST /api/margin/v1/cross/account/flashRepay | \- POST /api/v2/margin/cross/account/flash-repay | | \- POST /api/margin/v1/cross/account/queryFlashRepayStatus | \- POST /api/v2/margin/cross/account/flash-repay-status | | \- POST /api/margin/v1/isolated/order/placeOrder | \- POST /api/v2/margin/isolated/place-order | | \- POST /api/margin/v1/isolated/order/batchPlaceOrder | \- POST /api/v2/margin/isolated/batch-place-order | | \- POST /api/margin/v1/isolated/order/cancelOrder | \- POST /api/v2/margin/isolated/cancel-order | | \- POST /api/margin/v1/isolated/order/batchCancelOrder | \- POST /api/v2/margin/isolated/batch-cancel-order | | \- GET /api/margin/v1/isolated/order/openOrders | \- GET /api/v2/margin/isolated/open-orders | | \- GET /api/margin/v1/isolated/order/history | \- GET /api/v2/margin/isolated/history-orders | | \- GET /api/margin/v1/isolated/order/fills | \- GET /api/v2/margin/isolated/fills | | \- GET /api/margin/v1/isolated/loan/list | \- GET /api/v2/margin/isolated/borrow-history | | \- GET /api/margin/v1/isolated/repay/list | \- GET /api/v2/margin/isolated/repay-history | | \- GET /api/margin/v1/isolated/interest/list | \- GET /api/v2/margin/isolated/interest-history | | \- GET /api/margin/v1/isolated/liquidation/list | \- GET /api/v2/margin/isolated/liquidation-history | | \- GET /api/margin/v1/isolated/fin/list | \- GET /api/v2/margin/isolated/financial-records | | \- POST /api/margin/v1/cross/order/placeOrder | \- POST /api/v2/margin/cross/place-order | | \- POST /api/margin/v1/cross/order/batchPlaceOrder | \- POST /api/v2/margin/cross/batch-place-order | | \- POST /api/margin/v1/cross/order/cancelOrder | \- POST /api/v2/margin/cross/cancel-order | | \- POST /api/margin/v1/cross/order/batchCancelOrder | \- POST /api/v2/margin/cross/batch-cancel-order | | \- GET /api/margin/v1/cross/order/openOrders | \- GET /api/v2/margin/cross/open-orders | | \- GET /api/margin/v1/cross/order/history | \- GET /api/v2/margin/cross/history-orders | | \- GET /api/margin/v1/cross/order/fills | \- GET /api/v2/margin/cross/fills | | \- GET /api/margin/v1/cross/loan/list | \- GET /api/v2/margin/cross/borrow-history | | \- GET /api/margin/v1/cross/repay/list | \- GET /api/v2/margin/cross/repay-history | | \- GET /api/margin/v1/cross/interest/list | \- GET /api/v2/margin/cross/interest-history | | \- GET /api/margin/v1/cross/liquidation/list | \- GET /api/v2/margin/cross/liquidation-history | | \- GET /api/margin/v1/cross/fin/list | \- GET /api/v2/margin/cross/financial-records | ### Broker[​](https://www.bitgetapp.com/api-doc/common/release-note#broker "Direct link to Broker") | V1 Endpoint | V2 Endpoint | | --- | --- | | \- GET /api/broker/v1/account/info | \- GET /api/v2/broker/account/info | | \- POST /api/broker/v1/account/sub-create | \- POST /api/v2/broker/account/create-subaccount | | \- GET /api/broker/v1/account/sub-list | \- GET /api/v2/broker/account/subaccount-list | | \- POST /api/broker/v1/account/sub-modify | \- POST /api/v2/broker/account/modify-subaccount | | \- POST /api/broker/v1/account/sub-modify-email | \- POST /api/v2/broker/account/modify-subaccount-email | | \- GET /api/broker/v1/account/sub-email | \- GET /api/v2/broker/account/subaccount-email | | \- GET /api/broker/v1/account/sub-spot-assets | \- GET /api/v2/broker/account/subaccount-spot-assets | | \- GET /api/broker/v1/account/sub-future-assets | \- GET /api/v2/broker/account/subaccount-future-assets | | \- POST /api/broker/v1/account/sub-address | \- POST /api/v2/broker/account/subaccount-address | | \- POST /api/broker/v1/account/sub-withdrawal | \- POST /api/v2/broker/account/subaccount-withdrawal | | \- POST /api/broker/v1/account/sub-auto-transfer | \- POST /api/v2/broker/account/set-subaccount-autotransfer | | \- POST /api/broker/v1/manage/sub-api-create | \- POST /api/v2/broker/manage/create-subaccount-apikey | | \- GET /api/broker/v1/manage/sub-api-list | \- GET /api/v2/broker/manage/subaccount-apikey-list | | \- POST /api/broker/v1/manage/sub-api-modify | \- POST /api/v2/broker/manage/modify-subaccount-apikey | ### Future Copy Trading[​](https://www.bitgetapp.com/api-doc/common/release-note#future-copy-trading "Direct link to Future Copy Trading") | V1 Endpoint | V2 Endpoint | | --- | --- | | \- POST /api/mix/v1/trace/closeTrackOrder | \- POST /api/v2/copy/mix-trader/order-close-positions | | \- POST /api/mix/v1/trace/closeTrackOrderBySymbol | \- POST /api/v2/copy/mix-trader/order-close-positions | | \- GET /api/mix/v1/trace/currentTrack | \- GET /api/v2/copy/mix-trader/order-current-track | | \- GET /api/mix/v1/trace/historyTrack | \- GET /api/v2/copy/mix-trader/order-history-track | | \- POST /api/mix/v1/trace/modifyTPSL | \- POST /api/v2/copy/mix-trader/order-modify-tpsl | | \- GET /api/mix/v1/trace/traderDetail | \- GET /api/v2/copy/mix-trader/order-total-detail | | \- GET /api/mix/v1/trace/summary | \- GET /api/v2/copy/mix-trader/profit-summarys | | \- GET /api/mix/v1/trace/profitSettleTokenIdGroup | \- GET /api/v2/copy/mix-trader/profit-summarys | | \- GET /api/mix/v1/trace/profitDateList | \- GET /api/v2/copy/mix-trader/profit-hisotry-details | | \- GET /api/mix/v1/trace/waitProfitDateList | \- GET /api/v2/copy/mix-trader/profit-details | | \- GET /api/mix/v1/trace/profitDateGroupList | \- GET /api/v2/copy/mix-trader/profits-group-coin-date | | \- GET /api/mix/v1/trace/traderSymbols | \- GET /api/v2/copy/mix-trader/config-query-symbols | | \- POST /api/mix/v1/trace/queryTraderTpslRatioConfig | \- GET /api/v2/copy/mix-trader/config-query-symbols | | \- POST /api/mix/v1/trace/setUpCopySymbols | \- POST /api/v2/copy/mix-trader/config-setting-symbols | | \- POST /api/mix/v1/trace/traderUpdateTpslRatioConfig | \- POST /api/v2/copy/mix-trader/config-setting-symbols | | \- POST /api/mix/v1/trace/traderUpdateConfig | \- POST /api/v2/copy/mix-trader/config-settings-base | | \- GET /api/mix/v1/trace/myFollowerList | \- GET /api/v2/copy/mix-trader/config-query-followers | | \- POST /api/mix/v1/trace/removeFollower | \- POST /api/v2/copy/mix-trader/config-remove-follower | | \- POST /api/mix/v1/trace/followerCloseByTrackingNo | \- POST /api/v2/copy/mix-follower/close-positions | | \- POST /api/mix/v1/trace/followerCloseByAll | \- POST /api/v2/copy/mix-follower/close-positions | | \- GET /api/mix/v1/trace/followerOrder | \- GET /api/v2/copy/mix-follower/query-current-orders | | \- GET /api/mix/v1/trace/followerHistoryOrders | \- GET /api/v2/copy/mix-follower/query-history-orders | | \- POST /api/mix/v1/trace/followerSetTpsl | \- POST /api/v2/copy/mix-follower/setting-tpsl | | \- GET /api/mix/v1/trace/queryTraceConfig | \- GET /api/v2/copy/mix-follower/query-settings | | \- GET /api/mix/v1/trace/public/getFollowerConfig | \- GET /api/v2/copy/mix-follower/query-quantity-limit | | \- POST /api/mix/v1/trace/followerSetBatchTraceConfig | \- POST /api/v2/copy/mix-follower/settings | | \- POST /api/mix/v1/trace/cancelCopyTrader | \- POST /api/v2/copy/mix-follower/cancel-trader | | \- GET /api/mix/v1/trace/myTraderList | \- GET /api/v2/copy/mix-follower/query-traders | | \- GET /api/mix/v1/trace/traderList | \- GET /api/v2/copy/mix-broker/query-traders | | \- GET /api/mix/v1/trace/report/order/historyList | \- GET /api/v2/copy/mix-broker/query-history-traces | | \- GET /api/mix/v1/trace/report/order/currentList | \- GET /api/v2/copy/mix-broker/query-current-traces | ### Spot Copy Trading[​](https://www.bitgetapp.com/api-doc/common/release-note#spot-copy-trading "Direct link to Spot Copy Trading") | V1 Endpoint | V2 Endpoint | | --- | --- | | \- POST /api/spot/v1/trace/profit/totalProfitInfo | \- GET /api/v2/copy/spot-trader/profit-summarys | | \- POST /api/spot/v1/trace/profit/totalProfitList | \- GET /api/v2/copy/spot-trader/profit-summarys | | \- POST /api/spot/v1/trace/profit/profitHisList | \- GET /api/v2/copy/spot-trader/profit-summarys | | \- POST /api/spot/v1/trace/profit/profitHisDetailList | \- GET /api/v2/copy/spot-trader/profit-hisotry-details | | \- POST /api/spot/v1/trace/profit/waitProfitDetailList | \- GET /api/v2/copy/spot-trader/profit-details | | \- POST /api/spot/v1/trace/order/orderCurrentList | \- GET /api/v2/copy/spot-trader/order-current-track | | \- POST /api/spot/v1/trace/order/orderHistoryList | \- GET /api/v2/copy/spot-trader/order-history-track | | \- POST /api/spot/v1/trace/order/updateTpsl | \- POST /api/v2/copy/spot-trader/order-modify-tpsl | | \- POST /api/spot/v1/trace/order/closeTrackingOrder | \- POST /api/v2/copy/spot-trader/order-close-tracking | | \- POST /api/spot/v1/trace/user/getTraderInfo | \- GET /api/v2/copy/spot-trader/order-total-detail | | \- POST /api/spot/v1/trace/config/getTraderSettings | \- GET /api/v2/copy/spot-trader/config-query-settings | | \- POST /api/spot/v1/trace/order/spotInfoList | \- GET /api/v2/copy/spot-trader/config-query-settings | | \- POST /api/spot/v1/trace/config/getRemoveFollowerConfig | \- GET /api/v2/copy/spot-trader/config-query-settings | | \- POST /api/spot/v1/trace/user/myFollowers | \- GET /api/v2/copy/spot-trader/config-query-followers | | \- POST /api/spot/v1/trace/config/setProductCode | \- POST /api/v2/copy/spot-trader/config-setting-symbols | | \- POST /api/spot/v1/trace/user/removeFollower | \- POST /api/v2/copy/spot-trader/config-remove-follower | | N/A | \- GET /api/v2/copy/spot-follower/query-current-orders | | N/A | \- GET /api/v2/copy/mix-follower/query-history-orders | | N/A | \- POST /api/v2/copy/spot-follower/setting-tpsl | | N/A | \- POST /api/v2/copy/spot-follower/order-close-tracking | | \- POST /api/spot/v1/trace/config/getFollowerSettings | \- GET /api/v2/copy/spot-follower/query-settings | | \- POST /api/spot/v1/trace/user/myTraders | \- GET /api/v2/copy/spot-follower/query-traders | | \- POST /api/spot/v1/trace/config/setFollowerConfig | \- POST /api/v2/copy/spot-follower/settings | | \- POST /api/spot/v1/trace/user/removeTrader | \- POST /api/v2/copy/spot-follower/cancel-trader | | \- POST /api/spot/v1/trace/order/followerEndOrder | \- POST /api/v2/copy/spot-follower/stop-order | | N/A | \- GET /api/v2/copy/spot-follower/query-trader-symbols | ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback * [Scope of changes](https://www.bitgetapp.com/api-doc/common/release-note#scope-of-changes) * [Interface aggregation](https://www.bitgetapp.com/api-doc/common/release-note#interface-aggregation) * [Global symbol request rule changes](https://www.bitgetapp.com/api-doc/common/release-note#global-symbol-request-rule-changes) * [Optimization of global query rules](https://www.bitgetapp.com/api-doc/common/release-note#optimization-of-global-query-rules) * [Standardization of naming rules for business line interfaces and parameters](https://www.bitgetapp.com/api-doc/common/release-note#standardization-of-naming-rules-for-business-line-interfaces-and-parameters) * [Clearer catalog categorization](https://www.bitgetapp.com/api-doc/common/release-note#clearer-catalog-categorization) * [Accessibility of more in-depth information](https://www.bitgetapp.com/api-doc/common/release-note#accessibility-of-more-in-depth-information) * [Merge of futures trigger order and trailing stop-loss](https://www.bitgetapp.com/api-doc/common/release-note#merge-of-futures-trigger-order-and-trailing-stop-loss) * [Position opening/closing in futures order placement](https://www.bitgetapp.com/api-doc/common/release-note#position-openingclosing-in-futures-order-placement) * [Optimization of delivery futures](https://www.bitgetapp.com/api-doc/common/release-note#optimization-of-delivery-futures) * [Optimized maximum/minimum order size logic of trading pairs](https://www.bitgetapp.com/api-doc/common/release-note#optimized-maximumminimum-order-size-logic-of-trading-pairs) * [Earn interfaces coming soon](https://www.bitgetapp.com/api-doc/common/release-note#earn-interfaces-coming-soon) * [Crypto Loan interfaces coming soon](https://www.bitgetapp.com/api-doc/common/release-note#crypto-loan-interfaces-coming-soon) * [Interface Mapping Tables](https://www.bitgetapp.com/api-doc/common/release-note#interface-mapping-tables) * [Spot](https://www.bitgetapp.com/api-doc/common/release-note#spot) * [Future](https://www.bitgetapp.com/api-doc/common/release-note#future) * [Margin](https://www.bitgetapp.com/api-doc/common/release-note#margin) * [Broker](https://www.bitgetapp.com/api-doc/common/release-note#broker) * [Future Copy Trading](https://www.bitgetapp.com/api-doc/common/release-note#future-copy-trading) * [Spot Copy Trading](https://www.bitgetapp.com/api-doc/common/release-note#spot-copy-trading) --- # SDK | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/common/sdk-postman#__docusaurus_skipToContent_fallback) SDK === We support below languages | Language | Code Path | | --- | --- | | [Java](https://github.com/BitgetLimited/v3-bitget-api-sdk/tree/master/bitget-java-sdk-api) | Check package `com.bitget.openapi.api.v2` | | [Python](https://github.com/BitgetLimited/v3-bitget-api-sdk/tree/master/bitget-python-sdk-api) | Check `v2` | | [NodeJs](https://github.com/BitgetLimited/v3-bitget-api-sdk/tree/master/bitget-node-sdk-api) | Check `src/lib/v2` | | [Golang](https://github.com/BitgetLimited/v3-bitget-api-sdk/tree/master/bitget-golang-sdk-api) | Check `pkg/client/v2` | | [PHP](https://github.com/BitgetLimited/v3-bitget-api-sdk/tree/master/bitget-php-sdk-api) | Check `src/api/v2` | ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback --- # Changelog | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/common/changelog#__docusaurus_skipToContent_fallback) On this page Changelog ========= \[September 2, 2025\] Add reason field for Get Upgrade Status[​](https://www.bitgetapp.com/api-doc/common/changelog#september-2-2025-add-reason-field-for-get-upgrade-status "Direct link to september-2-2025-add-reason-field-for-get-upgrade-status") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface: /api/v2/spot/account/upgrade-status Changes： * Add reason field for Get Upgrade Status \[August 28, 2025\] Notice: Optimization of Push Frequency for Websocket Order Book Channel (books1) in Classic Account (v2)[​](https://www.bitgetapp.com/api-doc/common/changelog#august-28-2025-notice-optimization-of-push-frequency-for-websocket-order-book-channel-books1--in-classic-account-v2 "Direct link to august-28-2025-notice-optimization-of-push-frequency-for-websocket-order-book-channel-books1--in-classic-account-v2") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Websocket: Order Book Channel Adjustment Content: The push frequency of the order book channel (books1) is optimized to 20ms. The symbols for this optimization are: BTCUSDT, ETHUSDT, XRPUSDT, SOLUSDT, SUIUSDT, DOGEUSDT, ADAUSDT, PEPEUSDT, LINKUSDT, HBARUSDT \[August 11, 2025\] Agent commission API query supports fee deduction[​](https://www.bitgetapp.com/api-doc/common/changelog#august-11-2025-agent-commission-api-query-supports-fee-deduction "Direct link to august-11-2025-agent-commission-api-query-supports-fee-deduction") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface：/api/broker/v1/agent/commission-distribution;/api/broker/v1/agent/customer-commissions; Changes： * Agent commission API query supports fee deduction details \[August 11, 2025\] API Global rate Limit Adjustment[​](https://www.bitgetapp.com/api-doc/common/changelog#august-11-2025-api-global-rate-limit-adjustment "Direct link to august-11-2025-api-global-rate-limit-adjustment") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Changes： * There is an overall rate limit rule of 6,000 times per IP per minute. After the rate limit is triggered, the recovery time is adjusted from 1 minute to 5 minutes. \[August 6, 2025\] Add unrealizedPL field for sub-account futures asset info[​](https://www.bitgetapp.com/api-doc/common/changelog#august-6-2025-add-unrealizedpl-field-for-sub-account-futures-asset-info "Direct link to august-6-2025-add-unrealizedpl-field-for-sub-account-futures-asset-info") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface：/api/v2/broker/account/subaccount-future-assets Changes： * Add unrealizedPL field for sub-account futures asset info \[August 6, 2025\] Add marginCoin field for historical transaction details[​](https://www.bitgetapp.com/api-doc/common/changelog#august-6-2025-add-margincoin-field-for-historical-transaction-details "Direct link to august-6-2025-add-margincoin-field-for-historical-transaction-details") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface：/api/v2/mix/order/fill-history Changes： * Add marginCoin field for historical transaction details \[August 4, 2025\] Delisting of Futures Demo Pairs[​](https://www.bitgetapp.com/api-doc/common/changelog#august-4-2025-delisting-of-futures-demo-pairs "Direct link to august-4-2025-delisting-of-futures-demo-pairs") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Futures demo pairs have been delisted. Please use the [demo trading](https://www.bitgetapp.com/api-doc/common/demotrading/restapi) for simulated trading. \[July 31, 2025\] Optimization of the futures order placement interface logic[​](https://www.bitgetapp.com/api-doc/common/changelog#july-31-2025-optimization-of-the-futures-order-placement-interface-logic "Direct link to july-31-2025-optimization-of-the-futures-order-placement-interface-logic") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface： /api/v2/mix/order/place-order Changes： * before: In hedge mode, if the existing quantity is equal to the limit close order of the position, a newly added market close order will report an error due to insufficient position and will not automatically cancel the limit order that has occupied the position. * after: In hedge mode, if the existing quantity is equal to the limit close order of the position, a newly added market close order will automatically cancel the limit order that has occupied the position (consistent with Web/APP). \[July 29, 2025\] Optimize ADL API ranking logic.[​](https://www.bitgetapp.com/api-doc/common/changelog#july-29-2025-optimize-adl-api-ranking-logic "Direct link to july-29-2025-optimize-adl-api-ranking-logic") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Interface：/api/v2/mix/position/adlRank Changes： * Optimize the ranking logic of the ADL API on the server side.Add a new field "rank" and deprecated the field "adlRank". \[July 16, 2025\] Add New Account Mode Switching API[​](https://www.bitgetapp.com/api-doc/common/changelog#july-16-2025-add-new-account-mode-switching-api "Direct link to july-16-2025-add-new-account-mode-switching-api") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface：/api/v2/spot/account/upgrade, /api/v2/spot/account/upgrade-status Adjustment: * Add New Account Mode Switching API \[July 14, 2025\] Futures leverage adjustment API supports setting long/short leverage ratios separately.[​](https://www.bitgetapp.com/api-doc/common/changelog#july-14-2025--futures-leverage-adjustment-api-supports-setting-longshort-leverage-ratios-separately "Direct link to july-14-2025--futures-leverage-adjustment-api-supports-setting-longshort-leverage-ratios-separately") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Interface： /api/v2/mix/account/set-leverage Changes： * Futures leverage adjustment API supports setting long/short leverage ratios separately. \[July 14, 2025\] Position take-profit/stop-loss API supports setting custom IDs for take-profit and stop-loss orders separately.[​](https://www.bitgetapp.com/api-doc/common/changelog#july-14-2025--position-take-profitstop-loss-api-supports-setting-custom-ids-for-take-profit-and-stop-loss-orders-separately "Direct link to july-14-2025--position-take-profitstop-loss-api-supports-setting-custom-ids-for-take-profit-and-stop-loss-orders-separately") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Interface： /api/v2/mix/order/place-pos-tpsl Changes： * Position take-profit/stop-loss API supports setting custom IDs for take-profit and stop-loss orders separately. \[July 14, 2025\] The interface for obtaining the list of historical contract positions has added a position mode field.[​](https://www.bitgetapp.com/api-doc/common/changelog#july-14-2025--the-interface-for-obtaining-the-list-of-historical-contract-positions-has-added-a-position-mode-field "Direct link to july-14-2025--the-interface-for-obtaining-the-list-of-historical-contract-positions-has-added-a-position-mode-field") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface： /api/v2/mix/position/history-position Changes： * The interface return parameters have added `posMode` (position mode), with enumeration values including `one_way_mode` (one-way position) and `hedge_mode` (hedge mode/two-way position). \[July 8, 2025\] WebSocket futures position channel adds mark price parameter[​](https://www.bitgetapp.com/api-doc/common/changelog#july-8-2025-websocket-futures-position-channel-adds-mark-price-parameter "Direct link to july-8-2025-websocket-futures-position-channel-adds-mark-price-parameter") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Channels: futures position channel Changes： * WebSocket futures position channel adds mark price parameter \[July 1, 2025\] WebSocket Adds Order Placement and Cancellation Channels[​](https://www.bitgetapp.com/api-doc/common/changelog#july-1-2025-websocket-adds-order-placement-and-cancellation-channels "Direct link to july-1-2025-websocket-adds-order-placement-and-cancellation-channels") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Channels: Place Order，Cancel Order Changes： * Adds Order Placement and Cancellation Channels \[Jun 17, 2025\]Spot merged trading depth, spot trading depth, futures merged depth interfaces: ts field adjustment[​](https://www.bitgetapp.com/api-doc/common/changelog#jun-17-2025spot-merged-trading-depth-spot-trading-depth-futures-merged-depth-interfaces-ts-field-adjustment "Direct link to jun-17-2025spot-merged-trading-depth-spot-trading-depth-futures-merged-depth-interfaces-ts-field-adjustment") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface：/api/v2/mix/market/merge-depth,/api/v2/spot/market/orderbook,/api/v2/spot/market/merge-depth Changes： * Spot merged trading depth, spot trading depth, and futures merged depth interfaces: ts field adjusted to matching engine timestamp \[Jun 16, 2025\] The ADL ranking interface has added the position direction.[​](https://www.bitgetapp.com/api-doc/common/changelog#jun-16-2025-the-adl-ranking-interface-has-added-the-position-direction "Direct link to jun-16-2025-the-adl-ranking-interface-has-added-the-position-direction") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface：/api/v2/mix/position/adlRank Changes： * The ADL ranking interface has added the position direction `holdSide` field。 \[June 09, 2025\] Get Contract Information Adds Maximum Order Quantity Fields[​](https://www.bitgetapp.com/api-doc/common/changelog#june-09-2025-get-contract-information-adds-maximum-order-quantity-fields "Direct link to june-09-2025-get-contract-information-adds-maximum-order-quantity-fields") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface：/api/v2/mix/market/contracts Changes： * Added maxMarketOrderQty field for the maximum quantity of a single market order. * Added maxOrderQty field for the maximum quantity of a single limit order. \[May 19, 2025\] Update on Regular Release Date[​](https://www.bitgetapp.com/api-doc/common/changelog#may-19-2025-update-on-regular-release-date "Direct link to may-19-2025-update-on-regular-release-date") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The current fixed regular release date for backend is **every Tuesday, Wednesday, and Thursday from 14:00 PM to 17:00 PM (UTC +8)**(Except for emergency upgrade). During the regular release time window, the RestAPI may return 45001, 40725, or 40808 error responses. Users can retry after receiving these error responses. WebSocket connections may be disconnected during the release period. WebSocket users are advised to implement a reconnection mechanism in their code. \[May 19,2025\] Adjustment of the Spot place-plan-order API[​](https://www.bitgetapp.com/api-doc/common/changelog#may-192025-adjustment-of-the-spot-place-plan-order-api "Direct link to may-192025-adjustment-of-the-spot-place-plan-order-api") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface：/api/v2/spot/trade/place-plan-order Changes： * The `force` field was invalid when placing an order and has been deleted. \[May 14, 2025\] New version: Order-taking staff API Key creation interface adds currency pair range description.[​](https://www.bitgetapp.com/api-doc/common/changelog#may-14-2025-new-version-order-taking-staff-api-key-creation-interface-adds-currency-pair-range-description "Direct link to may-14-2025-new-version-order-taking-staff-api-key-creation-interface-adds-currency-pair-range-description") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface：/api/v2/copy/mix-trader/create-copy-api Changes： * New: Added description for order-taking currency pair range. \[May 09, 2025\] Obtain the adjustment of the input parameters for the current funding rate.[​](https://www.bitgetapp.com/api-doc/common/changelog#may-09-2025-obtain-the-adjustment-of-the-input-parameters-for-the-current-funding-rate "Direct link to may-09-2025-obtain-the-adjustment-of-the-input-parameters-for-the-current-funding-rate") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface：/api/v2/mix/market/current-fund-rate Changes： * Obtain that the request parameter `symbol` of the current funding rate is changed to be non-mandatory. \[May 09, 2025\] Optimized the API for retrieving spot assets of sub-accounts.[​](https://www.bitgetapp.com/api-doc/common/changelog#may-09-2025-optimized-the-api-for-retrieving-spot-assets-of-sub-accounts "Direct link to may-09-2025-optimized-the-api-for-retrieving-spot-assets-of-sub-accounts") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface：/api/v2/spot/account/subaccount-assets Changes： * Added pagination parameters: `idLessThan` (pagination cursor) and `limit` (items per page). * Added return field: `id` (cursor ID) \[May 09, 2025\] Optimized the API for querying announcements.[​](https://www.bitgetapp.com/api-doc/common/changelog#may-09-2025-optimized-the-api-for-querying-announcements "Direct link to may-09-2025-optimized-the-api-for-querying-announcements") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface：/api/v2/public/annoucements Changes： * New announcement types added `product_updates`: Product Updates `security`: Security `api_trading`: API Trading * Added pagination parameters: `cursor` (pagination cursor ID) and `limit` (items per page). * Deprecated announcement type: `trading_competitions_promotions` (Trading Competitions and Promotions) * The return field `annDesc` (Announcement Description) is deprecated. \[May 08, 2025\] Interface for adding leverage interest rate records[​](https://www.bitgetapp.com/api-doc/common/changelog#may-08-2025-interface-for-adding-leverage-interest-rate-records "Direct link to may-08-2025-interface-for-adding-leverage-interest-rate-records") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface： /api/v2/margin/interest-rate-record Changes： * The interface for adding leverage interest rate records supports users to query the interest rate record data based on the trading pairs. \[May 08, 2025\] Optimization of the query range for public transaction details of spot/contract.[​](https://www.bitgetapp.com/api-doc/common/changelog#may-08-2025-optimization-of-the-query-range-for-public-transaction-details-of-spotcontract "Direct link to may-08-2025-optimization-of-the-query-range-for-public-transaction-details-of-spotcontract") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface： /api/v2/spot/market/fills-history; /api/v2/mix/market/fills-history； Changes： * Adjust the time span from 7 days to 90 days, which means it supports querying public transaction data from the past three months. \[May 08, 2025\] Add preset stop - profit and stop - loss execution prices for contract orders.[​](https://www.bitgetapp.com/api-doc/common/changelog#may-08-2025-add-preset-stop---profit-and-stop---loss-execution-prices-for-contract-orders "Direct link to may-08-2025-add-preset-stop---profit-and-stop---loss-execution-prices-for-contract-orders") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Interface： /api/v2/mix/order/place-order Changes： * Add request parameters `presetStopSurplusExecutePrice` Preset stop-profit execution price `presetStopLossExecutePrice` Preset stop-loss execution price \[May 08, 2025\] Add "utime" to the WebSocket push for cross-margin/isolated-margin leverage order channels.[​](https://www.bitgetapp.com/api-doc/common/changelog#may-08-2025-add-utime-to-the-websocket-push-for-cross-marginisolated-margin-leverage-order-channels "Direct link to may-08-2025-add-utime-to-the-websocket-push-for-cross-marginisolated-margin-leverage-order-channels") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Channels: Cross-margin Leverage Order Channel, Isolated-margin Leverage Order Channel Changes： * Add to the push data `utime` \[Apr 30,2025\] For the trading details of the WS futures, push fields are added to the spot/futures depth channels.[​](https://www.bitgetapp.com/api-doc/common/changelog#apr-302025-for-the-trading-details-of-the-ws-futures-push-fields-are-added-to-the-spotfutures-depth-channels "Direct link to apr-302025-for-the-trading-details-of-the-ws-futures-push-fields-are-added-to-the-spotfutures-depth-channels") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Channels: futures Trading Details Channel, Spot Depth Channel, Contract Depth Channel Changes: * Add the `clientOid` field to the pushed information of the futures Trading Details Channel. * Add the `seq` field to the pushed information of the Spot Depth Channel and the futures Depth Channel. \[Apr 23, 2025\] Added groupType enumeration for get account bills.[​](https://www.bitgetapp.com/api-doc/common/changelog#apr-23-2025-added-grouptype-enumeration-for-get-account-bills "Direct link to apr-23-2025-added-grouptype-enumeration-for-get-account-bills") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Interface：/api/v2/spot/account/bills Changes： * Added a new bill type enumeration `groupType` for input parameters and return values when fetching bill transaction details. \[Apr 21,2025\] Delete error code 40882[​](https://www.bitgetapp.com/api-doc/common/changelog#apr-212025-delete-error-code-40882 "Direct link to apr-212025-delete-error-code-40882") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Removed content: * Removed error code `code 40882`:"You are currently a trader and you cannot switch to the full position mode|400|" \[Apr 14,2025\] Add New Endpoint: Get ND Broker Sub-accounts Deposit and Withdrawal Records[​](https://www.bitgetapp.com/api-doc/common/changelog#apr-142025-add-new-endpoint-get-nd-broker-sub-accounts-deposit-and-withdrawal-records "Direct link to apr-142025-add-new-endpoint-get-nd-broker-sub-accounts-deposit-and-withdrawal-records") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Interface：/api/v2/broker/all-sub-deposit-withdrawal Changes： * Adding new endpoint to get ND Broker sub-accounts deposit and withdrawal records within **90 days** \[Apr 10,2025\] Adjustment to virtual sub-account API key related endpoints[​](https://www.bitgetapp.com/api-doc/common/changelog#apr-102025-adjustment-to-virtual-sub-account-api-key-related-endpoints "Direct link to apr-102025-adjustment-to-virtual-sub-account-api-key-related-endpoints") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface：/api/v2/user/create-virtual-subaccount-apikey，/api/v2/user/modify-virtual-subaccount-apikey，/api/v2/user/virtual-subaccount-apikey-list Changes： * The `permList` parameter in the create, modify, and query sub-account API key interfaces now includes the `transfer`: wallet transfer permission. * The modify and query sub-account API key interfaces now support regular sub-accounts \[Apr 10,2025\] Added new field `offTime` in the response of Get Spot Symbol Info interface[​](https://www.bitgetapp.com/api-doc/common/changelog#apr-102025-added-new-field-offtime-in-the-response-of-get-spot-symbol-info-interface "Direct link to apr-102025-added-new-field-offtime-in-the-response-of-get-spot-symbol-info-interface") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Interface：/api/v2/spot/public/symbols Changes: * Added new field `offTime` in the response * The response parameter "maxTradeAmount" is fixed to return `900000000000000000000`; please disregard this response parameter. \[Apr 09, 2025\] Added ADL ranking interface.[​](https://www.bitgetapp.com/api-doc/common/changelog#apr-09-2025-added-adl-ranking-interface "Direct link to apr-09-2025-added-adl-ranking-interface") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Endpoints：/api/v2/mix/position/adlRank Additional content： * Supports obtaining ADL rankings for users across various trading pairs. \[Apr 08, 2025\] Added APIs for new order initiator key creation & follower order setup.[​](https://www.bitgetapp.com/api-doc/common/changelog#apr-08-2025-added-apis-for-new-order-initiator-key-creation--follower-order-setup "Direct link to apr-08-2025-added-apis-for-new-order-initiator-key-creation--follower-order-setup") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Endpoints：/api/v2/copy/mix-trader/create-copy-api Additional content： * New version interface for order initiators to create order API keys. Endpoints：/api/v2/copy/mix-follower/copy-settings Additional content： * New version interface for follower order-following setup. \[Apr 02, 2025\] Adjustment of input parameters for estimated interest and loanable amount[​](https://www.bitgetapp.com/api-doc/common/changelog#apr-02-2025-adjustment-of-input-parameters-for-estimated-interest-and-loanable-amount "Direct link to apr-02-2025-adjustment-of-input-parameters-for-estimated-interest-and-loanable-amount") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Endpoints：/api/v2/earn/loan/public/hour-interest, /api/v2/earn/loan/borrow * Additional content： Adjust the input parameter for the daily to `SEVEN`: 7 days `THIRTY`: 30 days `FLEXIBLE`: Flexible \[Mar 27, 2025\] Updates include new fields in futures contract & funding rate interfaces' return values, and adjusted input params for spot transaction details.[​](https://www.bitgetapp.com/api-doc/common/changelog#mar-27-2025-updates-include-new-fields-in-futures-contract--funding-rate-interfaces-return-values-and-adjusted-input-params-for-spot-transaction-details "Direct link to 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[​](https://www.bitgetapp.com/api-doc/common/changelog#mar-22-2025-new-response-fields-in-futures-account-channel "Direct link to 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`[​](https://www.bitgetapp.com/api-doc/common/changelog#mar-202025-for-spot-get-order-information-endpoints-it-is-adjusted-to-only-support-to-get-the-order-data-within-2-hours-when-queried-by-clientoid "Direct link to mar-202025-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.[​](https://www.bitgetapp.com/api-doc/common/changelog#mar-182025-adjust-the-input-parameter-instructions-for-modifying-the-apikey-permissions-of-a-sub-account "Direct link to mar-182025-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.[​](https://www.bitgetapp.com/api-doc/common/changelog#mar-122025-adjustment-to-the-period-input-parameter-for-obtaining-contract-initiative-buying-and-selling-volume-information "Direct link to mar-122025-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` to `1Dutc`. \[Mar 11,2025\] API for new OI position limit information in contracts[​](https://www.bitgetapp.com/api-doc/common/changelog#mar-112025-api-for-new-oi-position-limit-information-in-contracts "Direct link to mar-112025-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.[​](https://www.bitgetapp.com/api-doc/common/changelog#feb-192025-add-a-description-for-instid-in-the-public-channel-for-margin "Direct link to feb-192025-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.[​](https://www.bitgetapp.com/api-doc/common/changelog#feb-182025-add-the-userid-response-field-to-the-broker-sub-account-recharge-records "Direct link to feb-182025-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.[​](https://www.bitgetapp.com/api-doc/common/changelog#feb-072025-add-instructions-for-using-the-classic-account-simulation-environment "Direct link to feb-072025-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:[​](https://www.bitgetapp.com/api-doc/common/changelog#feb-032025-new-addition-to-futures-error-codes "Direct link to feb-032025-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.[​](https://www.bitgetapp.com/api-doc/common/changelog#jan-162025-the-futures-contract-financial-record-has-added-an-enumeration-for-the-futuretaxtype-parameter "Direct link to jan-162025-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[​](https://www.bitgetapp.com/api-doc/common/changelog#jan-152025-bitget-to-adjust-the-calculation-of-usdc-m-perpetual-futures-index-price-from-usd-to-usdc "Direct link to jan-152025-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](https://www.bitget.com/support/articles/12560603820643) \[Dec 24,2024\] The rate limit change on Convert endpoint[​](https://www.bitgetapp.com/api-doc/common/changelog#dec-242024-the-rate-limit-change-on-convert-endpoint "Direct link to dec-242024-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[​](https://www.bitgetapp.com/api-doc/common/changelog#dec-162024-get-spot-transferrecords-endpoint-adjust-parameters "Direct link to dec-162024-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[​](https://www.bitgetapp.com/api-doc/common/changelog#nov-222024-websocket-connection-limit-update "Direct link to nov-222024-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: 1. **Websocket will be forcibly disconnected every 24 hours, please add the reconnection mechanism in your code** 2. 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 3. Websocket server will disconnect the connection if there is no string "ping" received for 2 min 4. The Websocket server accepts up to 10 messages per second. The message includes: * String "ping" * JSON message, such as subscribe, unsubscribe. 5. 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 6. 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[​](https://www.bitgetapp.com/api-doc/common/changelog#oct-172024-the-update-on-calculation-method-for-the-change24h-field-in-the-futrues-and-spot-ticker-interfaces "Direct link to oct-172024-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.[​](https://www.bitgetapp.com/api-doc/common/changelog#sep-242024-the-apis-for-usdt-m-futures-multi-assets-mode-requirements-have-been-launched "Direct link to sep-242024-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[​](https://www.bitgetapp.com/api-doc/common/changelog#aug-282024-get-merchant-advertisement-list-endpoint-adjust-the-maximum-value-of-the-limit-parameter-to-20 "Direct link to aug-282024-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[​](https://www.bitgetapp.com/api-doc/common/changelog#aug-152024-api-rate-limit-adjustment "Direct link to aug-152024-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[​](https://www.bitgetapp.com/api-doc/common/changelog#jul-032024-withdrawal-and-get-deposit-addresses-supports-bitcoin-lightning-network "Direct link to jul-032024-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[​](https://www.bitgetapp.com/api-doc/common/changelog#jun-252024-adjustment-on-get-p2p-merchant-list-interface "Direct link to jun-252024-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[​](https://www.bitgetapp.com/api-doc/common/changelog#mar-152024-adjustment-on-the-time-range-for-get-history-trigger-order "Direct link to mar-152024-adjustment-on-the-time-range-for-get-history-trigger-order") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Endpoint: Get History Trigger Order 1. The interval between `startTime` and `endTime` has been limited to 90 days 2. 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[​](https://www.bitgetapp.com/api-doc/common/changelog#feb-62023-add-newsize-field-in-the-push-parameters-of-spot-order-channel-for-websocket "Direct link to feb-62023-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`and`side=buy`, `newSize` represents the quantity of quote coin, * when `orderType=market`and`side=sell`, `newSize` represents the quantity of base coin. \[Jan 19,2024\] Adjustment on the time range for tax endpoints per request[​](https://www.bitgetapp.com/api-doc/common/changelog#jan-192024-adjustment-on-the-time-range-for-tax-endpoints-per-request "Direct link to jan-192024-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[​](https://www.bitgetapp.com/api-doc/common/changelog#dec-272023-adjustment-for-the-withdrawal-of-brokers-sub-account "Direct link to dec-272023-adjustment-for-the-withdrawal-of-brokers-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[​](https://www.bitgetapp.com/api-doc/common/changelog#nov-162023-add-errorcode-field-in-batch-cancel-orders-response "Direct link to nov-162023-add-errorcode-field-in-batch-cancel-orders-response") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Added a new response parameter, errorCode, to the batch cancel order endpoint. ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback * [September 2, 2025 Add reason field for Get Upgrade Status](https://www.bitgetapp.com/api-doc/common/changelog#september-2-2025-add-reason-field-for-get-upgrade-status) * [August 28, 2025 Notice: Optimization of Push Frequency for Websocket Order Book Channel (books1) in Classic Account (v2)](https://www.bitgetapp.com/api-doc/common/changelog#august-28-2025-notice-optimization-of-push-frequency-for-websocket-order-book-channel-books1--in-classic-account-v2) * [August 11, 2025 Agent commission API query supports fee deduction](https://www.bitgetapp.com/api-doc/common/changelog#august-11-2025-agent-commission-api-query-supports-fee-deduction) * [August 11, 2025 API Global rate Limit Adjustment](https://www.bitgetapp.com/api-doc/common/changelog#august-11-2025-api-global-rate-limit-adjustment) * [August 6, 2025 Add unrealizedPL field for sub-account futures asset info](https://www.bitgetapp.com/api-doc/common/changelog#august-6-2025-add-unrealizedpl-field-for-sub-account-futures-asset-info) * [August 6, 2025 Add marginCoin field for historical transaction details](https://www.bitgetapp.com/api-doc/common/changelog#august-6-2025-add-margincoin-field-for-historical-transaction-details) * [August 4, 2025 Delisting of Futures Demo Pairs](https://www.bitgetapp.com/api-doc/common/changelog#august-4-2025-delisting-of-futures-demo-pairs) * [July 31, 2025 Optimization of the futures order placement interface logic](https://www.bitgetapp.com/api-doc/common/changelog#july-31-2025-optimization-of-the-futures-order-placement-interface-logic) * [July 29, 2025 Optimize ADL API ranking logic.](https://www.bitgetapp.com/api-doc/common/changelog#july-29-2025-optimize-adl-api-ranking-logic) * [July 16, 2025 Add New Account Mode Switching API](https://www.bitgetapp.com/api-doc/common/changelog#july-16-2025-add-new-account-mode-switching-api) * [July 14, 2025 Futures leverage adjustment API supports setting long/short leverage ratios separately.](https://www.bitgetapp.com/api-doc/common/changelog#july-14-2025--futures-leverage-adjustment-api-supports-setting-longshort-leverage-ratios-separately) * [July 14, 2025 Position take-profit/stop-loss API supports setting custom IDs for take-profit and stop-loss orders separately.](https://www.bitgetapp.com/api-doc/common/changelog#july-14-2025--position-take-profitstop-loss-api-supports-setting-custom-ids-for-take-profit-and-stop-loss-orders-separately) * [July 14, 2025 The interface for obtaining the list of historical contract positions has added a position mode field.](https://www.bitgetapp.com/api-doc/common/changelog#july-14-2025--the-interface-for-obtaining-the-list-of-historical-contract-positions-has-added-a-position-mode-field) * [July 8, 2025 WebSocket futures position channel adds mark price parameter](https://www.bitgetapp.com/api-doc/common/changelog#july-8-2025-websocket-futures-position-channel-adds-mark-price-parameter) * [July 1, 2025 WebSocket Adds Order Placement and Cancellation Channels](https://www.bitgetapp.com/api-doc/common/changelog#july-1-2025-websocket-adds-order-placement-and-cancellation-channels) * [Jun 17, 2025Spot merged trading depth, spot trading depth, futures merged depth interfaces: ts field adjustment](https://www.bitgetapp.com/api-doc/common/changelog#jun-17-2025spot-merged-trading-depth-spot-trading-depth-futures-merged-depth-interfaces-ts-field-adjustment) * [Jun 16, 2025 The ADL ranking interface has added the position direction.](https://www.bitgetapp.com/api-doc/common/changelog#jun-16-2025-the-adl-ranking-interface-has-added-the-position-direction) * [June 09, 2025 Get Contract Information Adds Maximum Order Quantity Fields](https://www.bitgetapp.com/api-doc/common/changelog#june-09-2025-get-contract-information-adds-maximum-order-quantity-fields) * [May 19, 2025 Update on Regular Release Date](https://www.bitgetapp.com/api-doc/common/changelog#may-19-2025-update-on-regular-release-date) * [May 19,2025 Adjustment of the Spot place-plan-order API](https://www.bitgetapp.com/api-doc/common/changelog#may-192025-adjustment-of-the-spot-place-plan-order-api) * [May 14, 2025 New version: Order-taking staff API Key creation interface adds currency pair range description.](https://www.bitgetapp.com/api-doc/common/changelog#may-14-2025-new-version-order-taking-staff-api-key-creation-interface-adds-currency-pair-range-description) * [May 09, 2025 Obtain the adjustment of the input parameters for the current funding rate.](https://www.bitgetapp.com/api-doc/common/changelog#may-09-2025-obtain-the-adjustment-of-the-input-parameters-for-the-current-funding-rate) * [May 09, 2025 Optimized the API for retrieving spot assets of sub-accounts.](https://www.bitgetapp.com/api-doc/common/changelog#may-09-2025-optimized-the-api-for-retrieving-spot-assets-of-sub-accounts) * [May 09, 2025 Optimized the API for querying announcements.](https://www.bitgetapp.com/api-doc/common/changelog#may-09-2025-optimized-the-api-for-querying-announcements) * [May 08, 2025 Interface for adding leverage interest rate records](https://www.bitgetapp.com/api-doc/common/changelog#may-08-2025-interface-for-adding-leverage-interest-rate-records) * [May 08, 2025 Optimization of the query range for public transaction details of spot/contract.](https://www.bitgetapp.com/api-doc/common/changelog#may-08-2025-optimization-of-the-query-range-for-public-transaction-details-of-spotcontract) * [May 08, 2025 Add preset stop - profit and stop - loss execution prices for contract orders.](https://www.bitgetapp.com/api-doc/common/changelog#may-08-2025-add-preset-stop---profit-and-stop---loss-execution-prices-for-contract-orders) * [May 08, 2025 Add "utime" to the WebSocket push for cross-margin/isolated-margin leverage order channels.](https://www.bitgetapp.com/api-doc/common/changelog#may-08-2025-add-utime-to-the-websocket-push-for-cross-marginisolated-margin-leverage-order-channels) * [Apr 30,2025 For the trading details of the WS futures, push fields are added to the spot/futures depth channels.](https://www.bitgetapp.com/api-doc/common/changelog#apr-302025-for-the-trading-details-of-the-ws-futures-push-fields-are-added-to-the-spotfutures-depth-channels) * [Apr 23, 2025 Added groupType enumeration for get account bills.](https://www.bitgetapp.com/api-doc/common/changelog#apr-23-2025-added-grouptype-enumeration-for-get-account-bills) * [Apr 21,2025 Delete error code 40882](https://www.bitgetapp.com/api-doc/common/changelog#apr-212025-delete-error-code-40882) * [Apr 14,2025 Add New Endpoint: Get ND Broker Sub-accounts Deposit and Withdrawal Records](https://www.bitgetapp.com/api-doc/common/changelog#apr-142025-add-new-endpoint-get-nd-broker-sub-accounts-deposit-and-withdrawal-records) * [Apr 10,2025 Adjustment to virtual sub-account API key related endpoints](https://www.bitgetapp.com/api-doc/common/changelog#apr-102025-adjustment-to-virtual-sub-account-api-key-related-endpoints) * [Apr 10,2025 Added new field `offTime` in the response of Get Spot Symbol Info interface](https://www.bitgetapp.com/api-doc/common/changelog#apr-102025-added-new-field-offtime-in-the-response-of-get-spot-symbol-info-interface) * [Apr 09, 2025 Added ADL ranking interface.](https://www.bitgetapp.com/api-doc/common/changelog#apr-09-2025-added-adl-ranking-interface) * [Apr 08, 2025 Added APIs for new order initiator key creation & follower order setup.](https://www.bitgetapp.com/api-doc/common/changelog#apr-08-2025-added-apis-for-new-order-initiator-key-creation--follower-order-setup) * [Apr 02, 2025 Adjustment of input parameters for estimated interest and loanable amount](https://www.bitgetapp.com/api-doc/common/changelog#apr-02-2025-adjustment-of-input-parameters-for-estimated-interest-and-loanable-amount) * [Mar 27, 2025 Updates include new fields in futures contract & funding rate interfaces' return values, and adjusted input params for spot transaction details.](https://www.bitgetapp.com/api-doc/common/changelog#mar-27-2025-updates-include-new-fields-in-futures-contract--funding-rate-interfaces-return-values-and-adjusted-input-params-for-spot-transaction-details) * [Mar 22, 2025 New Response Fields in Futures Account Channel](https://www.bitgetapp.com/api-doc/common/changelog#mar-22-2025-new-response-fields-in-futures-account-channel) * [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`](https://www.bitgetapp.com/api-doc/common/changelog#mar-202025-for-spot-get-order-information-endpoints-it-is-adjusted-to-only-support-to-get-the-order-data-within-2-hours-when-queried-by-clientoid) * [Mar 18,2025 Adjust the input parameter instructions for modifying the ApiKey permissions of a sub-account.](https://www.bitgetapp.com/api-doc/common/changelog#mar-182025-adjust-the-input-parameter-instructions-for-modifying-the-apikey-permissions-of-a-sub-account) * [Mar 12,2025 Adjustment to the period input parameter for obtaining contract initiative buying and selling volume information.](https://www.bitgetapp.com/api-doc/common/changelog#mar-122025-adjustment-to-the-period-input-parameter-for-obtaining-contract-initiative-buying-and-selling-volume-information) * [Mar 11,2025 API for new OI position limit information in contracts](https://www.bitgetapp.com/api-doc/common/changelog#mar-112025-api-for-new-oi-position-limit-information-in-contracts) * [Feb 19,2025 Add a description for instId in the public channel for Margin.](https://www.bitgetapp.com/api-doc/common/changelog#feb-192025-add-a-description-for-instid-in-the-public-channel-for-margin) * [Feb 18,2025 Add the userId response field to the broker sub-account recharge records.](https://www.bitgetapp.com/api-doc/common/changelog#feb-182025-add-the-userid-response-field-to-the-broker-sub-account-recharge-records) * [Feb 07,2025 Add instructions for using the classic account simulation environment.](https://www.bitgetapp.com/api-doc/common/changelog#feb-072025-add-instructions-for-using-the-classic-account-simulation-environment) * [Feb 03,2025 New addition to futures error codes:](https://www.bitgetapp.com/api-doc/common/changelog#feb-032025-new-addition-to-futures-error-codes) * [Jan 16,2025 The futures contract financial record has added an enumeration for the futureTaxType parameter.](https://www.bitgetapp.com/api-doc/common/changelog#jan-162025-the-futures-contract-financial-record-has-added-an-enumeration-for-the-futuretaxtype-parameter) * [Jan 15,2025 Bitget to adjust the calculation of USDC-M perpetual futures index price from USD to USDC](https://www.bitgetapp.com/api-doc/common/changelog#jan-152025-bitget-to-adjust-the-calculation-of-usdc-m-perpetual-futures-index-price-from-usd-to-usdc) * [Dec 24,2024 The rate limit change on Convert endpoint](https://www.bitgetapp.com/api-doc/common/changelog#dec-242024-the-rate-limit-change-on-convert-endpoint) * [Dec 16,2024 Get Spot TransferRecords endpoint adjust parameters](https://www.bitgetapp.com/api-doc/common/changelog#dec-162024-get-spot-transferrecords-endpoint-adjust-parameters) * [Nov 22,2024 Websocket connection limit update](https://www.bitgetapp.com/api-doc/common/changelog#nov-222024-websocket-connection-limit-update) * [Oct 17,2024 The update on calculation method for the `change24h` field in the Futrues and SPOT ticker interfaces](https://www.bitgetapp.com/api-doc/common/changelog#oct-172024-the-update-on-calculation-method-for-the-change24h-field-in-the-futrues-and-spot-ticker-interfaces) * [Sep 24,2024 The APIs for USDT-M Futures Multi-assets Mode requirements have been launched.](https://www.bitgetapp.com/api-doc/common/changelog#sep-242024-the-apis-for-usdt-m-futures-multi-assets-mode-requirements-have-been-launched) * [Aug 28,2024 Get Merchant Advertisement List endpoint Adjust the maximum value of the 'limit' parameter to 20](https://www.bitgetapp.com/api-doc/common/changelog#aug-282024-get-merchant-advertisement-list-endpoint-adjust-the-maximum-value-of-the-limit-parameter-to-20) * [Aug 15,2024 API rate limit adjustment](https://www.bitgetapp.com/api-doc/common/changelog#aug-152024-api-rate-limit-adjustment) * [Jul 03,2024 Withdrawal and get deposit addresses supports Bitcoin Lightning Network](https://www.bitgetapp.com/api-doc/common/changelog#jul-032024-withdrawal-and-get-deposit-addresses-supports-bitcoin-lightning-network) * [Jun 25,2024 Adjustment on Get P2P Merchant List Interface](https://www.bitgetapp.com/api-doc/common/changelog#jun-252024-adjustment-on-get-p2p-merchant-list-interface) * [Mar 15,2024 Adjustment on the time range for Get History Trigger Order](https://www.bitgetapp.com/api-doc/common/changelog#mar-152024-adjustment-on-the-time-range-for-get-history-trigger-order) * [Feb 6,2023 Add `newSize` field in the push parameters of Spot Order Channel for Websocket](https://www.bitgetapp.com/api-doc/common/changelog#feb-62023-add-newsize-field-in-the-push-parameters-of-spot-order-channel-for-websocket) * [Jan 19,2024 Adjustment on the time range for tax endpoints per request](https://www.bitgetapp.com/api-doc/common/changelog#jan-192024-adjustment-on-the-time-range-for-tax-endpoints-per-request) * [Dec 27,2023 Adjustment for the withdrawal of Broker's sub-account](https://www.bitgetapp.com/api-doc/common/changelog#dec-272023-adjustment-for-the-withdrawal-of-brokers-sub-account) * [Nov 16,2023 Add 'errorCode' field in batch-cancel-orders response](https://www.bitgetapp.com/api-doc/common/changelog#nov-162023-add-errorcode-field-in-batch-cancel-orders-response) --- # Signature | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/common/signature#__docusaurus_skipToContent_fallback) On this page Signature ========= API Verification[​](https://www.bitgetapp.com/api-doc/common/signature#api-verification "Direct link to API Verification") --------------------------------------------------------------------------------------------------------------------------- ### Initiate a request[​](https://www.bitgetapp.com/api-doc/common/signature#initiate-a-request "Direct link to Initiate a request") The header of all REST requests must contain the following http headers： * ACCESS-KEY：API KEY as a string * ACCESS-SIGN：Sign with base64 encoding (see [HMAC](https://www.bitgetapp.com/api-doc/common/signature-samaple/hmac) and [RSA](https://www.bitgetapp.com/api-doc/common/signature-samaple/rsa) sample code). * ACCESS-TIMESTAMP：Timestamp of your request. Value equals to milliseconds since Epoch. * ACCESS-PASSPHRASE：The password you set when created the API KEY. * Content-Type：Please set to application/json for all POST request * locale: Support language such as: Chinese (zh-CN), English (en-US) ### How to get ACCESS-TIMESTAMP[​](https://www.bitgetapp.com/api-doc/common/signature#how-to-get-access-timestamp "Direct link to How to get ACCESS-TIMESTAMP") * Java * Python * Go * JS * PHP Long timestamp = System.currentTimeMillis(); import time time.time\_ns() / 1000000 import ( "time" ) int64(time.Now().UnixNano()/1000000) Math.round(new Date()) microtime(true) \* 1000; Generate Signature[​](https://www.bitgetapp.com/api-doc/common/signature#generate-signature "Direct link to Generate Signature") --------------------------------------------------------------------------------------------------------------------------------- The request header of ACCESS-SIGN is to encrypt **timestamp + method.toUpperCase() + requestPath + "?" + queryString + body** string (+ means string concat) by **HMAC SHA256** algorithm with **secretKey**. and encode the encrypted result through **BASE64**. ### Description of each parameter in the signature[​](https://www.bitgetapp.com/api-doc/common/signature#description-of-each-parameter-in-the-signature "Direct link to Description of each parameter in the signature") * timestamp：Same as ACCESS-TIMESTAMP request header. Value equals to milliseconds since Epoch. * method：Request method (POST/GET), all uppercase. * requestPath：Request interface path. * queryString：The query string in the request URL (the request parameter after the ?). * body：The request body in string format. If the request body is empty (usually a GET request), the body can be omitted. **If the queryString is empty, signature content** `timestamp + method.toUpperCase() + requestPath + body` **If the queryString not empty, signature content** `timestamp + method.toUpperCase() + requestPath + "?" + queryString + body` ### Sample Code[​](https://www.bitgetapp.com/api-doc/common/signature#sample-code "Direct link to Sample Code") Get contract depth information, let's take BTCUSDT as an example: * timestamp = 16273667805456 * method = "GET" * requestPath = "/api/mix/v2/market/depth" * queryString= "?limit=20&symbol=BTCUSDT" Generate the content to be signed: `16273667805456GET/api/mix/v2/market/depth?limit=20&symbol=BTCUSDT` Contract order, take BTCUSDT as an example: * timestamp = 16273667805456 * method = "POST" * requestPath = "/api/v2/mix/order/place-order" * body = {"productType":"usdt-futures","symbol":"BTCUSDT","size":"8","marginMode":"crossed","side":"buy","orderType":"limit","clientOid":"channel#123456"} Generate the content to be signed: `16273667805456POST/api/v2/mix/order/place-order{"productType":"usdt-futures","symbol":"BTCUSDT","size":"8","marginMode":"crossed","side":"buy","orderType":"limit","clientOid":"channel#123456"}` ### Steps to generate the final signature[​](https://www.bitgetapp.com/api-doc/common/signature#steps-to-generate-the-final-signature "Direct link to Steps to generate the final signature") **_HMAC_** * [HMAC sample code](https://www.bitgetapp.com/api-doc/common/signature-samaple/hmac) Step 1. Use the private key \*\*secretkey\*\* to encrypt the string to be signed with hmac sha256 String payload = hmac_sha256(secretkey, Message); Step 2. Base64 encoding for Signature. String signature = base64.encode(payload); **_RSA_** * [RSA sample code](https://www.bitgetapp.com/api-doc/common/signature-samaple/rsa) Step 1. Use the RSA privateKey **privateKey** to encrypt the string to be signed with SHA-256 Step 2. Base64 encoding for Signature. ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback * [API Verification](https://www.bitgetapp.com/api-doc/common/signature#api-verification) * [Initiate a request](https://www.bitgetapp.com/api-doc/common/signature#initiate-a-request) * [How to get ACCESS-TIMESTAMP](https://www.bitgetapp.com/api-doc/common/signature#how-to-get-access-timestamp) * [Generate Signature](https://www.bitgetapp.com/api-doc/common/signature#generate-signature) * [Description of each parameter in the signature](https://www.bitgetapp.com/api-doc/common/signature#description-of-each-parameter-in-the-signature) * [Sample Code](https://www.bitgetapp.com/api-doc/common/signature#sample-code) * [Steps to generate the final signature](https://www.bitgetapp.com/api-doc/common/signature#steps-to-generate-the-final-signature) --- # Websocket API | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/common/websocket-intro#__docusaurus_skipToContent_fallback) On this page Websocket API ============= ### Overview[​](https://www.bitgetapp.com/api-doc/common/websocket-intro#overview "Direct link to Overview") WebSocket is a new HTML5 protocol that achieves full-duplex data transmission between the client and server, allowing data to be transferred effectively in both directions. A connection between the client and server can be established with just one handshake. The server will then be able to push data to the client according to preset rules. Its advantages include: * The WebSocket request header size for data transmission between client and server is only 2 bytes. * Either the client or server can initiate data transmission. * There's no need to repeatedly create and delete TCP connections, saving resources on bandwidth and server. It is strongly recommended that developers use WebSocket API to obtain market information and transaction depth. | Domain | WebSocket API | Recommended to use | | --- | --- | --- | | Websocket Domain | wss://ws.bitget.com/v2/ws/public | Main Domain, Public channel | | Websocket Domain | wss://ws.bitget.com/v2/ws/private | Main Domain, Private channel | ### Connect[​](https://www.bitgetapp.com/api-doc/common/websocket-intro#connect "Direct link to Connect") **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: 1. **Websocket will be forcibly disconnected every 24 hours, please add the reconnection mechanism in your code** 2. 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 3. Websocket server will disconnect the connection if there is no string "ping" received for 2 min 4. The Websocket server accepts up to 10 messages per second. The message includes: * String "ping" * JSON message, such as subscribe, unsubscribe. 5. 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 6. We highly recommend you to subscribe **less than 50 channels in one connection**. The connections with less channel subscriptions will be more stable. ### Login[​](https://www.bitgetapp.com/api-doc/common/websocket-intro#login "Direct link to Login") **apiKey**: Unique identification for invoking API. Requires user to [apply](javascript:;) one manually. **passphrase**: APIKey password **timestamp**: Unix timestamp in milliseconds, which will expire in 30 seconds. **secretKey**: The security key generated when the user applies for APIKey, e.g. : 22582BD0CFF14C41EDBF1AB98506286D Example of timestamp const timestamp ='' + Date.now() "Sign sign=CryptoJS.enc.Base64.Stringify(CryptoJS.HmacSHA256(timestamp +'GET'+'/user/verify', secretKey)) **method**: always 'GET'. **requestPath** : always '/user/verify' **sign**: signature string, the signature algorithm is as follows: First concatenate `timestamp`, `method`, `requestPath`, then use HMAC SHA256 method to encrypt the concatenated string with SecretKey, and then perform Base64 encoding. The request will expire 30 seconds after the timestamp. If your server time differs from the API server time, we recommended using the REST API to query the [API server time](https://www.bitgetapp.com/api-doc/common/public/Get-Server-Time) and then compare the timestamp. #### Steps to generate the final signature[​](https://www.bitgetapp.com/api-doc/common/websocket-intro#steps-to-generate-the-final-signature "Direct link to Steps to generate the final signature") **_HMAC_** Step 1. concat the content Long timestamp = System.currentTimeMillis() / 1000; String content = timestamp +"GET"+"/user/verify"; Step 1. Use the private key secretkey to encrypt the string to be signed with hmac sha256 String hash = hmac_sha256(content, secretkey); The final step is to base64 encode the hash String sign = base64.encode(hash); **_RSA_** * [RSA sample code](https://www.bitgetapp.com/api-doc/common/signature-samaple/rsa) Step 1. Use the RSA privateKey **privateKey** to encrypt the string to be signed with SHA-256 Step 2. Base64 encoding for Signature. If login fails, it will automatically disconnect Request Format Description { "op":"login", "args":[ { "apiKey":"", "passphrase":"", "timestamp":"", "sign":"" } ]} Request Example { "op":"login", "args":[ { "apiKey":"xx_xxx", "passphrase":"xxx", "timestamp":"1538054050", "sign":"8RCOqCJAhhEh4PWcZB/96QojLDqMAg4qNynIixFzS3E=" } ]} Successful Response Example { "event":"login", "code":"0", "msg":""} Failure Response Example { "event":"error", "code":"30005", "msg":"error"} ### Subscribe[​](https://www.bitgetapp.com/api-doc/common/websocket-intro#subscribe "Direct link to Subscribe") **Subscription Instructions** Request Format Description { "op": "subscribe", "args": [""]} `instId`: should be either `symbol` or `default` Users can choose to subscribe to one or more channels, and the total length of multiple channels cannot exceed 4096 bytes at a time. Request Example { "op":"subscribe", "args":[ { "instType":"SPOT", "channel":"ticker", "instId":"BTCUSDT" }, { "instType":"SPOT", "channel":"candle5m", "instId":"BTCUSDT" } ]} **Request Parameters** | Parameter | Type | Required | Description | | --- | --- | --- | --- | | op | String | Yes | Operation, `subscribe` | | args | Array | Yes | List of subscribe channels | | \> instType | String | No | Instrument Type | | \> channel | String | Yes | Channel name | | \> instId | String | No | Instrument ID | Example Response { "event": "subscribe", "arg": { "instType":"SPOT", "channel":"ticker", "instId":"BTCUSDT" }} **Return Parameters** | Parameter | Type | Required | Description | | --- | --- | --- | --- | | event | String | Yes | Event, subscribe error | | arg | Object | No | Subscribed channel | | \> instType | String | No | Instrument Type MC：Perpetual contract public channel | | \> channel | String | Yes | Channel name | | \> instId | String | No | Instrument ID | | code | String | No | Error code | | msg | String | No | Error message | ### Unsubscribe[​](https://www.bitgetapp.com/api-doc/common/websocket-intro#unsubscribe "Direct link to Unsubscribe") Unsubscribe from one or more channels. Request Format Description { "op": "unsubscribe", "args": ["< SubscriptionTopic>"]} Request Example { "op":"unsubscribe", "args":[ { "instType":"SPOT", "channel":"ticker", "instId":"BTCUSDT" }, { "instType":"SPOT", "channel":"candle1m", "instId":"BTCUSDT" } ]} **Request Parameters** | Parameter | Type | Required | Description | | --- | --- | --- | --- | | op | String | Yes | Operation, unsubscribe | | args | Array | Yes | List of channels to unsubscribe from | | \> instType | String | Yes | Instrument Type MC：Perpetual contract public channel | | \> channel | String | Yes | Channel name | | \> instId | String | Yes | Instrument ID | Example Response { "op":"unsubscribe", "args":[ { "instType":"USDT-FUTURES", "channel":"ticker", "instId":"BTCUSDT" }, { "instType":"USDT-FUTURES", "channel":"candle1m", "instId":"BTCUSDT" } ]} **Return Parameters** | Parameter | Type | Required | Description | | --- | --- | --- | --- | | event | String | Yes | Event, unsubscribe error | | arg | Object | Yes | Unsubscribed channel | | \> instType | String | Yes | Instrument Type | | \> channel | String | Yes | Channel name | | \> instId | String | Yes | Instrument ID | | code | String | No | Error Code | | msg | String | No | Error Message | ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback * [Overview](https://www.bitgetapp.com/api-doc/common/websocket-intro#overview) * [Connect](https://www.bitgetapp.com/api-doc/common/websocket-intro#connect) * [Login](https://www.bitgetapp.com/api-doc/common/websocket-intro#login) * [Subscribe](https://www.bitgetapp.com/api-doc/common/websocket-intro#subscribe) * [Unsubscribe](https://www.bitgetapp.com/api-doc/common/websocket-intro#unsubscribe) --- # Unified Trading Account | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/uta/intro#__docusaurus_skipToContent_fallback) On this page Unified Trading Account ======================= The unified account is a next-generation trading system introduced by Bitget, designed to allow users to trade spot and various derivatives using multiple crypto assets within a single account. This system simplifies the trading process by eliminating the need for fund transfers between different accounts. Moreover, profits and losses across different products can be calculated and offset together, enhancing capital efficiency. Comparison of Account Modes[​](https://www.bitgetapp.com/api-doc/uta/intro#comparison-of-account-modes "Direct link to Comparison of Account Modes") ----------------------------------------------------------------------------------------------------------------------------------------------------- The unified account offers three new account modes to meet diverse trading preferences and needs: **single-asset margin** (coming soon), **multi-assets margin**, and **portfolio margin** (coming soon). Details are as follows, | Account Mode | Features | Eligibility | | --- | --- | --- | | Single-asset margin (coming soon) | Supported trading types
_Spot trading_
_Margin trading_
_USDT perpetual futures_
_USDC perpetual futures_
_Coin-M perpetual futures_
_Coin-M delivery futures_

In single-asset cross margin mode, all trading types with the same settlement currency share the margin, and profits and losses across different products can be calculated and offset together. | All registered users. This is the default account mode. | | Multi-assets margin (available now) | Supported trading types
_Spot trading_
_Margin trading_
_USDT perpetual futures_
_USDC perpetual futures_
_Coin-M perpetual futures_(coming soon)
In multi-assets cross margin mode, all trading types share the margin, and profits and losses across different products can be calculated and offset together. | Trading account equity needs to be at least $10,000 and users must complete the quiz to activate the mode. | | Portfolio margin (coming soon) | Supported trading types
_Spot trading_
_Margin trading_
_USDT perpetual futures_
_USDC perpetual futures_
_Coin-M perpetual futures_
_Coin-M delivery futures_
In portfolio margin mode, all trading types share the margin, and margins for all derivatives with the same index can be calculated together. Profits and losses across different products can also be calculated and offset. | Trading account equity needs to be at least $10,000 and users must complete the quiz to activate the mode. | Asset-related Terminology[​](https://www.bitgetapp.com/api-doc/uta/intro#asset-related-terminology "Direct link to Asset-related Terminology") ----------------------------------------------------------------------------------------------------------------------------------------------- | Term | Explanation | | --- | --- | | Equity | The total equity of a specific coin in the cross margin account.
_Coin equity = Balance + Frozen margin + unrealized PnL_ | | Balance | The balance of a specific coin in the account. | | Available | The current available balance of a specific coin in the account for opening positions.
_Available = Balance + unrealized PnL_
Note: Realized PnL in the available balance can be used for opening futures positions but cannot be used to place spot orders. | | UnrealisedPnL | The total profits of all futures positions settled in a specific coin in the account.
_Unrealized profits = Profits of USDT-M perpetual futures positions in cross margin mode + profits of USDC-M perpetual futures positions in cross margin mode + profits of coin-M perpetual futures positions in cross margin mode_ | | Debt | Debt = ABS(min(balance + unrealized PnL, 0)) | | Account equity | The net value of all coin assets in the account converted into fiat currency.
_Account equity = sum (coin equity × coin in USD price)_ | | Maintenance margin | The total maintenance margin of all cross margin positions in the account.
_Maintenance margin = Sum\[quantity of coin in cross margin positions × coin price\]_
_Maintenance margin = Position value × maintenance margin rate_ | | Margin rate | A risk measurement indicator for cross margin accounts.
_Cross margin account's margin ratio = (maintenance margin + partial liquidation transaction fees)÷Account equity_.
Both maintenance margin and partial liquidation transaction fees are calculated by adding the position size and the open order size. | Improved Readability[​](https://www.bitgetapp.com/api-doc/uta/intro#improved-readability "Direct link to Improved Readability") -------------------------------------------------------------------------------------------------------------------------------- The Open API documentation has been revised and proofread, with unclear descriptions from previous versions clarified to reduce customer confusion. ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback * [Comparison of Account Modes](https://www.bitgetapp.com/api-doc/uta/intro#comparison-of-account-modes) * [Asset-related Terminology](https://www.bitgetapp.com/api-doc/uta/intro#asset-related-terminology) * [Improved Readability](https://www.bitgetapp.com/api-doc/uta/intro#improved-readability) --- # FAQ | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/common/faq#__docusaurus_skipToContent_fallback) FAQ === * Q1： How to get API support? A : Join our official API support group and our admins will answer your questions. [https://t.me/bitgetOpenapi](https://t.me/bitgetOpenapi) * Q2: Order parameter `symbol` What should I pass? For example, BTCUSDT\_UMCBL or BTCUSDT ? A : `BTCUSDT` in 'v2' API, `BTCUSDT_UMCBL` in 'v1' API * Q3 : What does the WebSocket parameter `instId` pass? For example, BTCUSDT\_UMCBL or BTCUSDT ? A : `BTCUSDT` or `default`; Please refer to the `symbol` value from [Get Contract Config](https://www.bitgetapp.com/api-doc/contract/market/Get-All-Symbols-Contracts) * Q4： Deposit Demo Coins in Demo Trading ? * A :First please enter the official site for demo trading On the right side under your Asset section, click the deposit buttun below it. Notice:You can only claim again 72 hour(s) after your last claim. * Q5： What are the differences of Trader's minimum open count from normal users ? * A : Future Trader's minimum open count Please refer to the response param minOpenCount of this endpoint [Get Copy Trade Symbol Settings](https://www.bitgetapp.com/api-doc/copytrading/future-copytrade/trader/Trader-Get-Config-Query-Symbols) Spot Trader's minimum open count Please refer to the response param minOpenCount of this endpoint [Get Copytrade Configuration](https://www.bitgetapp.com/api-doc/copytrading/spot-copytrade/trader/Config-Query-Settings) . * Q6： How to get future's maximum order numbers and position numbers ? * A : Please refer to the response params maxProductOrderNum maxPositionNum of this endpoint [Get Contract Config](https://www.bitgetapp.com/api-doc/contract/market/Get-All-Symbols-Contracts) . * Q7： How to know that you are a trader ？ * A : Please refer to the response param traderType of this endpoint GET /api/v2/spot/account/info.[Get Account Information](https://www.bitgetapp.com/api-doc/spot/account/Get-Account-Info) * Q8: I am using a third party server/codes and it is not working. How can I get help? * A: Unfortunately, we do not provide troubleshooting support for third party servers or tools, please contact the third party customer service for further assistance. In addition, providing your API keys/keys to any other platform will have portential security risk, and it is up to you to decide whether to use their services. Please note that we do not provide coding related help. * Q9: If I forget the passphrase of API key, What should I do? * A: The passphrase of API Key can not be modified, please recreate your API Key. * Q10: What is the rate limit of API? * A: 1. The rate limit of each API endpoint is marked on the doc page;2. The rate limit of each API interface is calculated independently;3. The overall rate limit is 6000/IP/Min,After the rate limit is triggered, it takes 5 minutes to recover. * Q11: How can I find out the remaining rate limit per second for the API? A: Please refer to the `x-mbx-used-remain-limit` parameter in the response header. * Q12: Is there any currency with a different name in the spot market and the future market? * A: Yes, currently there are three currencies with this situation. 1.Luna2(Future) — Luna(Spot) 2.ALT(Future) — $ALT(Spot) 3.MEME(Future) — MEMECOIN(Spot) * Q13: Which characters are supported for clientOid? * A: clientOid supports \[0-9\], \[a-z\],\[A-Z\] and \[-,+,\_,#\], length less than 50 * Q14: Is there a fixed regular release data for backend? * A: Yes.The current fixed regular release date for backend is **every Tuesday, Wednesday, and Thursday from 14:00 PM to 17:00 PM (UTC +8)**(Except for emergency upgrade). During the regular release time window, the RestAPI may return 45001, 40725, 40808 or 40015 error responses. Users can retry after receiving these error responses. WebSocket connections may be disconnected during the release period. WebSocket users are advised to implement a reconnection mechanism in their code. ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback --- # 合约交易API | Bitget API [跳到主要内容](https://www.bitgetapp.com/zh-CN/api-doc/contract/intro#__docusaurus_skipToContent_fallback) 合约交易API ======= 本Tab介绍合约相关的API，详细功能请参考左边的功能菜单 这里重点介绍'产品类型': productType的用法 * USDT-FUTURES U本位合约（以USDT结算的合约） * COIN-FUTURES 币本位合约（以加密货币结算的合约） * USDC-FUTURES USDC合约（以USDC结算的合约） 在REST API中，参数productType的取值参考值如上 Websocket中，instType的取值参考值同上 ### 您的阅读体验如何？ ★ ★ ★ ★ ★ 反馈建议 --- # VIP Fee Rate | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/contract/market/Get-VIP-Fee-Rate#__docusaurus_skipToContent_fallback) VIP Fee Rate ============ Rate limit:10 req/sec/IP ### Description[​](https://www.bitgetapp.com/api-doc/contract/market/Get-VIP-Fee-Rate#description "Direct link to Description") Get VIP fee rate ### HTTP Request[​](https://www.bitgetapp.com/api-doc/contract/market/Get-VIP-Fee-Rate#http-request "Direct link to HTTP Request") * GET /api/v2/mix/market/vip-fee-rate Request Example curl "https://api.bitget.com/api/v2/mix/market/vip-fee-rate" ### Request Parameters[​](https://www.bitgetapp.com/api-doc/contract/market/Get-VIP-Fee-Rate#request-parameters "Direct link to Request Parameters") N/A Response Example { "code": "00000", "msg": "success", "requestTime": 1695794449789, "data": [ { "level": "1", "dealAmount": "100000", "assetAmount": "50000", "takerFeeRate": "0.0006", "makerFeeRate": "0.0004", "btcWithdrawAmount": "300", "usdtWithdrawAmount": "5000000" }, { "level": "2", "dealAmount": "200000", "assetAmount": "500000", "takerFeeRate": "0.0006", "makerFeeRate": "0.0004", "btcWithdrawAmount": "300", "usdtWithdrawAmount": "5000000" } ]} ### Response Parameters[​](https://www.bitgetapp.com/api-doc/contract/market/Get-VIP-Fee-Rate#response-parameters "Direct link to Response Parameters") | Parameter | Type | Description | | --- | --- | --- | | \> level | String | VIP level | | \> dealAmount | String | Total trading volume of the last 30 days, USDT | | \> assetAmount | String | Total assets, USDT | | \> takerFeeRate | String | Taker rate, '0.000425' means 4.25 with four decimal places ahead | | \> makerFeeRate | String | Maker rate, '0.00006' means 0.6 with four decimal places ahead | | \> btcWithdrawAmount | String | 24-hour withdrawal limit (BTC) | | \> usdtWithdrawAmount | String | 24-hour withdrawal limit (USDT) | ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback --- # Get Coin Info | Bitget API [Skip to main content](https://www.bitgetapp.com/api-doc/spot/market/Get-Coin-List#__docusaurus_skipToContent_fallback) Get Coin Info ============= Frequency limit: 3 times/1s (IP) ### Description[​](https://www.bitgetapp.com/api-doc/spot/market/Get-Coin-List#description "Direct link to Description") Get spot coin information,supporting both individual and full queries. ### HTTP Request[​](https://www.bitgetapp.com/api-doc/spot/market/Get-Coin-List#http-request "Direct link to HTTP Request") * GET /api/v2/spot/public/coins Request Example curl "https://api.bitget.com/api/v2/spot/public/coins" ### Request Parameters[​](https://www.bitgetapp.com/api-doc/spot/market/Get-Coin-List#request-parameters "Direct link to Request Parameters") | Parameter | Type | Required | Description | | --- | --- | --- | --- | | coin | String | No | Coin name, If the field is left blank, all coin information will be returned by default | Response Example { "code": "00000", "msg": "success", "requestTime": 1695799900330, "data": [ { "coinId": "1", "coin": "BTC", "transfer": "true", "chains": [ { "chain": "BTC", "needTag": "false", "withdrawable": "true", "rechargeable": "true", "withdrawFee": "0.005", "extraWithdrawFee": "0", "depositConfirm": "1", "withdrawConfirm": "1", "minDepositAmount": "0.001", "minWithdrawAmount": "0.001", "browserUrl": "https://blockchair.com/bitcoin/testnet/transaction/", "contractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7", "withdrawStep": "0", "withdrawMinScale": "8", "congestion":"normal" } ] } ]} ### Response Parameters[​](https://www.bitgetapp.com/api-doc/spot/market/Get-Coin-List#response-parameters "Direct link to Response Parameters") | Parameter | Type | Description | | --- | --- | --- | | coinId | String | Currency ID | | coin | String | Token name | | transfer | Boolean | Transferability | | chains | Array | Support chain list | | \> chain | String | Chain name | | \> needTag | Boolean | Need tag | | \> withdrawable | Boolean | Withdrawal supported
(The withdrawal status is subject to the official announcement) | | \> rechargeable | Boolean | Deposit supported | | \> withdrawFee | String | Withdrawal transaction fee | | \> extraWithdrawFee | String | Extra charge. On chain destruction: `0.1` means `10%` | | \> depositConfirm | String | Deposit confirmation blocks | | \> withdrawConfirm | String | Withdrawal confirmation blocks | | \> minDepositAmount | String | Minimum deposit amount | | \> minWithdrawAmount | String | Minimum withdrawal amount | | \> browserUrl | String | Blockchain explorer address | | \> contractAddress | String | coin contract address | | \> withdrawStep | String | withdrawal count step
If the value is not 0, it indicates that the withdraswl size should be multiple of the value.
if it's 0, that means there is no the limit above. | | \> withdrawMinScale | String | Decimal places of withdrawal amount | | \> congestion | String | chain network status
`normal`: normal
`congested`: congestion | ### How was your Reading Experience with us? ★ ★ ★ ★ ★ Feedback --- # 现货交易API | Bitget API [跳到主要内容](https://www.bitgetapp.com/zh-CN/api-doc/spot/intro#__docusaurus_skipToContent_fallback) 本页总览 现货交易API ======= 本小节介绍了现货的API相关文档，详情请参考左侧目录 更新关注[​](https://www.bitgetapp.com/zh-CN/api-doc/spot/intro#%E6%9B%B4%E6%96%B0%E5%85%B3%E6%B3%A8 "更新关注的直接链接") ------------------------------------------------------------------------------------------------------------- 关于API新增、更新、下线等信息Bitget会提前发布公告进行通知，建议您关注和订阅我们的公告，及时获取相关信息。 您可以点击 [最新公告](javascript:;) 订阅公告。 此外，此处也提供了API获取 [通知](https://www.bitgetapp.com/zh-CN/api-doc/common/notice/Get-All-Notices) 。 联系我们[​](https://www.bitgetapp.com/zh-CN/api-doc/spot/intro#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC "联系我们的直接链接") ------------------------------------------------------------------------------------------------------------- 使用过程中如有问题或者建议，您可选择以下方式联系我们： * [Telegram](https://t.me/bitgetOpenapi) ### 您的阅读体验如何？ ★ ★ ★ ★ ★ 反馈建议 * [更新关注](https://www.bitgetapp.com/zh-CN/api-doc/spot/intro#%E6%9B%B4%E6%96%B0%E5%85%B3%E6%B3%A8) * [联系我们](https://www.bitgetapp.com/zh-CN/api-doc/spot/intro#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC) ---