Bitget Open API V3 SDK

To initialize the SDK, create a BitgetRestClient bean using ClientParameter. You must provide your apiKey, secretKey, passphrase, and baseUrl.

If your API key uses RSA, you must set the signType to SignTypeEnum.RSA and provide your RSA private key in the secretKey field.

@Configuration
@EnableAsync
public class SdkConfig {

  private final String apiKey = "your apiKey";
  private final String secretKey = "your secretKey";
  private final String passphrase = "your passphrase";
  private final String baseUrl = "https://api.bitget.com";

  @Bean
  public BitgetRestClient bitgetRestClient() throws Exception {
    ClientParameter parameter = ClientParameter.builder()
            .apiKey(apiKey)
            .secretKey(secretKey) // If RSA type, set RSA private key here
            .passphrase(passphrase)
            .baseUrl(baseUrl)
            //.signType(SignTypeEnum.RSA) // Uncomment if your apikey is RSA type
            .locale(SupportedLocaleEnum.ZH_CN.getName()).build();
    return BitgetRestClient.builder().configuration(parameter).build();
  }
}

The RestAPI allows you to place orders and query market information. You can use specialized API classes (like OrderApi) or the base BitgetApi class to send direct POST or GET requests.

Common Patterns

• Placing an order via specialized API: Use OrderApi(apiKey, secretKey, passphrase).placeOrder(params).
• Placing an order via direct POST: Use BitgetApi(apiKey, secretKey, passphrase).post(url, params).
• Querying market data via GET: Use BitgetApi(apiKey, secretKey, passphrase).get(url, params).

All RestAPI calls should be wrapped in a try-except block catching BitgetAPIException to handle errors.

import bitget.v1.mix.order_api as maxOrderApi
import bitget.bitget_api as baseApi
from bitget.exceptions import BitgetAPIException

if __name__ == '__main__':
    apiKey = ""
    secretKey = ""
    passphrase = ""

    # Demo 1: place order
    maxOrderApi = maxOrderApi.OrderApi(apiKey, secretKey, passphrase)
    try:
        params = {
            "symbol": "BTCUSDT_UMCBL",
            "marginCoin": "USDT",
            "side": "open_long",
            "orderType": "limit",
            "price": "27012",
            "size": "0.01",
            "timInForceValue": "normal"
        }
        response = maxOrderApi.placeOrder(params)
        print(response)
    except BitgetAPIException as e:
        print("error:" + e.message)

    # Demo 2: place order by post directly
    baseApi = baseApi.BitgetApi(apiKey, secretKey, passphrase)
    try:
        params = {
            "symbol": "BTCUSDT_UMCBL",
            "marginCoin": "USDT",
            "side": "open_long",
            "orderType": "limit",
            "price": "27012",
            "size": "0.01",
            "timInForceValue": "normal"
        }
        response = baseApi.post("/api/mix/v1/order/placeOrder", params)
        print(response)
    except BitgetAPIException as e:
        print("error:" + e.message)

    # Demo 3: send get request
    try:
        params = {"productType": "umcbl"}
        response = baseApi.get("/api/mix/v1/market/contracts", params)
        print(response)
    except BitgetAPIException as e:
        print("error:" + e.message)

    # Demo 4: send get request with no params
    try:
        response = baseApi.get("/api/spot/v1/account/getInfo", {})
        print(response)
    except BitgetAPIException as e:
        print("error:" + e.message)

The RestAPI allows you to place orders and fetch market or account data. You can use specialized API classes (like OrderApi) or the base BitgetApi class to make direct POST or GET requests.

Important for RSA users: If your API key is of the RSA type, you must manually set the signature type to RSA in the constans.py file by setting SIGN_TYPE = RSA.

import bitget.v1.mix.order_api as maxOrderApi
import bitget.bitget_api as baseApi
from bitget.exceptions import BitgetAPIException

if __name__ == '__main__':
    apiKey = ""
    secretKey = '''your'''
    passphrase = ""

    # Demo 1: Place an order using a specialized API class
    maxOrderApi = maxOrderApi.OrderApi(apiKey, secretKey, passphrase)
    try:
        params = {
            "symbol": "BTCUSDT_UMCBL",
            "marginCoin": "USDT",
            "side": "open_long",
            "orderType": "limit",
            "price": "27012",
            "size": "0.01",
            "timInForceValue": "normal"
        }
        response = maxOrderApi.placeOrder(params)
        print(response)
    except BitgetAPIException as e:
        print("error:" + e.message)

    # Demo 2: Place an order by calling the POST method directly
    baseApi = baseApi.BitgetApi(apiKey, secretKey, passphrase)
    try:
        params = {
            "symbol": "BTCUSDT_UMCBL",
            "marginCoin": "USDT",
            "side": "open_long",
            "orderType": "limit",
            "price": "27012",
            "size": "0.01",
            "timInForceValue": "normal"
        }
        response = baseApi.post("/api/mix/v1/order/placeOrder", params)
        print(response)
    except BitgetAPIException as e:
        print("error:" + e.message)

    # Demo 3: Send a GET request for market data
    try:
        params = {"productType": "umcbl"}
        response = baseApi.get("/api/mix/v1/market/contracts", params)
        print(response)
    except BitgetAPIException as e:
        print("error:" + e.message)

    # Demo 4: Send a GET request with no parameters
    try:
        response = baseApi.get("/api/spot/v1/account/getInfo", {})
        print(response)
    except BitgetAPIException as e:
        print("error:" + e.message)