List users
curl --request GET \
--url https://api.example.com/api/users/ \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/api/users/"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/users/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/users/")
.header("Authorization", "<api-key>")
.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::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"meta": {
"count": 123,
"page": 1,
"page_size": 20,
"total_pages": 7,
"has_next": true,
"has_previous": false,
"next": "https://api.example.org/resources/?page=2",
"previous": null
},
"results": [
{
"id": 123,
"email": "jane.doe@example.com",
"full_name": "Jane Doe",
"ip_addresses": [
"203.0.113.42",
"198.51.100.17"
],
"country_code": "US",
"state": "CA",
"postcode": "94105",
"kyc_verified": "verified",
"city": "San Francisco",
"address_1": "123 Market Street",
"address_2": "Suite 500",
"phone": "+1-415-555-0199",
"blocked": false,
"prop_firm": {
"prop_firm_id": "507ede8b-951d-4c38-877a-f242463ce14f",
"prop_firm_name": "Example Firm",
"prop_firm_slug": "example-firm",
"account_count": 42,
"created_at": "2021-06-18T10:42:15Z",
"contact_email": "support@example.com"
},
"user_type": "pro",
"total_accounts_purchased": 12,
"total_active_accounts": 8,
"total_failed_accounts": 4,
"duplicate_group": {
"count": 2,
"emails": [
"jane.doe@example.com",
"jane.alt@example.com"
],
"csv": "jane.doe@example.com,jane.alt@example.com"
},
"trading_status": "enabled",
"entitlements": [
{
"name": "CME Market Data",
"data_level": "l1",
"exchanges": [
"cbot",
"nymex"
],
"status": "AUTHORIZED",
"authorized_at": "2026-03-20T09:15:00Z"
}
]
}
]
}Users
List users
Returns paginated users for your firm, including account counts.
GET
/
api
/
users
/
List users
curl --request GET \
--url https://api.example.com/api/users/ \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/api/users/"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/users/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/users/")
.header("Authorization", "<api-key>")
.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::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"meta": {
"count": 123,
"page": 1,
"page_size": 20,
"total_pages": 7,
"has_next": true,
"has_previous": false,
"next": "https://api.example.org/resources/?page=2",
"previous": null
},
"results": [
{
"id": 123,
"email": "jane.doe@example.com",
"full_name": "Jane Doe",
"ip_addresses": [
"203.0.113.42",
"198.51.100.17"
],
"country_code": "US",
"state": "CA",
"postcode": "94105",
"kyc_verified": "verified",
"city": "San Francisco",
"address_1": "123 Market Street",
"address_2": "Suite 500",
"phone": "+1-415-555-0199",
"blocked": false,
"prop_firm": {
"prop_firm_id": "507ede8b-951d-4c38-877a-f242463ce14f",
"prop_firm_name": "Example Firm",
"prop_firm_slug": "example-firm",
"account_count": 42,
"created_at": "2021-06-18T10:42:15Z",
"contact_email": "support@example.com"
},
"user_type": "pro",
"total_accounts_purchased": 12,
"total_active_accounts": 8,
"total_failed_accounts": 4,
"duplicate_group": {
"count": 2,
"emails": [
"jane.doe@example.com",
"jane.alt@example.com"
],
"csv": "jane.doe@example.com,jane.alt@example.com"
},
"trading_status": "enabled",
"entitlements": [
{
"name": "CME Market Data",
"data_level": "l1",
"exchanges": [
"cbot",
"nymex"
],
"status": "AUTHORIZED",
"authorized_at": "2026-03-20T09:15:00Z"
}
]
}
]
}Authorizations
Token-based authentication with required prefix "Token"
Query Parameters
pro- Professionalnon_pro- Non-Professional
Available options:
non_pro, pro Case-insensitive exact match on user email.
Sort by allowed fields only: created, email, full_name, prop_firm__slug, user_type. Supports single (order_by=email), descending (order_by=-created), and multi-column (order_by=email,-created).
A page number within the paginated result set.
Number of results to return per page.
Comma-separated firm IDs where the user has an active membership.
Comma-separated firm slugs where the user has an active membership.
Case-insensitive partial match across user id, email, and full_name.
Filter by self-cert classification. Supported values: pro, non_pro.
Response
200 - application/json
Pagination metadata. Use has_next/has_previous for boolean page checks and next/previous for page URLs.
Show child attributes
Show child attributes
Example:
{
"count": 123,
"page": 1,
"page_size": 20,
"total_pages": 7,
"has_next": true,
"has_previous": false,
"next": "https://api.example.org/resources/?page=2",
"previous": null
}
Show child attributes
Show child attributes