Account API
AccountPrivateApi
GET Get Position Transaction Page
GET /api/v1/private/account/getPositionTransactionPage
Request Parameters
accountId
query
string
No
Account ID
size
query
string
No
Number of items to retrieve. Must be greater than 0 and less than or equal to 100
offsetData
query
string
No
Pagination offset. If empty or not provided, the first page is retrieved
filterCoinIdList
query
string
No
Filter position transaction records by specified coin IDs. If not provided, all collateral transaction records are retrieved
filterContractIdList
query
string
No
Filter position transaction records by specified contract IDs. If not provided, all position transaction records are retrieved
filterTypeList
query
string
No
Filter position transaction records by specified types. If not provided, all position transaction records are retrieved
filterStartCreatedTimeInclusive
query
string
No
Filter position transaction records created after or at the specified start time (inclusive). If not provided or 0, retrieves records from the earliest time
filterEndCreatedTimeExclusive
query
string
No
Filter position transaction records created before the specified end time (exclusive). If not provided or 0, retrieves records up to the latest time
filterCloseOnly
query
string
No
Whether to return only position transactions that include closing positions. true: only return records with closing; false: return all records
filterOpenOnly
query
string
No
Whether to return only position transactions that include opening positions. true: only return records with opening; false: return all records
Response Example
200 Response
Response
200
default response
GET Get Position Transactions By Account ID and Transaction ID
GET /api/v1/private/account/getPositionTransactionById
Request Parameters
accountId
query
string
No
Account ID
positionTransactionIdList
query
string
No
Position Transaction IDs
Response Example
200 Response
Response
200
default response
GET Get Position Term Page by Account ID
GET /api/v1/private/account/getPositionTermPage
Request Parameters
accountId
query
string
No
Account ID
size
query
string
No
Number of items to retrieve. Must be greater than 0 and less than or equal to 100
offsetData
query
string
No
Pagination offset. If empty or not provided, the first page is retrieved
filterCoinIdList
query
string
No
Filter position term records by specified coin IDs. If not provided, all position term records are retrieved
filterContractIdList
query
string
No
Filter position term records by specified contract IDs. If not provided, all position term records are retrieved
filterIsLongPosition
query
string
No
Filter position term records by position direction. If not provided, all position term records are retrieved
filterStartCreatedTimeInclusive
query
string
No
Filter position term records created after or at the specified start time (inclusive). If not provided or 0, retrieves records from the earliest time
filterEndCreatedTimeExclusive
query
string
No
Filter position term records created before the specified end time (exclusive). If not provided or 0, retrieves records up to the latest time
Response Example
200 Response
Response
200
default response
GET Get Position By Account ID and Contract ID
GET /api/v1/private/account/getPositionByContractId
Request Parameters
accountId
query
string
No
Account ID
contractIdList
query
string
No
Specified contract IDs
Response Example
200 Response
Response
200
default response
Inline
Response Data Structure
GET Get Collateral Transaction Page by Account ID
GET /api/v1/private/account/getCollateralTransactionPage
Request Parameters
accountId
query
string
No
Account ID
size
query
string
No
Number of items to retrieve. Must be greater than 0 and less than or equal to 100
offsetData
query
string
No
Pagination offset. If empty or not provided, the first page is retrieved
filterCoinIdList
query
string
No
Filter collateral transaction records by specified coin IDs. If not provided, all collateral transaction records are retrieved
filterTypeList
query
string
No
Filter collateral transaction records by specified transaction types. If not provided, all collateral transaction records are retrieved
filterStartCreatedTimeInclusive
query
string
No
Filter collateral transaction records created after or at the specified start time (inclusive). If not provided or 0, retrieves records from the earliest time
filterEndCreatedTimeExclusive
query
string
No
Filter collateral transaction records created before the specified end time (exclusive). If not provided or 0, retrieves records up to the latest time
Response Example
200 Response
Response
200
default response
Inline
Response Data Structure
GET Get Collateral Transactions By Account ID and Transaction ID
GET /api/v1/private/account/getCollateralTransactionById
Request Parameters
accountId
query
string
No
Account ID
collateralTransactionIdList
query
string
No
Collateral Transaction IDs
Response Example
200 Response
Response
200
default response
Inline
Response Data Structure
GET Get Collateral By Account ID and Coin ID
GET /api/v1/private/account/getCollateralByCoinId
Request Parameters
accountId
query
string
No
Account ID
coinIdList
query
string
No
Filter collateral information by specified coin IDs. If not provided, all collateral information is retrieved
Response Example
200 Response
Response
200
default response
Inline
Response Data Structure
GET Get Account Page by User ID
GET /api/v1/private/account/getAccountPage
Request Parameters
size
query
string
No
Number of items to retrieve. Must be greater than 0 and less than or equal to 100
offsetData
query
string
No
Pagination offset. If empty or not provided, the first page is retrieved
Response Example
200 Response
Response
200
default response
GET Get Account Deleverage Light
GET /api/v1/private/account/getAccountDeleverageLight
Request Parameters
accountId
query
string
No
Account ID
Response Example
200 Response
Response
200
default response
GET Get Account By Account ID
GET /api/v1/private/account/getAccountById
Request Parameters
accountId
query
string
No
Account ID
Response Example
200 Response
Response
200
default response
GET Account Asset
GET /api/v1/private/account/getAccountAsset
Request Parameters
accountId
query
string
No
Account ID
Response Example
200 Response
Response
200
default response
GET Get Account Asset Snapshot Page by Account ID
GET /api/v1/private/account/getAccountAssetSnapshotPage
Request Parameters
accountId
query
string
No
Account ID
size
query
string
No
Number of items to retrieve. Must be greater than 0 and less than or equal to 1000
offsetData
query
string
No
Pagination offset. If empty or not provided, the first page is retrieved
coinId
query
string
Yes
Filter by the specified coin ID.
filterTimeTag
query
string
No
Specifies time tag. If not provided or 0, returns snapshots by the hour. 1 returns snapshots by the day
filterStartTimeInclusive
query
string
No
Filter snapshots created after or at the specified start time (inclusive). If not provided or 0, retrieves records from the earliest time
filterEndTimeExclusive
query
string
No
Filter snapshots created before the specified end time (exclusive). If not provided or 0, retrieves records up to the latest time
Response Example
200 Response
Response
200
default response
Data Models
Properties
code
string
false
none
Status Code
Returns "SUCCESS" on success; otherwise, it indicates failure.
data
false
none
Generic Paginated Response
errorParam
object
false
none
Error Parameters
Error message parameter information
» additionalProperties
string
false
none
Error Parameters
Error message parameter information
requestTime
string(timestamp)
false
none
Server Request Time
Time at which the server received the request
responseTime
string(timestamp)
false
none
Server Response Time
Time at which the server sent the response
traceId
string
false
none
Trace ID
Invocation trace ID
Generic Paginated Response
dataList
false
none
Data List
nextPageOffsetData
string
false
none
Next Page Offset
Offset for retrieving the next page. If no next page data, empty string.
Account historical asset snapshot information
userId
string(int64)
false
none
User ID
ID of the owning user
accountId
string(int64)
false
none
Account ID
ID of the owning account
coinId
string(int64)
false
none
Collateral Coin ID
ID of the associated collateral coin
timeTag
integer(int32)
false
none
Time Tag
Time tag. 1 represents the snapshot time is for the whole day.
snapshotTime
string(int64)
false
none
Snapshot Time
Snapshot time, hourly timestamp at the top of the hour.
totalEquity
string
false
none
Total Collateral Value
Current total value of the collateral
termRealizePnl
string
false
none
Term Realized PnL
Realized PnL for the term
unrealizePnl
string
false
none
Unrealized PnL
Unrealized PnL
totalRealizePnl
string
false
none
Total Realized PnL
Total realized PnL of the position
getaccountasset
code
string
false
none
Status Code
Returns "SUCCESS" on success; otherwise, it indicates failure.
data
false
none
Get Account Asset Response
Response structure for fetching account asset data.
errorParam
object
false
none
Error Parameters
Error message parameter information
requestTime
string(timestamp)
false
none
Server Request Time
Time at which the server received the request
responseTime
string(timestamp)
false
none
Server Response Time
Time at which the server sent the response
traceId
string
false
none
Trace ID
Invocation trace ID
Response structure for fetching account asset data
account
false
none
Account Information
Account information data.
collateralList
false
none
Collateral Information List
List of collateral information data.
positionList
false
none
Perpetual Contract Position List
List of perpetual contract position information.
version
string(int64)
false
none
Account Version
Account version number, incremented with each update.
positionAssetList
false
none
Position Asset Information List
List of position asset information.
collateralAssetModelList
false
none
Account-Level Asset Information List
List of account-level asset information.
oraclePriceList
false
none
Oracle Price List
List of all oracle prices used to calculate assets (only those used).
Price information
contractId
string(int64)
false
none
Contract ID
Contract ID
priceType
string
false
none
Price Type
priceValue
string
false
none
Price Value
Price value
createdTime
string(int64)
false
none
Creation Time
Time of creation
oraclePriceSignature
false
none
Oracle Price Signature Information
Oracle price signature information, only exists when price_type=ORACLE_PRICE.
Enumerated Values
priceType
UNKNOWN_PRICE_TYPE
priceType
ORACLE_PRICE
priceType
INDEX_PRICE
priceType
LAST_PRICE
priceType
ASK1_PRICE
priceType
BID1_PRICE
priceType
OPEN_INTEREST
priceType
UNRECOGNIZED
Oracle price signature information
contractId
string(int64)
false
none
Contract ID
Contract ID
signer
string
false
none
Signer ID
Signer identifier
price
string
false
none
Signed Price
The price signed (price after stark ex precision processing)
externalAssetId
string
false
none
Concatenated Asset and Oracle Names
Concatenation of the asset name and the oracle name (both in hex encoding).
signature
false
none
L2 Signature Information
L2 signature information
timestamp
string(int64)
false
none
Signature Creation Time
The time the signature was created.
L2 signature information
r
string
false
none
R Value
Bigint for hex string
s
string
false
none
S Value
Bigint for hex string
v
string
false
none
V Value
Bigint for hex string
Collateral asset information
userId
string(int64)
false
none
User ID
ID of the owning user.
accountId
string(int64)
false
none
Account ID
ID of the owning account.
coinId
string(int64)
false
none
Collateral Coin ID
ID of the associated collateral coin.
totalEquity
string
false
none
Total Collateral Value
Current total value of the collateral.
totalPositionValueAbs
string
false
none
Sum of Absolute Position Values
Sum of the absolute position values for the current collateral
initialMarginRequirement
string
false
none
Initial Margin Requirement
The initial margin requirement for the current collateral.
starkExRiskValue
string
false
none
Total StarkEx Risk Value
The total starkEx risk amount for the current collateral.
pendingWithdrawAmount
string
false
none
Pending Withdrawal Amount
The amount of collateral pending withdrawal.
pendingTransferOutAmount
string
false
none
Pending Transfer Out Amount
The amount of collateral pending transfer out.
orderFrozenAmount
string
false
none
Order Frozen Amount
The amount of collateral frozen by orders.
availableAmount
string
false
none
Available Amount
The amount of collateral available for use.
Asset information related to a position
userId
string(int64)
false
none
User ID
ID of the owning user.
accountId
string(int64)
false
none
Account ID
ID of the owning account.
coinId
string(int64)
false
none
Collateral Coin ID
ID of the associated collateral coin.
contractId
string(int64)
false
none
Contract ID
ID of the associated contract.
positionValue
string
false
none
Position Value
Position value, positive for long positions, negative for short positions.
maxLeverage
string
false
none
Maximum Leverage
The maximum leverage for current contract position.
initialMarginRequirement
string
false
none
Initial Margin Requirement
Initial margin requirement for the position.
starkExRiskRate
string
false
none
StarkEx Risk Rate
StarkEx risk rate calculated based on risk tiers. Similar to maintenance margin rate with different precision.
starkExRiskValue
string
false
none
StarkEx Risk Value
StarkEx risk amount, similar to maintenance margin, with different precision.
avgEntryPrice
string
false
none
Average Entry Price
Average entry price.
liquidatePrice
string
false
none
Liquidation Price
Liquidation price (force liquidation price). If oracle price reaches this price, liquidation is triggered.
bankruptPrice
string
false
none
Bankruptcy Price
Bankruptcy price. If the oracle price reaches this level, account total value is less than 0.
worstClosePrice
string
false
none
Worst Close Price
The worst closing price. The closing transaction price can not be worse than this price.
unrealizePnl
string
false
none
Unrealized PnL
Unrealized profit and loss for the position.
termRealizePnl
string
false
none
Term Realized PnL
Realized PnL for the term.
totalRealizePnl
string
false
none
Total Realized PnL
Total realized PnL of the position.
Perpetual contract position information
userId
string(int64)
false
none
User ID
ID of the owning user.
accountId
string(int64)
false
none
Account ID
ID of the owning account.
coinId
string(int64)
false
none
Collateral Coin ID
ID of the associated collateral coin.
contractId
string(int64)
false
none
Contract ID
ID of the associated contract.
openSize
string
false
none
Current Open Size
Current open size (positive for long, negative for short).
openValue
string
false
none
Current Open Value
Current open value (increases upon opening, proportionally decreases upon closing).
openFee
string
false
none
Current Open Fee
Current allocated open fee (increases upon opening, proportionally decreases upon closing).
fundingFee
string
false
none
Current Funding Fee
Current allocated funding fee (increases upon settlement, proportionally decreases upon closing).
longTermCount
integer(int32)
false
none
Long Position Term Count
Long position term count. Starts from 1, increases by one upon complete closure of a position
longTermStat
false
none
Long Position Cumulative Statistics
Cumulative statistics for the position.
longTermCreatedTime
string
false
none
Long Position Term Creation Time
Creation time for the long position term.
longTermUpdatedTime
string
false
none
Long Position Term Update Time
Update time for the long position term.
shortTermCount
integer(int32)
false
none
Short Position Term Count
Short position term count. Starts from 1, increases by one upon complete closure of a position
shortTermStat
false
none
Short Position Cumulative Statistics
Cumulative statistics for the position.
shortTermCreatedTime
string
false
none
Short Position Term Creation Time
Creation time for the short position term.
shortTermUpdatedTime
string
false
none
Short Position Term Update Time
Update time for the short position term.
longTotalStat
false
none
Long Cumulative Statistics
Cumulative statistics for the position.
shortTotalStat
false
none
Short Cumulative Statistics
Cumulative statistics for the position.
createdTime
string(int64)
false
none
Creation Time
Creation time.
updatedTime
string(int64)
false
none
Update Time
Update time.
Cumulative statistics for a position
cumOpenSize
string
false
none
Cumulative Open Size
Cumulative open size.
cumOpenValue
string
false
none
Cumulative Open Value
Cumulative open value.
cumOpenFee
string
false
none
Cumulative Open Fee
Cumulative open fees.
cumCloseSize
string
false
none
Cumulative Close Size
Cumulative close size.
cumCloseValue
string
false
none
Cumulative Close Value
Cumulative close value.
cumCloseFee
string
false
none
Cumulative Close Fee
Cumulative close fees.
cumFundingFee
string
false
none
Cumulative Funding Fee
Cumulative funding fees settled.
cumLiquidateFee
string
false
none
Cumulative Liquidate Fee
Cumulative liquidation fees.
Collateral information
userId
string(int64)
false
none
User ID
ID of the owning user.
accountId
string(int64)
false
none
Account ID
ID of the owning account.
coinId
string(int64)
false
none
Coin ID
Collateral coin ID.
amount
string(decimal)
false
none
Collateral Amount
Collateral amount, actually of decimal type.
legacyAmount
string(decimal)
false
none
Legacy Amount
Legacy balance field, for display purposes only, not for calculations.
cumDepositAmount
string(decimal)
false
none
Cumulative Deposit Amount
Cumulative deposit amount.
cumWithdrawAmount
string(decimal)
false
none
Cumulative Withdrawal Amount
Cumulative withdrawal amount.
cumTransferInAmount
string(decimal)
false
none
Cumulative Transfer In Amount
Cumulative transfer in amount.
cumTransferOutAmount
string(decimal)
false
none
Cumulative Transfer Out Amount
Cumulative transfer out amount.
cumPositionBuyAmount
string(decimal)
false
none
Cumulative Position Buy Amount
Cumulative collateral amount deducted from position buy.
cumPositionSellAmount
string(decimal)
false
none
Cumulative Position Sell Amount
Cumulative collateral amount added from position sell.
cumFillFeeAmount
string(decimal)
false
none
Cumulative Fill Fee Amount
Cumulative transaction fee amount.
cumFundingFeeAmount
string(decimal)
false
none
Cumulative Funding Fee Amount
Cumulative funding fee amount.
cumFillFeeIncomeAmount
string(decimal)
false
none
Cumulative Order Fill Fee Income Amount
Cumulative amount from order fill fee income.
createdTime
string(int64)
false
none
Creation Time
Creation time.
updatedTime
string(int64)
false
none
Update Time
Update time.
Account information data
id
string(int64)
false
none
Account ID
Account ID, must be greater than 0.
userId
string(int64)
false
none
User ID
ID of the owning user.
ethAddress
string
false
none
Wallet ETH Address
Wallet ETH address.
l2Key
string
false
none
L2 Account Key
Account key on L2. Stark key in starkEx. Bigint for hex string
l2KeyYCoordinate
string
false
none
L2 Key Y Coordinate
Used only for verifying l2Signature. Not returned to end users. Bigint for hex string.
clientAccountId
string
false
none
Client Account ID
Client account ID for idempotency check.
isSystemAccount
boolean
false
none
System Account
Whether it is a system account (system accounts are not subject to contract risk settings, use separate MQ for trade messages).
defaultTradeSetting
false
none
Default Trade Setting
Trade settings. Trade setting calculation priority: Account contract trade settings -> Account default trade settings -> Contract configuration trade settings. Note: Only one of is_set_fee_rate and is_set_fee_discount can be true.
contractIdToTradeSetting
object
false
none
Contract-Level Account Trade Settings
Account contract-level trade settings.
» additionalProperties
false
none
Contract-Level Account Trade Settings
Trade settings. Trade setting calculation priority: Account contract trade settings -> Account default trade settings -> Contract configuration trade settings. Note: Only one of is_set_fee_rate and is_set_fee_discount can be true.
maxLeverageLimit
string
false
none
Maximum Leverage Limit
User-set maximum leverage limit. If 0, uses the leverage limit of the corresponding trading contract.
createOrderPerMinuteLimit
integer(int32)
false
none
Order Creation Limit per Minute
Order frequency limit per minute. If 0, default limit is used; if < 0, no limit is applied.
createOrderDelayMillis
integer(int32)
false
none
Order Creation Delay Milliseconds
Order delay milliseconds, must be greater than or equal to 0.
extraType
string
false
none
Extra Type
Extra type for upper-layer use.
extraDataJson
string
false
none
Extra Data
Extra data in JSON format, default is an empty string.
status
string
false
none
Account Status
Account status.
isLiquidating
boolean
false
none
Is Liquidating
Whether is being liquidated.
createdTime
string(int64)
false
none
Creation Time
Creation time.
updatedTime
string(int64)
false
none
Update Time
Update time.
Enumerated Values
status
UNKNOWN_ACCOUNT_STATUS
status
CENSORING
status
NORMAL
status
DISABLED
status
INVALID
status
UNRECOGNIZED
Trade settings
isSetFeeRate
boolean
false
none
Whether Fee Rate is Set
Whether to set a specific fee rate value.
takerFeeRate
string(decimal)
false
none
Taker Fee Rate
Taker fee rate, range [0, 1), valid only when is_set_fee_rate=true.
makerFeeRate
string(decimal)
false
none
Maker Fee Rate
Maker fee rate, range [0, 1), valid only when is_set_fee_rate=true.
isSetFeeDiscount
boolean
false
none
Whether Fee Discount is Set
Whether to set a fee discount.
takerFeeDiscount
string(decimal)
false
none
Taker Fee Discount
Taker fee discount, range [0, 1), valid only when is_set_fee_discount=true.
makerFeeDiscount
string(decimal)
false
none
Maker Fee Discount
Maker fee discount, range [0, 1), valid only when is_set_fee_discount=true.
isSetMaxLeverage
boolean
false
none
Whether Maximum Leverage is Set
Whether to set maximum trading leverage.
maxLeverage
string(decimal)
false
none
Maximum Leverage
Maximum trading leverage.
account
code
string
false
none
Status Code
Returns "SUCCESS" on success; otherwise, it indicates failure.
data
false
none
Account Information
Account information data.
errorParam
object
false
none
Error Parameters
Error message parameter information
requestTime
string(timestamp)
false
none
Server Request Time
Time at which the server received the request
responseTime
string(timestamp)
false
none
Server Response Time
Time at which the server sent the response
traceId
string
false
none
Trace ID
Invocation trace ID
getaccountdeleveragelight
code
string
false
none
Status Code
Returns "SUCCESS" on success; otherwise, it indicates failure.
data
false
none
Get Account Deleverage Light Response
Response structure for fetching deleverage light information.
errorParam
object
false
none
Error Parameters
Error message parameter information
requestTime
string(timestamp)
false
none
Server Request Time
Time at which the server received the request
responseTime
string(timestamp)
false
none
Server Response Time
Time at which the server sent the response
traceId
string
false
none
Trace ID
Invocation trace ID
Response structure for fetching deleverage light information.
positionContractIdToLightNumberMap
object
false
none
Map from Position Contract ID to Light Number
Maps position contract ID to light number. light_number ranges from 1-5, which represent 1-5 lights.
account
code
string
false
none
Status Code
Returns "SUCCESS" on success; otherwise, it indicates failure.
data
false
none
Generic Paginated Response
Generic paginated response.
errorParam
object
false
none
Error Parameters
Error message parameter information
requestTime
string(timestamp)
false
none
Server Request Time
Time at which the server received the request
responseTime
string(timestamp)
false
none
Server Response Time
Time at which the server sent the response
traceId
string
false
none
Trace ID
Invocation trace ID
Generic Paginated Response
dataList
false
none
Data List
List of account data.
nextPageOffsetData
string
false
none
Next Page Offset
Offset for retrieving the next page. If no next page data, empty string.
collateral
code
string
false
none
Status Code
Returns "SUCCESS" on success; otherwise, it indicates failure.
data
false
none
Response Data
Correct response data.
errorParam
object
false
none
Error Parameters
Error message parameter information
requestTime
string(timestamp)
false
none
Server Request Time
Time at which the server received the request
responseTime
string(timestamp)
false
none
Server Response Time
Time at which the server sent the response
traceId
string
false
none
Trace ID
Invocation trace ID
collateraltransaction
code
string
false
none
Status Code
Returns "SUCCESS" on success; otherwise, it indicates failure.
data
false
none
Response Data
Correct response data.
errorParam
object
false
none
Error Parameters
Error message parameter information
requestTime
string(timestamp)
false
none
Server Request Time
Time at which the server received the request
responseTime
string(timestamp)
false
none
Server Response Time
Time at which the server sent the response
traceId
string
false
none
Trace ID
Invocation trace ID
Collateral transaction details
id
string(int64)
false
none
Unique Identifier
Unique identifier.
userId
string(int64)
false
none
User ID
ID of the owning user.
accountId
string(int64)
false
none
Account ID
ID of the owning account.
coinId
string(int64)
false
none
Coin ID
Collateral coin ID.
type
string
false
none
Detail Type
Detail type.
deltaAmount
string(decimal)
false
none
Collateral Change Amount
Amount of the collateral change.
deltaLegacyAmount
string(decimal)
false
none
Legacy Balance Change Amount
Change amount of the legacy balance field.
beforeAmount
string(decimal)
false
none
Collateral Amount Before Change
Collateral amount before the change.
beforeLegacyAmount
string(decimal)
false
none
Legacy Balance Amount Before Change
Legacy balance before the change.
fillCloseSize
string(decimal)
false
none
Transaction Close Size
Transaction close size (positive for buy, negative for sell).
fillCloseValue
string
false
none
Transaction Close Value
Transaction close value (positive for buy, negative for sell).
fillCloseFee
string
false
none
Transaction Close Fee
Transaction close fee (typically zero or negative).
fillOpenSize
string(decimal)
false
none
Transaction Open Size
Transaction open size (positive for buy, negative for sell).
fillOpenValue
string
false
none
Transaction Open Value
Transaction open value (positive for buy, negative for sell).
fillOpenFee
string
false
none
Transaction Open Fee
Transaction open fee (typically zero or negative).
fillPrice
string(decimal)
false
none
Transaction Price
Transaction price (not precise, for display).
liquidateFee
string(decimal)
false
none
Liquidation Fee
Liquidation fee (if close transaction is a liquidation, typically zero or negative).
realizePnl
string(decimal)
false
none
Realized Profit and Loss
Realized profit and loss from a close (if a close transaction. Not precise, for display).
isLiquidate
boolean
false
none
Is Liquidation
Whether the transaction is a liquidation.
isDeleverage
boolean
false
none
Is Auto-Deleveraging
Whether the transaction is from auto-deleveraging.
fundingTime
string(int64)
false
none
Funding Settlement Time
Funding settlement time.
fundingRate
string(decimal)
false
none
Funding Rate
Funding rate.
fundingIndexPrice
string(decimal)
false
none
Funding Index Price
Index price related to funding rate.
fundingOraclePrice
string(decimal)
false
none
Funding Oracle Price
Oracle price related to funding rate.
fundingPositionSize
string(decimal)
false
none
Position Size During Funding Settlement
Position size during funding settlement (positive for long, negative for short).
depositId
string(int64)
false
none
Deposit Order ID
Associated deposit order ID when type=DEPOSIT.
withdrawId
string(int64)
false
none
Withdrawal Order ID
Associated withdrawal order ID when type=WITHDRAW.
transferInId
string(int64)
false
none
Transfer In Order ID
Associated transfer-in order ID when type=TRANSFER_IN.
transferOutId
string(int64)
false
none
Transfer Out Order ID
Associated transfer-out order ID when type=TRANSFER_OUT.
transferReason
string
false
none
Transfer Reason
Transfer reason when type=TRANSFER_IN/TRANSFER_OUT.
orderId
string(int64)
false
none
Order ID
Associated order ID when type=POSITION_BUY/POSITION_SELL/FILL_FEE_INCOME.
orderFillTransactionId
string(int64)
false
none
Order Fill Transaction ID
Associated order fill transaction ID when type=POSITION_BUY/POSITION_SELL/FILL_FEE_INCOME.
orderAccountId
string(int64)
false
none
Order Account ID
Associated order account ID when type=FILL_FEE_INCOME.
positionContractId
string(int64)
false
none
Position Contract ID
Associated position contract ID when type=POSITION_BUY/POSITION_SELL/POSITION_FUNDING/FILL_FEE_INCOME.
positionTransactionId
string(int64)
false
none
Position Transaction ID
Associated position transaction ID when type=POSITION_BUY/POSITION_SELL/POSITION_FUNDING.
forceWithdrawId
string
false
none
Force Withdrawal Order ID
Associated force withdrawal order ID when type=WITHDRAW.
forceTradeId
string
false
none
Force Trade ID
Associated force trade order ID when type=POSITION_BUY/POSITION_SELL.
extraType
string
false
none
Extra Type
Extra type for upper-layer business use.
extraDataJson
string
false
none
Extra Data
Extra data in JSON format, default is empty string.
censorStatus
string
false
none
Current Censoring Status
Current censoring status.
censorTxId
string(int64)
false
none
Censoring Processing Sequence Number
Censoring processing sequence number, exists when censor_status=CENSOR_SUCCESS/CENSOR_FAILURE/L2_APPROVED/L2_REJECT/L2_REJECT_APPROVED.
censorTime
string(int64)
false
none
Censoring Processing Time
Censoring processing time, exists when censor_status=CENSOR_SUCCESS/CENSOR_FAILURE/L2_APPROVED/L2_REJECT/L2_REJECT_APPROVED.
censorFailCode
string
false
none
Censoring Failure Code
Censoring failure code, exists when censor_status=CENSOR_FAILURE.
censorFailReason
string
false
none
Censoring Failure Reason
Censoring failure reason, exists when censor_status=CENSOR_FAILURE.
l2TxId
string(int64)
false
none
L2 Push Transaction ID
L2 push transaction ID, exists when censor_status=CENSOR_SUCCESS/L2_APPROVED/L2_REJECT/L2_REJECT_APPROVED.
l2RejectTime
string(int64)
false
none
L2 Rejection Time
L2 rejection time, exists when censor_status=L2_REJECT/L2_REJECT_APPROVED.
l2RejectCode
string
false
none
L2 Rejection Error Code
L2 rejection error code, exists when censor_status=L2_REJECT/L2_REJECT_APPROVED.
l2RejectReason
string
false
none
L2 Rejection Reason
L2 rejection reason, exists when censor_status=L2_REJECT/L2_REJECT_APPROVED.
l2ApprovedTime
string(int64)
false
none
L2 Batch Verification Time
L2 batch verification time, exists when censor_status=L2_APPROVED/L2_REJECT_APPROVED.
createdTime
string(int64)
false
none
Creation Time
Creation time.
updatedTime
string(int64)
false
none
Update Time
Update time.
Enumerated Values
type
UNKNOWN_COLLATERAL_TRANSACTION_TYPE
type
DEPOSIT
type
WITHDRAW
type
TRANSFER_IN
type
TRANSFER_OUT
type
POSITION_BUY
type
POSITION_SELL
type
POSITION_FUNDING
type
FILL_FEE_INCOME
type
BUG_FIX_COLLATERAL_TRANSACTION_TYPE
type
UNRECOGNIZED
transferReason
UNKNOWN_TRANSFER_REASON
transferReason
USER_TRANSFER
transferReason
FAST_WITHDRAW
transferReason
CROSS_DEPOSIT
transferReason
CROSS_WITHDRAW
transferReason
UNRECOGNIZED
censorStatus
UNKNOWN_TRANSACTION_STATUS
censorStatus
INIT
censorStatus
CENSOR_SUCCESS
censorStatus
CENSOR_FAILURE
censorStatus
L2_APPROVED
censorStatus
L2_REJECT
censorStatus
L2_REJECT_APPROVED
censorStatus
UNRECOGNIZED
collateraltransaction
code
string
false
none
Status Code
Returns "SUCCESS" on success; otherwise, it indicates failure.
data
false
none
Generic Paginated Response
Generic paginated response.
errorParam
object
false
none
Error Parameters
Error message parameter information
requestTime
string(timestamp)
false
none
Server Request Time
Time at which the server received the request
responseTime
string(timestamp)
false
none
Server Response Time
Time at which the server sent the response
traceId
string
false
none
Trace ID
Invocation trace ID
Generic Paginated Response
dataList
false
none
Data List
List of collateral transaction data.
nextPageOffsetData
string
false
none
Next Page Offset
Offset for retrieving the next page. If no next page data, empty string.
position
code
string
false
none
Status Code
Returns "SUCCESS" on success; otherwise, it indicates failure.
data
false
none
Response Data
Correct response data.
errorParam
object
false
none
Error Parameters
Error message parameter information
requestTime
string(timestamp)
false
none
Server Request Time
Time at which the server received the request
responseTime
string(timestamp)
false
none
Server Response Time
Time at which the server sent the response
traceId
string
false
none
Trace ID
Invocation trace ID
Properties
code
string
false
none
Status Code
Returns "SUCCESS" on success; otherwise, it indicates failure.
data
false
none
Generic Paginated Response
Generic paginated response.
errorParam
object
false
none
Error Parameters
Error message parameter information
requestTime
string(timestamp)
false
none
Server Request Time
Time at which the server received the request
responseTime
string(timestamp)
false
none
Server Response Time
Time at which the server sent the response
traceId
string
false
none
Trace ID
Invocation trace ID
Generic Paginated Response
dataList
false
none
Data List
List of position term data.
nextPageOffsetData
string
false
none
Next Page Offset
Offset for retrieving the next page. If no next page data, empty string.
Position term information
userId
string
false
none
User ID
ID of the owning user.
accountId
string
false
none
Account ID
ID of the owning account.
coinId
string
false
none
Collateral Coin ID
ID of the associated collateral coin.
contractId
string
false
none
Contract ID
ID of the associated contract.
termCount
integer(int32)
false
none
Term Count
Term count. Starts from 1, increases by one each time a position is fully closed and then re-opened.
cumOpenSize
string
false
none
Cumulative Open Size
Cumulative open size.
cumOpenValue
string
false
none
Cumulative Open Value
Cumulative open value.
cumOpenFee
string
false
none
Cumulative Open Fee
Cumulative open fees.
cumCloseSize
string
false
none
Cumulative Close Size
Cumulative close size.
cumCloseValue
string
false
none
Cumulative Close Value
Cumulative close value.
cumCloseFee
string
false
none
Cumulative Close Fee
Cumulative close fees.
cumFundingFee
string
false
none
Cumulative Funding Fee
Cumulative funding fees that have been settled.
cumLiquidateFee
string
false
none
Cumulative Liquidation Fee
Cumulative liquidation fees.
createdTime
string(int64)
false
none
Creation Time
Creation time.
updatedTime
string(int64)
false
none
Update Time
Update time.
currentLeverage
string
false
none
Leverage at Close
Leverage multiple at the time of close position.
positiontransaction
code
string
false
none
Status Code
Returns "SUCCESS" on success; otherwise, it indicates failure.
data
false
none
Response Data
Correct response data.
errorParam
object
false
none
Error Parameters
Error message parameter information
requestTime
string(timestamp)
false
none
Server Request Time
Time at which the server received the request
responseTime
string(timestamp)
false
none
Server Response Time
Time at which the server sent the response
traceId
string
false
none
Trace ID
Invocation trace ID
Perpetual contract position transaction details
id
string(int64)
false
none
Unique Identifier
Unique identifier.
userId
string(int64)
false
none
User ID
ID of the owning user.
accountId
string(int64)
false
none
Account ID
ID of the owning account.
coinId
string(int64)
false
none
Collateral Coin ID
ID of the associated collateral coin.
contractId
string(int64)
false
none
Contract ID
ID of the associated contract.
type
string
false
none
Detail Type
Detail type.
deltaOpenSize
string
false
none
Change in Open Size
Change in holding size.
deltaOpenValue
string
false
none
Change in Open Value
Change in open value.
deltaOpenFee
string
false
none
Change in Open Fee
Change in open fee.
deltaFundingFee
string
false
none
Change in Funding Fee
Change in funding fee.
beforeOpenSize
string
false
none
Open Size Before Change
Holding size before the change.
beforeOpenValue
string
false
none
Open Value Before Change
Open value before the change.
beforeOpenFee
string
false
none
Open Fee Before Change
Open fee before the change.
beforeFundingFee
string
false
none
Funding Fee Before Change
Funding fee before the change.
fillCloseSize
string
false
none
Transaction Close Size
Transaction close size (positive for buy, negative for sell).
fillCloseValue
string
false
none
Transaction Close Value
Transaction close value (positive for buy, negative for sell).
fillCloseFee
string
false
none
Transaction Close Fee
Transaction close fee (typically zero or negative).
fillOpenSize
string
false
none
Transaction Open Size
Transaction open size (positive for buy, negative for sell).
fillOpenValue
string
false
none
Transaction Open Value
Transaction open value (positive for buy, negative for sell).
fillOpenFee
string
false
none
Transaction Open Fee
Transaction open fee (typically zero or negative).
fillPrice
string
false
none
Transaction Price
Transaction price (not precise, for display).
liquidateFee
string
false
none
Liquidation Fee
Liquidation fee (if close transaction is a liquidation, typically zero or negative).
realizePnl
string
false
none
Realized Profit and Loss
Realized profit and loss from a close (if a close transaction. Not precise, for display).
isLiquidate
boolean
false
none
Is Liquidation
Whether the transaction is a liquidation.
isDeleverage
boolean
false
none
Is Auto-Deleveraging
Whether the transaction is from auto-deleveraging.
fundingTime
string(int64)
false
none
Funding Settlement Time
Funding settlement time.
fundingRate
string
false
none
Funding Rate
Funding rate.
fundingIndexPrice
string
false
none
Funding Index Price
Index price related to funding rate.
fundingOraclePrice
string
false
none
Funding Oracle Price
Oracle price related to funding rate.
fundingPositionSize
string
false
none
Position Size During Funding Settlement
Position size during funding settlement (positive for long, negative for short).
orderId
string(int64)
false
none
Order ID
Associated order ID.
orderFillTransactionId
string(int64)
false
none
Order Fill Transaction ID
Associated order fill transaction ID.
collateralTransactionId
string(int64)
false
none
Collateral Transaction ID
Associated collateral transaction detail ID.
forceTradeId
string
false
none
Force Trade ID
Associated force trade order ID.
extraType
string
false
none
Extra Type
Extra type for upper-layer business use.
extraDataJson
string
false
none
Extra Data
Extra data in JSON format, default is empty string.
censorStatus
string
false
none
Current Censoring Status
Current censoring status.
censorTxId
string(int64)
false
none
Censoring Processing Sequence Number
Censoring processing sequence number, exists when censor_status=CENSOR_SUCCESS/CENSOR_FAILURE/L2_APPROVED/L2_REJECT/L2_REJECT_APPROVED.
censorTime
string(int64)
false
none
Censoring Processing Time
Censoring processing time, exists when censor_status=CENSOR_SUCCESS/CENSOR_FAILURE/L2_APPROVED/L2_REJECT/L2_REJECT_APPROVED.
censorFailCode
string
false
none
Censoring Failure Code
Censoring failure code, exists when censor_status=CENSOR_FAILURE.
censorFailReason
string
false
none
Censoring Failure Reason
Censoring failure reason, exists when censor_status=CENSOR_FAILURE.
l2TxId
string(int64)
false
none
L2 Push Transaction ID
L2 push transaction ID, exists when censor_status=CENSOR_SUCCESS/L2_APPROVED/L2_REJECT/L2_REJECT_APPROVED.
l2RejectTime
string(int64)
false
none
L2 Rejection Time
L2 rejection time, exists when censor_status=L2_REJECT/L2_REJECT_APPROVED.
l2RejectCode
string
false
none
L2 Rejection Error Code
L2 rejection error code, exists when censor_status=L2_REJECT/L2_REJECT_APPROVED.
l2RejectReason
string
false
none
L2 Rejection Reason
L2 rejection reason, exists when censor_status=L2_REJECT/L2_REJECT_APPROVED.
l2ApprovedTime
string(int64)
false
none
L2 Batch Verification Time
L2 batch verification time, exists when censor_status=L2_APPROVED/L2_REJECT_APPROVED.
createdTime
string(int64)
false
none
Creation Time
Creation time.
updatedTime
string(int64)
false
none
Update Time
Update time.
Enumerated Values
type
UNKNOWN_POSITION_TRANSACTION_TYPE
type
BUY_POSITION
type
SELL_POSITION
type
SETTLE_FUNDING_FEE
type
BUG_FIX_POSITION_TRANSACTION_TYPE
type
UNRECOGNIZED
censorStatus
UNKNOWN_TRANSACTION_STATUS
censorStatus
INIT
censorStatus
CENSOR_SUCCESS
censorStatus
CENSOR_FAILURE
censorStatus
L2_APPROVED
censorStatus
L2_REJECT
censorStatus
L2_REJECT_APPROVED
censorStatus
UNRECOGNIZED
PositiontransactionPage
code
string
false
none
Status Code
Returns "SUCCESS" on success; otherwise, it indicates failure.
data
false
none
Generic Paginated Response
Generic paginated response.
errorParam
object
false
none
Error Parameters
Error message parameter information
requestTime
string(timestamp)
false
none
Server Request Time
Time at which the server received the request
responseTime
string(timestamp)
false
none
Server Response Time
Time at which the server sent the response
traceId
string
false
none
Trace ID
Invocation trace ID
Generic Paginated Response
dataList
false
none
Data List
List of position transaction data.
nextPageOffsetData
string
false
none
Next Page Offset
Offset for retrieving the next page. If no next page data, empty string.
Last updated