Closed-position PNL

curl --request POST \
  --url https://whitebit.com/api/v4/collateral-account/positions/closed-pnl \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --header 'X-TXC-PAYLOAD: <api-key>' \
  --header 'X-TXC-SIGNATURE: <api-key>' \
  --data '
{
  "startDate": 1778000000,
  "endDate": 1778100000,
  "limit": 50,
  "offset": 0,
  "request": "{{request}}",
  "nonce": 1594297865000
}
'

import requests

url = "https://whitebit.com/api/v4/collateral-account/positions/closed-pnl"

payload = {
    "startDate": 1778000000,
    "endDate": 1778100000,
    "limit": 50,
    "offset": 0,
    "request": "{{request}}",
    "nonce": 1594297865000
}
headers = {
    "X-TXC-APIKEY": "<api-key>",
    "X-TXC-PAYLOAD": "<api-key>",
    "X-TXC-SIGNATURE": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-TXC-APIKEY': '<api-key>',
    'X-TXC-PAYLOAD': '<api-key>',
    'X-TXC-SIGNATURE': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    startDate: 1778000000,
    endDate: 1778100000,
    limit: 50,
    offset: 0,
    request: '{{request}}',
    nonce: 1594297865000
  })
};

fetch('https://whitebit.com/api/v4/collateral-account/positions/closed-pnl', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://whitebit.com/api/v4/collateral-account/positions/closed-pnl",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'startDate' => 1778000000,
    'endDate' => 1778100000,
    'limit' => 50,
    'offset' => 0,
    'request' => '{{request}}',
    'nonce' => 1594297865000
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-TXC-APIKEY: <api-key>",
    "X-TXC-PAYLOAD: <api-key>",
    "X-TXC-SIGNATURE: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://whitebit.com/api/v4/collateral-account/positions/closed-pnl"

	payload := strings.NewReader("{\n  \"startDate\": 1778000000,\n  \"endDate\": 1778100000,\n  \"limit\": 50,\n  \"offset\": 0,\n  \"request\": \"{{request}}\",\n  \"nonce\": 1594297865000\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-TXC-APIKEY", "<api-key>")
	req.Header.Add("X-TXC-PAYLOAD", "<api-key>")
	req.Header.Add("X-TXC-SIGNATURE", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://whitebit.com/api/v4/collateral-account/positions/closed-pnl")
  .header("X-TXC-APIKEY", "<api-key>")
  .header("X-TXC-PAYLOAD", "<api-key>")
  .header("X-TXC-SIGNATURE", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"startDate\": 1778000000,\n  \"endDate\": 1778100000,\n  \"limit\": 50,\n  \"offset\": 0,\n  \"request\": \"{{request}}\",\n  \"nonce\": 1594297865000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://whitebit.com/api/v4/collateral-account/positions/closed-pnl")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-TXC-APIKEY"] = '<api-key>'
request["X-TXC-PAYLOAD"] = '<api-key>'
request["X-TXC-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"startDate\": 1778000000,\n  \"endDate\": 1778100000,\n  \"limit\": 50,\n  \"offset\": 0,\n  \"request\": \"{{request}}\",\n  \"nonce\": 1594297865000\n}"

response = http.request(request)
puts response.read_body

[
  {
    "positionId": 111,
    "market": "BTC_USDT",
    "grossPnl": "43.85",
    "netPnl": "42.6",
    "totalTradeFee": "6.15",
    "totalFunding": "1.25",
    "avgEntryPrice": "61000",
    "avgExitPrice": "62000",
    "closedSize": "0.05",
    "amount": "0",
    "side": "LONG",
    "isHedge": true,
    "openDate": 1778000000,
    "closeDate": 1778077400
  },
  {
    "positionId": 98,
    "market": "ETH_USDT",
    "grossPnl": "-82.425",
    "netPnl": "-83.225",
    "totalTradeFee": "7.425",
    "totalFunding": "0.8",
    "avgEntryPrice": "2500",
    "avgExitPrice": "2450",
    "closedSize": "1.5",
    "amount": "0",
    "side": "BOTH",
    "isHedge": false,
    "openDate": 1777900000,
    "closeDate": 1778050000
  }
]

{
  "code": 30,
  "message": "Validation failed",
  "errors": {}
}

{
  "code": 30,
  "message": "Validation failed",
  "errors": {}
}

Closed-position PNL

curl --request POST \
  --url https://whitebit.com/api/v4/collateral-account/positions/closed-pnl \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --header 'X-TXC-PAYLOAD: <api-key>' \
  --header 'X-TXC-SIGNATURE: <api-key>' \
  --data '
{
  "startDate": 1778000000,
  "endDate": 1778100000,
  "limit": 50,
  "offset": 0,
  "request": "{{request}}",
  "nonce": 1594297865000
}
'

import requests

url = "https://whitebit.com/api/v4/collateral-account/positions/closed-pnl"

payload = {
    "startDate": 1778000000,
    "endDate": 1778100000,
    "limit": 50,
    "offset": 0,
    "request": "{{request}}",
    "nonce": 1594297865000
}
headers = {
    "X-TXC-APIKEY": "<api-key>",
    "X-TXC-PAYLOAD": "<api-key>",
    "X-TXC-SIGNATURE": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-TXC-APIKEY': '<api-key>',
    'X-TXC-PAYLOAD': '<api-key>',
    'X-TXC-SIGNATURE': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    startDate: 1778000000,
    endDate: 1778100000,
    limit: 50,
    offset: 0,
    request: '{{request}}',
    nonce: 1594297865000
  })
};

fetch('https://whitebit.com/api/v4/collateral-account/positions/closed-pnl', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://whitebit.com/api/v4/collateral-account/positions/closed-pnl",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'startDate' => 1778000000,
    'endDate' => 1778100000,
    'limit' => 50,
    'offset' => 0,
    'request' => '{{request}}',
    'nonce' => 1594297865000
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-TXC-APIKEY: <api-key>",
    "X-TXC-PAYLOAD: <api-key>",
    "X-TXC-SIGNATURE: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://whitebit.com/api/v4/collateral-account/positions/closed-pnl"

	payload := strings.NewReader("{\n  \"startDate\": 1778000000,\n  \"endDate\": 1778100000,\n  \"limit\": 50,\n  \"offset\": 0,\n  \"request\": \"{{request}}\",\n  \"nonce\": 1594297865000\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-TXC-APIKEY", "<api-key>")
	req.Header.Add("X-TXC-PAYLOAD", "<api-key>")
	req.Header.Add("X-TXC-SIGNATURE", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://whitebit.com/api/v4/collateral-account/positions/closed-pnl")
  .header("X-TXC-APIKEY", "<api-key>")
  .header("X-TXC-PAYLOAD", "<api-key>")
  .header("X-TXC-SIGNATURE", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"startDate\": 1778000000,\n  \"endDate\": 1778100000,\n  \"limit\": 50,\n  \"offset\": 0,\n  \"request\": \"{{request}}\",\n  \"nonce\": 1594297865000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://whitebit.com/api/v4/collateral-account/positions/closed-pnl")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-TXC-APIKEY"] = '<api-key>'
request["X-TXC-PAYLOAD"] = '<api-key>'
request["X-TXC-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"startDate\": 1778000000,\n  \"endDate\": 1778100000,\n  \"limit\": 50,\n  \"offset\": 0,\n  \"request\": \"{{request}}\",\n  \"nonce\": 1594297865000\n}"

response = http.request(request)
puts response.read_body

[
  {
    "positionId": 111,
    "market": "BTC_USDT",
    "grossPnl": "43.85",
    "netPnl": "42.6",
    "totalTradeFee": "6.15",
    "totalFunding": "1.25",
    "avgEntryPrice": "61000",
    "avgExitPrice": "62000",
    "closedSize": "0.05",
    "amount": "0",
    "side": "LONG",
    "isHedge": true,
    "openDate": 1778000000,
    "closeDate": 1778077400
  },
  {
    "positionId": 98,
    "market": "ETH_USDT",
    "grossPnl": "-82.425",
    "netPnl": "-83.225",
    "totalTradeFee": "7.425",
    "totalFunding": "0.8",
    "avgEntryPrice": "2500",
    "avgExitPrice": "2450",
    "closedSize": "1.5",
    "amount": "0",
    "side": "BOTH",
    "isHedge": false,
    "openDate": 1777900000,
    "closeDate": 1778050000
  }
]

{
  "code": 30,
  "message": "Validation failed",
  "errors": {}
}

{
  "code": 30,
  "message": "Validation failed",
  "errors": {}
}

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

startDate

integer

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

Example:

1778000000

endDate

integer

End of the query window as a Unix timestamp in seconds, applied to the position close time. Optional, no default. Must be ≥ startDate and ≤ now + 1s.

Example:

1778100000

limit

integer

default:50

Maximum number of records to return. Default: 50. Minimum: 1. Maximum: 100.

Required range: 1 <= x <= 100

Example:

50

offset

integer

default:0

Number of records to skip. Default: 0. The sum of offset and limit must not exceed 10000.

Required range: x >= 0

Example:

0

request

string

Example:

"{{request}}"

nonce

integer

Example:

1594297865000

Response

Successful response - returns an array with one aggregated record per closed position, sorted by closeDate descending, then positionId descending. Returns an empty array when no closed positions match the filters.

positionId

integer

Unique identifier of the closed position.

Example:

111

market

string

Market of the position. Format: BASE_QUOTE.

Example:

"BTC_USDT"

grossPnl

string

Realized profit and loss of the position before funding. Trading fees are already deducted from the value; totalTradeFee is informational and must not be subtracted again.

Example:

"43.85"

netPnl

string

Net profit and loss of the position: grossPnl minus totalFunding.

Example:

"42.6"

totalTradeFee

string

Sum of trading fees across all fills of the position, both opening and closing. Informational — already reflected in grossPnl and netPnl.

Example:

"6.15"

totalFunding

string

Cumulative funding fee over the whole position lifetime.

Example:

"1.25"

avgEntryPrice

string

Volume-weighted average price of the fills that increased the position, trimmed to the market money precision.

Example:

"61000"

avgExitPrice

string

Volume-weighted average price of the fills that reduced the position, trimmed to the market money precision.

Example:

"62000"

closedSize

string

Total closed volume in base currency — the sum of fills that reduced the position.

Example:

"0.05"

amount

string

Remaining position size. Always returns "0" — a closed position holds no size.

Example:

"0"

side

enum<string>

Position direction. Returns BOTH for positions opened with hedge mode disabled. See positionSide.

Available options:

LONG,

SHORT,

BOTH

Example:

"LONG"

isHedge

boolean

Whether the position was opened in hedge mode.

Example:

true

openDate

integer

Position open time as a Unix timestamp in seconds.

Example:

1778000000

closeDate

integer

Position close time as a Unix timestamp in seconds. Primary sort key, descending.

Example:

1778077400

⌘I