Skip to main content
POST
/
api
/
v4
/
collateral-account
/
positions
/
history
Positions History
curl --request POST \
  --url https://whitebit.com/api/v4/collateral-account/positions/history \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --header 'X-TXC-PAYLOAD: <api-key>' \
  --header 'X-TXC-SIGNATURE: <api-key>' \
  --data '
{
  "market": "BTC_USDT",
  "positionId": 1,
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'
[
  {
    "positionId": 111,
    "market": "BTC_USDT",
    "openDate": 1650400589.882613,
    "modifyDate": 1650400589.882613,
    "amount": "0.1",
    "basePrice": "45658.349",
    "realizedFunding": "0",
    "liquidationPrice": null,
    "liquidationState": "margin_call",
    "orderDetail": {
      "id": 97067934,
      "tradeAmount": "0.1",
      "price": "41507.59",
      "tradeFee": "415.07",
      "fundingFee": null,
      "realizedPnl": null
    },
    "side": "LONG",
    "isHedge": false
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.whitebit.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-TXC-APIKEY
string
header
required

The public WhiteBIT API key.

​
X-TXC-PAYLOAD
string
header
required

Base64-encoded JSON request body.

​
X-TXC-SIGNATURE
string
header
required

HMAC-SHA512 signature of the payload, hex-encoded. Computed as hex(HMAC-SHA512(payload, api_secret)).

Body

application/json
​
market
string

Filter by specific market. Example: BTC_USDT

If not specified, returns position history for all markets.

Example:

"BTC_USDT"

​
positionId
integer

Filter by specific position identifier. If not specified, returns history for all positions.

Example:

1

​
startDate
integer

Start of the query window as a Unix timestamp in seconds. Optional, no default. Must be ≤ endDate.

Example:

1650400000

​
endDate
integer

End of the query window as a Unix timestamp in seconds. Optional, no default. Must be ≥ startDate and ≤ now + 1s; violating values are rejected with a validation error.

Example:

1650500000

​
request
string
Example:

"{{request}}"

​
nonce
string
Example:

"{{nonce}}"

Response

Successful response - returns array of position history

​
positionId
integer

Position identifier

Example:

111

​
market
string

Position market

Example:

"BTC_USDT"

​
openDate
number

Date of position opening in Unix timestamp format

Example:

1650400589.882613

​
modifyDate
number

Date of position modification (current event) in Unix timestamp format

Example:

1650400589.882613

​
amount
string

Position amount

Example:

"0.1"

​
basePrice
string

Base price of position

Example:

"45658.349"

​
realizedFunding
string

Funding fee for whole position lifetime till current state

Example:

"0"

​
liquidationPrice
string | null

Liquidation price according to current state of position

Example:

null

​
liquidationState
enum<string> | null

State of liquidation

Available options:
margin_call,
liquidation
Example:

null

​
orderDetail
object

Details of order which changes position

​
side
enum<string>

Position direction. BOTH indicates a one-way mode position; LONG or SHORT indicates a hedge mode position. See position side.

Available options:
LONG,
SHORT,
BOTH
Example:

"LONG"

​
isHedge
boolean

Indicates whether hedge mode was active when the position was opened. Hedge-mode toggling requires zero open positions, so the value also reflects the account mode at every event in the position's lifetime.

Example:

false