Bitget APIBitget API
UTAClassic
Legacy Doc
  • Overview
  • API Documentation
  • WebSocket
  • Agent Hub
  • SDK
  • Changelog
Copied to clipboard
Stock+
    Options Quotes
      Check Option Real-time QuotegetCheck Option ChaingetCheck Option Expiry Date ListgetCheck Option Volumeget
    Stock Quotes
      Check Basic InformationgetCheck CandlestickgetCheck History CandlestickgetCheck Order BookgetCheck Intraday DatagetCheck Real-time QuotegetCheck Trade Detailget
    Stock+ Orders
      Place OrderpostModify OrderpostCancel OrderpostCheck Today OrdersgetCheck History OrdersgetCheck Order DetailgetCheck Today ExecutionsgetCheck History Executionsget
    Stock+ Fills
      Get Placeholder Infoget
    Stock+ Assets
      TransferpostCheck Transfer RecordsgetCheck AccountgetCheck Cash FlowgetCheck Stock Positionget
Stock+
Stock+

Stock+ Orders

Stock+ Orders


Place Order

POST
https://api.bitget.com
/api/v3/stockplus/trade/place-order

Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds

Permission: Trade (read and write)

This interface is used to place stock/option orders.

Place Order › Request Parameters

symbol
​string · required

Symbol, using ticker.region format, e.g. AAPL.US

orderType
​string · required

Order type LO Limit Order MO Market Order LIT Limit If Touched MIT Market If Touched TSLPAMT Trailing Stop Limit Order (Trailing Amount) TSLPPCT Trailing Stop Limit Order (Trailing Percentage)

side
​string · required

Order side Buy - Buy Sell - Sell

submittedQuantity
​string · required

Order quantity, e.g. 100

timeInForce
​string · required

Order validity type Day - Valid for the day GoodTilCanceled - Valid until cancelled GoodTilDate - Valid until expiry

submittedPrice
​string

Order price, e.g. 388.5 Required for LO / LIT orders

triggerPrice
​string

Trigger price, e.g. 388.5 Required for LIT / MIT orders

limitOffset
​string

Specified spread, e.g. 1.2 means spread of 1.2 USD (for US stocks) Required for TSLPAMT / TSLPPCT orders when limitDepthLevel is 0

trailingAmount
​string

Trailing amount Required for TSLPAMT orders

trailingPercent
​string

Trailing percentage, in percentage points, e.g. 2.5 means 2.5% Required for TSLPPCT orders

expireDate
​string

Long-term order expiry date, format: YYYY-MM-DD, e.g. 2022-12-05 Required when timeInForce is GoodTilDate

outsideRth
​string

Whether to allow trading outside regular trading hours. Required for US stocks RTHOnly - Do not allow pre/post market AnyTime - Allow pre/post market Overnight - Overnight trading

limitDepthLevel
​number

Specified bid/ask level, range -5 to 5. Negative is bid level (e.g. -1 is best bid), positive is ask level (e.g. 1 is best ask). When 0, limitOffset takes effect Valid for TSLPAMT / TSLPPCT orders

triggerCount
​number

Trigger count, range 0~3. The order is triggered after the condition is met this many times within 1 minute Valid for LIT / MIT / TSLPAMT / TSLPPCT orders

monitorPrice
​string

Monitor price, the order starts monitoring only when the price reaches this level Valid for TSLPAMT / TSLPPCT orders

remark
​string

Remark (max 64 characters)

Place Order › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
orderId
​string

System order ID

clientOid
​string

Client customized order ID. Returns empty string if not passed

symbol
​string

Option contract symbol

POST/api/v3/stockplus/trade/place-order
curl 'https://api.bitget.com/api/v3/stockplus/trade/place-order?symbol=<string>&orderType=<string>&side=<string>&submittedQuantity=<string>&timeInForce=<string>' \ --request POST
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740000000000, "data": { "orderId": "701276261045858304", "clientOid": "myOrder001", "symbol": "AAPL220429C150000.US" } }
json
application/json

Modify Order

POST
https://api.bitget.com
/api/v3/stockplus/trade/modify-order

Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds

Permission: Trade (read and write)

This interface is used to modify the price/quantity of unfilled or partially filled orders, with cancel & replace semantics.

Modify Order › Request Parameters

orderId
​string · required

Order ID

quantity
​string · required

Modified quantity, e.g. 200

price
​string

Modified price, e.g. 388.5 Required for LO / LIT orders

triggerPrice
​string

Trigger price, e.g. 388.5 Required for LIT / MIT orders

limitOffset
​string

Specified spread Required for TSLPAMT / TSLPPCT orders when limitDepthLevel is 0

trailingAmount
​string

Trailing amount Required for TSLPAMT orders

trailingPercent
​string

Trailing percentage Required for TSLPPCT orders

limitDepthLevel
​number

Specified bid/ask level. Required for TSLPAMT / TSLPPCT orders

triggerCount
​number

Trigger count. Required for LIT / MIT / TSLPAMT / TSLPPCT orders

monitorPrice
​string

Monitor price. Required for TSLPAMT / TSLPPCT orders

remark
​string

Remark (max 64 characters)

Modify Order › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
orderId
​string

System order ID after modification

clientOid
​string

Client customized order ID. Returns empty string if not passed

symbol
​string

Option contract symbol

POST/api/v3/stockplus/trade/modify-order
curl 'https://api.bitget.com/api/v3/stockplus/trade/modify-order?orderId=<string>&quantity=<string>' \ --request POST
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740000000000, "data": { "orderId": "701276261045858304", "clientOid": "", "symbol": "AAPL220429C150000.US" } }
json
application/json

Cancel Order

POST
https://api.bitget.com
/api/v3/stockplus/trade/cancel-order

Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds

Permission: Trade (read and write)

This interface is used to cancel unfilled or partially filled orders.

Cancel Order › Request Parameters

symbol
​string · required

Option contract symbol

orderId
​string

System order ID. At least one of orderId and clientOid must be passed; orderId takes priority when both are passed

clientOid
​string

Client customized order ID. At least one of orderId and clientOid must be passed

Cancel Order › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
orderId
​string

System order ID

clientOid
​string

Client customized order ID. Returns empty string if not passed

symbol
​string

Option contract symbol

POST/api/v3/stockplus/trade/cancel-order
curl 'https://api.bitget.com/api/v3/stockplus/trade/cancel-order?symbol=<string>' \ --request POST
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740000000000, "data": { "orderId": "701276261045858304", "clientOid": "", "symbol": "AAPL220429C150000.US" } }
json
application/json

Check Today Orders

GET
https://api.bitget.com
/api/v3/stockplus/trade/today-orders

Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds

Permission: Trade (read only)

This interface is used to query today's orders and order details.

Check Today Orders › Request Parameters

symbol
​string

Symbol, using ticker.region format, e.g. AAPL.US

status
​string

Order status, e.g. status=Filled&status=New NotReported - Not reported ReplacedNotReported - Replaced not reported ProtectedNotReported - Protected not reported VarietiesNotReported - Varieties not reported Filled - Fully filled WaitToNew - Waiting for new New - New WaitToReplace - Waiting for replace PendingReplace - Pending replace Replaced - Replaced PartialFilled - Partially filled WaitToCancel - Waiting for cancel PendingCancel - Pending cancel Rejected - Rejected Canceled - Canceled Expired - Expired PartialWithdrawal - Partial withdrawal

side
​string

Order side Buy - Buy Sell - Sell

market
​string

Market US - US stocks

orderId
​string

Order ID for specific order query, e.g. 701276261045858304

Check Today Orders › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
​object[]

Order information

GET/api/v3/stockplus/trade/today-orders
curl https://api.bitget.com/api/v3/stockplus/trade/today-orders
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740000000000, "data": { "orders": [ { "orderId": "701276261045858304", "status": "Rejected", "stockName": "Apple Inc.", "quantity": 1, "executedQuantity": 0, "price": 150, "executedPrice": null, "submittedAt": "2024-12-16T12:07:12Z", "side": "Buy", "symbol": "AAPL.US", "orderType": "LO", "lastDone": null, "triggerPrice": null, "msg": "", "tag": "Normal", "timeInForce": "Day", "expireDate": "2024-12-16", "updatedAt": "2024-12-16T12:07:12Z", "triggerAt": null, "trailingAmount": null, "trailingPercent": null, "limitOffset": null, "triggerStatus": null, "currency": "USD", "outsideRth": "RTHOnly", "limitDepthLevel": null, "triggerCount": null, "monitorPrice": null } ] } }
json
application/json

Check History Orders

GET
https://api.bitget.com
/api/v3/stockplus/trade/history-orders

Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds

Permission: Trade (read only)

This interface is used to query historical orders.

Check History Orders › Request Parameters

symbol
​string

Symbol, using ticker.region format, e.g. AAPL.US

status
​string

Order status, e.g. status=Filled&status=New NotReported - Not reported ReplacedNotReported - Replaced not reported ProtectedNotReported - Protected not reported VarietiesNotReported - Varieties not reported Filled - Fully filled WaitToNew - Waiting for new New - New WaitToReplace - Waiting for replace PendingReplace - Pending replace Replaced - Replaced PartialFilled - Partially filled WaitToCancel - Waiting for cancel PendingCancel - Pending cancel Rejected - Rejected Canceled - Canceled Expired - Expired PartialWithdrawal - Partial withdrawal

side
​string

Order side. Buy - Buy, Sell - Sell

market
​string

Market. US - US stocks

startAt
​number

Start time, timestamp in seconds, e.g. 1650410999. Defaults to 90 days before end time or current time

endAt
​number

End time, timestamp in seconds, e.g. 1650410999. Defaults to 90 days after start time or current time

Check History Orders › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
hasMore
​boolean

Whether there is more data. Max 1000 orders per query; hasMore is true when results exceed 1000

​object[]

Order information

GET/api/v3/stockplus/trade/history-orders
curl https://api.bitget.com/api/v3/stockplus/trade/history-orders
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740000000000, "data": { "hasMore": false, "orders": [ { "orderId": "701276261045858304", "status": "Canceled", "stockName": "Apple Inc.", "quantity": 1, "executedQuantity": 0, "price": 150, "executedPrice": null, "submittedAt": "2024-12-16T12:07:12Z", "side": "Buy", "symbol": "AAPL.US", "orderType": "LO", "lastDone": null, "triggerPrice": null, "msg": "", "tag": "Normal", "timeInForce": "Day", "expireDate": "2024-12-16", "updatedAt": "2024-12-16T12:07:23Z", "triggerAt": null, "trailingAmount": null, "trailingPercent": null, "limitOffset": null, "triggerStatus": null, "currency": "USD", "outsideRth": "RTHOnly", "limitDepthLevel": null, "triggerCount": null, "monitorPrice": null }, { "orderId": "701276261045858305", "status": "Filled", "stockName": "Apple Inc.", "quantity": 1, "executedQuantity": 1, "price": 80, "executedPrice": 10, "submittedAt": "2024-12-16T10:00:00Z", "side": "Buy", "symbol": "AAPL.US", "orderType": "LO", "lastDone": null, "triggerPrice": null, "msg": "", "tag": "Normal", "timeInForce": "Day", "expireDate": "2024-12-16", "updatedAt": "2024-12-16T10:00:01Z", "triggerAt": null, "trailingAmount": null, "trailingPercent": null, "limitOffset": null, "triggerStatus": null, "currency": "USD", "outsideRth": "AnyTime", "limitDepthLevel": null, "triggerCount": null, "monitorPrice": null } ] } }
json
application/json

Check Order Detail

GET
https://api.bitget.com
/api/v3/stockplus/trade/order-detail

Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds

Permission: Trade (read only)

This interface is used to query order detail information.

Check Order Detail › Request Parameters

orderId
​string · required

Order ID, e.g. 701276261045858304

Check Order Detail › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
orderId
​string

Order ID

status
​string

Order status NotReported - Not reported ReplacedNotReported - Replaced not reported ProtectedNotReported - Protected not reported VarietiesNotReported - Varieties not reported Filled - Fully filled WaitToNew - Waiting for new New - New WaitToReplace - Waiting for replace PendingReplace - Pending replace Replaced - Replaced PartialFilled - Partially filled WaitToCancel - Waiting for cancel PendingCancel - Pending cancel Rejected - Rejected Canceled - Canceled Expired - Expired PartialWithdrawal - Partial withdrawal

stockName
​string

Stock name

quantity
​string

Order quantity

executedQuantity
​string

Executed quantity. "0" for unfilled orders

price
​string

Order price. null when market conditional order not yet triggered

executedPrice
​string

Executed price. "0" for unfilled orders

submittedAt
​string

Order submission time

side
​string

Order side. Buy - Buy, Sell - Sell

symbol
​string

Symbol, using ticker.region format, e.g. AAPL.US

orderType
​string

Order type LO Limit Order MO Market Order LIT Limit If Touched MIT Market If Touched TSLPAMT Trailing Stop Limit Order (Trailing Amount) TSLPPCT Trailing Stop Limit Order (Trailing Percentage)

lastDone
​string

Latest traded price. "0" for unfilled orders

triggerPrice
​string

Trigger price for LIT/MIT orders. null for non-conditional orders

msg
​string

Rejection reason or remark. Empty string by default

tag
​string

Order tag Normal - Normal order GTC - GTC order

timeInForce
​string

Order validity type Day - Valid for the day GoodTilCanceled - Valid until cancelled GoodTilDate - Valid until expiry

expireDate
​string

Long-term order expiry date, format: YYYY-MM-DD. null for non-GTD orders

updatedAt
​string

Last update time (ISO 8601). null if never updated

triggerAt
​string

Conditional order trigger time, timestamp (ISO 8601)

trailingAmount
​string

TSLPAMT order trailing amount. null for non-TSLPAMT orders

trailingPercent
​string

TSLPPCT order trailing percentage. null for non-TSLPPCT orders

limitOffset
​string

TSLPAMT/TSLPPCT order spread. null for non-TSLP orders

triggerStatus
​string

Conditional order trigger status. null for non-conditional orders NOT_USED - Not active DEACTIVE - Deactivated ACTIVE - Active RELEASED - Triggered

currency
​string

Settlement currency

outsideRth
​string

Allow pre/post market trading. UnknownOutsideRth for non-US orders RTHOnly - Do not allow AnyTime - Allow Overnight - Overnight

remark
​string

Remark

limitDepthLevel
​number

Specified bid/ask level

triggerCount
​number

Trigger count

monitorPrice
​string

Monitor price

freeStatus
​string

Commission-free status. Default None None - None Calculated - To be calculated Pending - Pending Ready - Completed

freeAmount
​string

Commission-free amount. Default null

freeCurrency
​string

Commission-free currency. Default null

deductionsStatus
​string

Deduction/rebate status. Default None None - Pending settlement / No data Pending - Settled, pending issuance Done - Settled, issued

deductionsAmount
​string

Deduction amount. Default null

deductionsCurrency
​string

Deduction currency. Default null

platformDeductedStatus
​string

Platform fee deduction/rebate status. Default None None - Pending settlement / No data Pending - Settled, pending issuance Done - Settled, issued

platformDeductedAmount
​string

Platform fee deduction amount. Default null

platformDeductedCurrency
​string

Platform fee deduction currency. Default null

​object[]

Order history details

​object

Order charges

GET/api/v3/stockplus/trade/order-detail
curl 'https://api.bitget.com/api/v3/stockplus/trade/order-detail?orderId=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740000000000, "data": { "orderId": "701276261045858304", "status": "Filled", "stockName": "Apple Inc.", "quantity": 1, "executedQuantity": 0, "price": 150, "executedPrice": null, "submittedAt": "2024-12-16T12:07:12Z", "side": "Buy", "symbol": "AAPL.US", "orderType": "LO", "lastDone": null, "triggerPrice": null, "msg": "", "tag": "Normal", "timeInForce": "Day", "expireDate": "2024-12-16", "updatedAt": null, "triggerAt": null, "trailingAmount": null, "trailingPercent": null, "limitOffset": null, "triggerStatus": null, "currency": "USD", "outsideRth": "RTHOnly", "remark": "remark from Java SDK", "limitDepthLevel": null, "triggerCount": null, "monitorPrice": null, "freeStatus": "None", "freeAmount": null, "freeCurrency": null, "deductionsStatus": "None", "deductionsAmount": null, "deductionsCurrency": null, "platformDeductedStatus": "None", "platformDeductedAmount": null, "platformDeductedCurrency": null, "history": [ { "price": 10, "quantity": 1, "status": "Filled", "msg": "", "time": "2024-12-16T12:07:12Z" }, { "price": 80, "quantity": 1, "status": "New", "msg": "", "time": "2024-12-16T12:06:55Z" } ], "chargeDetail": { "totalAmount": 0, "currency": "USD", "items": [ { "code": "Broker", "name": "Broker Fees", "fees": [] }, { "code": "Third", "name": "Third-party Fees", "fees": [] } ] } } }
json
application/json

Check Today Executions

GET
https://api.bitget.com
/api/v3/stockplus/trade/today-executions

Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds

Permission: Trade (read only)

This interface is used to query today's order execution details.

Check Today Executions › Request Parameters

symbol
​string

Symbol, using ticker.region format, e.g. AAPL.US

orderId
​string

Order ID, e.g. 701276261045858304

Check Today Executions › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
​object[]

Execution detail information

GET/api/v3/stockplus/trade/today-executions
curl https://api.bitget.com/api/v3/stockplus/trade/today-executions
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740000000000, "data": { "trades": [ { "orderId": "701276261045858304", "tradeId": "0f40217c-a73c-410d-b599-2ff6a9ee762e", "symbol": "AAPL.US", "tradeDoneAt": "2024-12-16T12:07:12Z", "quantity": 1, "price": 150 } ] } }
json
application/json

Check History Executions

GET
https://api.bitget.com
/api/v3/stockplus/trade/history-executions

Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds

Permission: Trade (read only)

This interface is used to query historical order execution records, including buy and sell execution records. Does not support today's execution query.

Check History Executions › Request Parameters

symbol
​string

Symbol, using ticker.region format, e.g. AAPL.US

startAt
​number

Start time, timestamp in seconds, e.g. 1650410999. Defaults to 90 days before end time or current time

endAt
​number

End time, timestamp in seconds, e.g. 1650410999. Defaults to 90 days after start time or current time

Check History Executions › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
hasMore
​boolean

Whether there is more data. Max 1000 orders per query; hasMore is true when results exceed 1000

​object[]

Execution detail information

GET/api/v3/stockplus/trade/history-executions
curl https://api.bitget.com/api/v3/stockplus/trade/history-executions
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740000000000, "data": { "hasMore": false, "trades": [ { "orderId": "701276261045858304", "tradeId": "0f40217c-a73c-410d-b599-2ff6a9ee762e", "symbol": "AAPL.US", "tradeDoneAt": "2024-12-16T12:07:12Z", "quantity": 1, "price": 150 } ] } }
json
application/json

Stock QuotesStock+ Fills