Submit a close request for one account and symbol
curl --request PATCH \
--url https://api.example.com/api/trade/positions/close/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": 2,
"symbol": "<string>",
"triggered_by": "<string>",
"user_id": 2
}
'import requests
url = "https://api.example.com/api/trade/positions/close/"
payload = {
"account_id": 2,
"symbol": "<string>",
"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, symbol: '<string>', triggered_by: '<string>', user_id: 2})
};
fetch('https://api.example.com/api/trade/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/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,
'symbol' => '<string>',
'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/positions/close/"
payload := strings.NewReader("{\n \"account_id\": 2,\n \"symbol\": \"<string>\",\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/positions/close/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": 2,\n \"symbol\": \"<string>\",\n \"triggered_by\": \"<string>\",\n \"user_id\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/trade/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 \"symbol\": \"<string>\",\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 a close request for one account and symbol
Submits a close request for the specified account and symbol. Staff users can operate on any position for the authenticated firm, while non-staff users are limited to their own accounts. triggered_by is optional and defaults to authenticated user metadata when omitted.
PATCH
/
api
/
trade
/
positions
/
close
/
Submit a close request for one account and symbol
curl --request PATCH \
--url https://api.example.com/api/trade/positions/close/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": 2,
"symbol": "<string>",
"triggered_by": "<string>",
"user_id": 2
}
'import requests
url = "https://api.example.com/api/trade/positions/close/"
payload = {
"account_id": 2,
"symbol": "<string>",
"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, symbol: '<string>', triggered_by: '<string>', user_id: 2})
};
fetch('https://api.example.com/api/trade/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/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,
'symbol' => '<string>',
'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/positions/close/"
payload := strings.NewReader("{\n \"account_id\": 2,\n \"symbol\": \"<string>\",\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/positions/close/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": 2,\n \"symbol\": \"<string>\",\n \"triggered_by\": \"<string>\",\n \"user_id\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/trade/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 \"symbol\": \"<string>\",\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
Token-based authentication with required prefix "Token"
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Required range:
x >= 1Maximum string length:
50Optional actor label. Defaults to the authenticated user's email, name, or identifier, then 'system'.
Maximum string length:
255Optional user identifier to associate with the close request. Defaults to the account owner.
Required range:
x >= 1Response
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.
Indicates whether the operation completed successfully.
List containing the result items produced by the operation. The structure of each item depends on the executed operation.
Aggregated summary information about the operation results (e.g. counts of updated, created, failed or unchanged records).
Show child attributes
Show child attributes
Execution time of the operation in milliseconds.
Optional human-readable message describing the operation outcome.