Open Positions

POST /api/v4/collateral-account/positions/open

Open Positions

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/collateral-account/positions/open \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "market": "BTC_USDT",
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'

import requests

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

payload = {
    "market": "BTC_USDT",
    "request": "{{request}}",
    "nonce": "{{nonce}}"
}
headers = {
    "X-TXC-APIKEY": "<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>', 'Content-Type': 'application/json'},
  body: JSON.stringify({market: 'BTC_USDT', request: '{{request}}', nonce: '{{nonce}}'})
};

fetch('https://whitebit.com/api/v4/collateral-account/positions/open', 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/open",
  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([
    'market' => 'BTC_USDT',
    'request' => '{{request}}',
    'nonce' => '{{nonce}}'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-TXC-APIKEY: <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/open"

	payload := strings.NewReader("{\n  \"market\": \"BTC_USDT\",\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}")

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

	req.Header.Add("X-TXC-APIKEY", "<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/open")
  .header("X-TXC-APIKEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"market\": \"BTC_USDT\",\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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["Content-Type"] = 'application/json'
request.body = "{\n  \"market\": \"BTC_USDT\",\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}"

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

200

[
  {
    "positionId": 527,
    "market": "BTC_USDT",
    "openDate": 1651568067.789679,
    "modifyDate": 1651568067.789679,
    "amount": "0.1",
    "basePrice": "45658.349",
    "liquidationPrice": null,
    "liquidationState": "margin_call",
    "pnl": "-168.42",
    "pnlPercent": "-0.43",
    "margin": "8316.74",
    "freeMargin": "619385.67",
    "funding": "0",
    "unrealizedFunding": "0.0019142920201966",
    "tpsl": {
      "takeProfitId": 123,
      "takeProfit": "50000",
      "stopLossId": 124,
      "stopLoss": "35000"
    },
    "positionSide": "LONG"
  },
  {
    "positionId": 528,
    "market": "ETH_USDT",
    "openDate": 1651568067.789679,
    "modifyDate": 1651568067.789679,
    "amount": "0.1",
    "basePrice": "5658.349",
    "liquidationPrice": null,
    "liquidationState": "margin_call",
    "pnl": "-168.42",
    "pnlPercent": "-0.43",
    "margin": "8316.74",
    "freeMargin": "19385.67",
    "funding": "0",
    "unrealizedFunding": "0.0020142920201966",
    "tpsl": null,
    "positionSide": "LONG"
  }
]

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

Authorizations

X-TXC-APIKEY · string · header · required

API Key authentication for private endpoints.

Required headers:

• X-TXC-APIKEY: API key
• X-TXC-PAYLOAD: Base64 encoded JSON payload
• X-TXC-SIGNATURE: HMAC SHA512 signature

Body

application/json

market · string

Filter by specific market. For example: BTC_USDT

If not specified, returns all open positions.

Example:

"BTC_USDT"

request · string

Request signature

Example:

"{{request}}"

nonce · string

Unique request identifier

Example:

"{{nonce}}"

Response

200

application/json

Successful response - returns array of open positions

positionId · integer

Unique position identifier

Example:

527

market · string

Market name

Example:

"BTC_USDT"

amount · string

Position amount

Example:

"0.1"

basePrice · string

Base price of position

Example:

"45658.349"

liqPrice · string | null

Liquidation price according to current state of position

Example:

"40000.00"

pnl · string

Unrealized profit and loss in money

Example:

"-168.42"

pnlPercent · string

Unrealized profit and loss in percentage

Example:

"-0.43"

margin · string

Amount of funds in open position money

Example:

"8316.74"

freeMargin · string

Free funds for trading

Example:

"619385.67"

funding · string

Funding that will be paid on next position stage change

Example:

"0"

unrealizedPnl · string

Unrealized profit and loss

Example:

"0.0019142920201966"

positionSide · enum<string>

Position side

Available options: LONG, SHORT, BOTH

Example:

"LONG"

openDate · number

Date of position opening in Unix timestamp format

Example:

1651568067.789679

modifyDate · number

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

Example:

1651568067.789679

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

tpsl · object | null

Take profit and stop loss configuration

Show child attributes

unrealizedFunding · string

Funding that will be paid on next position stage change

Example:

"0.0019142920201966"