Submit close requests for all open positions for an account

curl --request PATCH \
  --url https://api.example.com/api/trade/accounts/{account_id}/positions/close/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": 2,
  "triggered_by": "<string>",
  "user_id": 2
}
'

import requests

url = "https://api.example.com/api/trade/accounts/{account_id}/positions/close/"

payload = {
    "account_id": 2,
    "triggered_by": "<string>",
    "user_id": 2
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_id: 2, triggered_by: '<string>', user_id: 2})
};

fetch('https://api.example.com/api/trade/accounts/{account_id}/positions/close/', 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://api.example.com/api/trade/accounts/{account_id}/positions/close/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => 2,
    'triggered_by' => '<string>',
    'user_id' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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://api.example.com/api/trade/accounts/{account_id}/positions/close/"

	payload := strings.NewReader("{\n  \"account_id\": 2,\n  \"triggered_by\": \"<string>\",\n  \"user_id\": 2\n}")

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

	req.Header.Add("Authorization", "<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.patch("https://api.example.com/api/trade/accounts/{account_id}/positions/close/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": 2,\n  \"triggered_by\": \"<string>\",\n  \"user_id\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/trade/accounts/{account_id}/positions/close/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": 2,\n  \"triggered_by\": \"<string>\",\n  \"user_id\": 2\n}"

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

{
  "success": true,
  "results": [
    "<unknown>"
  ],
  "summary": {},
  "duration_ms": 123,
  "message": "<string>"
}

Trade

Submit close requests for all open positions for an account

Submits close requests for each open symbol exposure on the specified account. Staff users can operate on any account for the authenticated firm, while non-staff users are limited to their own accounts. The response reports submitted and failed symbol requests; a 200 response does not guarantee every symbol request succeeded. triggered_by is optional and defaults to authenticated user metadata when omitted.

PATCH

api

trade

accounts

{account_id}

positions

Submit close requests for all open positions for an account

curl --request PATCH \
  --url https://api.example.com/api/trade/accounts/{account_id}/positions/close/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": 2,
  "triggered_by": "<string>",
  "user_id": 2
}
'

import requests

url = "https://api.example.com/api/trade/accounts/{account_id}/positions/close/"

payload = {
    "account_id": 2,
    "triggered_by": "<string>",
    "user_id": 2
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_id: 2, triggered_by: '<string>', user_id: 2})
};

fetch('https://api.example.com/api/trade/accounts/{account_id}/positions/close/', 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://api.example.com/api/trade/accounts/{account_id}/positions/close/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => 2,
    'triggered_by' => '<string>',
    'user_id' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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://api.example.com/api/trade/accounts/{account_id}/positions/close/"

	payload := strings.NewReader("{\n  \"account_id\": 2,\n  \"triggered_by\": \"<string>\",\n  \"user_id\": 2\n}")

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

	req.Header.Add("Authorization", "<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.patch("https://api.example.com/api/trade/accounts/{account_id}/positions/close/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": 2,\n  \"triggered_by\": \"<string>\",\n  \"user_id\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/trade/accounts/{account_id}/positions/close/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": 2,\n  \"triggered_by\": \"<string>\",\n  \"user_id\": 2\n}"

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

{
  "success": true,
  "results": [
    "<unknown>"
  ],
  "summary": {},
  "duration_ms": 123,
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Path Parameters

account_id

integer

required

Body

account_id

integer

Required range: x >= 1

triggered_by

string

Optional actor label. Defaults to the authenticated user's email, name, or identifier, then 'system'.

Maximum string length: 255

user_id

integer

Optional user identifier to associate with the close request. Defaults to the account owner.

Required range: x >= 1

Response

200 - application/json

Standard serializer for operation responses. A command or a task should return a response matching this format. Operation = a request to perform some action, e.g. sync, update, delete, create, etc.

success

boolean

required

Indicates whether the operation completed successfully.

results

any[]

required

List containing the result items produced by the operation. The structure of each item depends on the executed operation.

summary

object

required

Aggregated summary information about the operation results (e.g. counts of updated, created, failed or unchanged records).

Show child attributes

duration_ms

number<double>

required

Execution time of the operation in milliseconds.

message

string | null

Optional human-readable message describing the operation outcome.

Accounts

Challenge

Entitlements

Status

Trade

Users

withdrawals

Auth

Submit close requests for all open positions for an account

Authorizations

Path Parameters

Body

Response