Create a trader user
curl --request POST \
--url https://api.example.com/api/users/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "trader@example.com",
"full_name": "John Trader",
"password1": "StrongPassword123!",
"password2": "StrongPassword123!",
"phone": "123456789",
"address_1": "Main St 123",
"address_2": "",
"city": "Denver",
"state": "Colorado",
"country_code": "US",
"postal_code": "7350000"
}
'import requests
url = "https://api.example.com/api/users/"
payload = {
"email": "trader@example.com",
"full_name": "John Trader",
"password1": "StrongPassword123!",
"password2": "StrongPassword123!",
"phone": "123456789",
"address_1": "Main St 123",
"address_2": "",
"city": "Denver",
"state": "Colorado",
"country_code": "US",
"postal_code": "7350000"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'trader@example.com',
full_name: 'John Trader',
password1: 'StrongPassword123!',
password2: 'StrongPassword123!',
phone: '123456789',
address_1: 'Main St 123',
address_2: '',
city: 'Denver',
state: 'Colorado',
country_code: 'US',
postal_code: '7350000'
})
};
fetch('https://api.example.com/api/users/', 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/users/",
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([
'email' => 'trader@example.com',
'full_name' => 'John Trader',
'password1' => 'StrongPassword123!',
'password2' => 'StrongPassword123!',
'phone' => '123456789',
'address_1' => 'Main St 123',
'address_2' => '',
'city' => 'Denver',
'state' => 'Colorado',
'country_code' => 'US',
'postal_code' => '7350000'
]),
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/users/"
payload := strings.NewReader("{\n \"email\": \"trader@example.com\",\n \"full_name\": \"John Trader\",\n \"password1\": \"StrongPassword123!\",\n \"password2\": \"StrongPassword123!\",\n \"phone\": \"123456789\",\n \"address_1\": \"Main St 123\",\n \"address_2\": \"\",\n \"city\": \"Denver\",\n \"state\": \"Colorado\",\n \"country_code\": \"US\",\n \"postal_code\": \"7350000\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.example.com/api/users/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"trader@example.com\",\n \"full_name\": \"John Trader\",\n \"password1\": \"StrongPassword123!\",\n \"password2\": \"StrongPassword123!\",\n \"phone\": \"123456789\",\n \"address_1\": \"Main St 123\",\n \"address_2\": \"\",\n \"city\": \"Denver\",\n \"state\": \"Colorado\",\n \"country_code\": \"US\",\n \"postal_code\": \"7350000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/users/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"trader@example.com\",\n \"full_name\": \"John Trader\",\n \"password1\": \"StrongPassword123!\",\n \"password2\": \"StrongPassword123!\",\n \"phone\": \"123456789\",\n \"address_1\": \"Main St 123\",\n \"address_2\": \"\",\n \"city\": \"Denver\",\n \"state\": \"Colorado\",\n \"country_code\": \"US\",\n \"postal_code\": \"7350000\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Trader user created.",
"results": [
{
"user_id": 42,
"email": "trader@example.com",
"full_name": "John Trader",
"is_active": true,
"is_staff": false,
"blocked": false,
"created": "2026-01-08T14:32:10Z",
"existing_user": false
}
],
"summary": {
"created": 1
},
"duration_ms": 31
}Users
Create a trader user
Create a trader user for your firm. The user can access only the trader dashboard and cannot access admin-only endpoints. If the email already belongs to an existing user, that user is granted access for your firm and the submitted password is ignored. Use results[].existing_user to decide whether to show the submitted onboarding password or tell the trader to use or reset their existing password.
POST
/
api
/
users
/
Create a trader user
curl --request POST \
--url https://api.example.com/api/users/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "trader@example.com",
"full_name": "John Trader",
"password1": "StrongPassword123!",
"password2": "StrongPassword123!",
"phone": "123456789",
"address_1": "Main St 123",
"address_2": "",
"city": "Denver",
"state": "Colorado",
"country_code": "US",
"postal_code": "7350000"
}
'import requests
url = "https://api.example.com/api/users/"
payload = {
"email": "trader@example.com",
"full_name": "John Trader",
"password1": "StrongPassword123!",
"password2": "StrongPassword123!",
"phone": "123456789",
"address_1": "Main St 123",
"address_2": "",
"city": "Denver",
"state": "Colorado",
"country_code": "US",
"postal_code": "7350000"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'trader@example.com',
full_name: 'John Trader',
password1: 'StrongPassword123!',
password2: 'StrongPassword123!',
phone: '123456789',
address_1: 'Main St 123',
address_2: '',
city: 'Denver',
state: 'Colorado',
country_code: 'US',
postal_code: '7350000'
})
};
fetch('https://api.example.com/api/users/', 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/users/",
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([
'email' => 'trader@example.com',
'full_name' => 'John Trader',
'password1' => 'StrongPassword123!',
'password2' => 'StrongPassword123!',
'phone' => '123456789',
'address_1' => 'Main St 123',
'address_2' => '',
'city' => 'Denver',
'state' => 'Colorado',
'country_code' => 'US',
'postal_code' => '7350000'
]),
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/users/"
payload := strings.NewReader("{\n \"email\": \"trader@example.com\",\n \"full_name\": \"John Trader\",\n \"password1\": \"StrongPassword123!\",\n \"password2\": \"StrongPassword123!\",\n \"phone\": \"123456789\",\n \"address_1\": \"Main St 123\",\n \"address_2\": \"\",\n \"city\": \"Denver\",\n \"state\": \"Colorado\",\n \"country_code\": \"US\",\n \"postal_code\": \"7350000\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.example.com/api/users/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"trader@example.com\",\n \"full_name\": \"John Trader\",\n \"password1\": \"StrongPassword123!\",\n \"password2\": \"StrongPassword123!\",\n \"phone\": \"123456789\",\n \"address_1\": \"Main St 123\",\n \"address_2\": \"\",\n \"city\": \"Denver\",\n \"state\": \"Colorado\",\n \"country_code\": \"US\",\n \"postal_code\": \"7350000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/users/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"trader@example.com\",\n \"full_name\": \"John Trader\",\n \"password1\": \"StrongPassword123!\",\n \"password2\": \"StrongPassword123!\",\n \"phone\": \"123456789\",\n \"address_1\": \"Main St 123\",\n \"address_2\": \"\",\n \"city\": \"Denver\",\n \"state\": \"Colorado\",\n \"country_code\": \"US\",\n \"postal_code\": \"7350000\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Trader user created.",
"results": [
{
"user_id": 42,
"email": "trader@example.com",
"full_name": "John Trader",
"is_active": true,
"is_staff": false,
"blocked": false,
"created": "2026-01-08T14:32:10Z",
"existing_user": false
}
],
"summary": {
"created": 1
},
"duration_ms": 31
}Authorizations
Token-based authentication with required prefix "Token"
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Maximum string length:
200Maximum string length:
100Minimum string length:
8Minimum string length:
8Maximum string length:
255Maximum string length:
100Maximum string length:
100Maximum string length:
4Maximum string length:
20Maximum string length:
32Maximum string length:
255Response
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.