List Challenges
curl --request GET \
--url https://api.example.com/api/challenges/ \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/api/challenges/"
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/challenges/', 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/challenges/",
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/challenges/"
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/challenges/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/challenges/")
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,
"short_code": "<string>",
"prop_firm_slug": "<string>",
"phases": [
{
"id": 123,
"prop_firm_slug": "<string>",
"initial_balance": "<string>",
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z",
"title": "<string>",
"description": "<string>",
"step": 2,
"global_drawdown_threshold_usd_currency": "<string>",
"max_trailing_drawdown_limit_currency": "<string>",
"daily_drawdown_usd_currency": "<string>",
"maximum_drawdown_usd_currency": "<string>",
"prop_firm": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"live": false,
"global_drawdown_type": "STATIC",
"global_drawdown_threshold": "<string>",
"global_drawdown_threshold_usd": "<string>",
"lock_drawdown_withdrawal": true,
"lock_trailing_drawdown": true,
"max_trailing_drawdown_limit": "<string>",
"max_trailing_drawdown_limit_interpretation": "offset",
"soft_breach": true,
"target_profit": "<string>",
"daily_drawdown": "<string>",
"daily_drawdown_usd": "0.00",
"check_daily_drawdown": true,
"maximum_drawdown": "<string>",
"maximum_drawdown_usd": "0.00",
"trading_period_days": 0,
"leverage": "<string>",
"scaling_plan": false,
"minimum_trading_days": -1,
"consistency_percentage": "<string>",
"auto_pass": true,
"eod_flatten": false,
"matchtrader_offer_id": "<string>",
"metatrader_group_id": "<string>",
"metatrader5_group_id": "<string>",
"tradelocker_group_id": "<string>",
"ctrader_group_id": "<string>",
"volumetrica_groupUniverseId": "<string>",
"sim2funded_account_template": 1073741823,
"tradovate_account_template": 1073741823,
"volumetric_account_ruleID": "<string>",
"tradovateTrailingMaxDrawdownMode": "EOD",
"challenge": 123
}
],
"allowed_exchanges": "<string>",
"allowed_symbols": "<string>",
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z",
"title": "<string>",
"description": "<string>",
"global_drawdown_threshold_usd_currency": "<string>",
"max_trailing_drawdown_limit_currency": "<string>",
"initial_balance_currency": "<string>",
"prop_firm": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"swap_mode": "NORMAL",
"steps": 2,
"product_id": 1073741823,
"broker_type": "MatchTrade",
"global_drawdown_type": "STATIC",
"global_drawdown_threshold": "1.00",
"global_drawdown_threshold_usd": "0.00",
"lock_drawdown_withdrawal": true,
"lock_trailing_drawdown": false,
"max_trailing_drawdown_limit": "<string>",
"activation_fee_product_id": "<string>",
"soft_breach": false,
"no_activation_fee": false,
"initial_balance": "0.00",
"is_free_trial": false,
"is_competition": false,
"news_trading_enabled": false,
"archived": false,
"profit_split": "<string>",
"minimum_profit_type": "ABSOLUTE",
"minimum_profit": "<string>",
"maximum_profit_type": "ABSOLUTE",
"maximum_profit": "<string>",
"partial_payout": false,
"default_max_order_size": -1,
"max_position_size_account": "<string>"
}
]
}Challenge
List Challenges
Returns a paginated list of Challenges for your firm, including nested phases, allowed exchange limits, and individual symbol limits.
GET
/
api
/
challenges
/
List Challenges
curl --request GET \
--url https://api.example.com/api/challenges/ \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/api/challenges/"
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/challenges/', 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/challenges/",
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/challenges/"
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/challenges/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/challenges/")
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,
"short_code": "<string>",
"prop_firm_slug": "<string>",
"phases": [
{
"id": 123,
"prop_firm_slug": "<string>",
"initial_balance": "<string>",
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z",
"title": "<string>",
"description": "<string>",
"step": 2,
"global_drawdown_threshold_usd_currency": "<string>",
"max_trailing_drawdown_limit_currency": "<string>",
"daily_drawdown_usd_currency": "<string>",
"maximum_drawdown_usd_currency": "<string>",
"prop_firm": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"live": false,
"global_drawdown_type": "STATIC",
"global_drawdown_threshold": "<string>",
"global_drawdown_threshold_usd": "<string>",
"lock_drawdown_withdrawal": true,
"lock_trailing_drawdown": true,
"max_trailing_drawdown_limit": "<string>",
"max_trailing_drawdown_limit_interpretation": "offset",
"soft_breach": true,
"target_profit": "<string>",
"daily_drawdown": "<string>",
"daily_drawdown_usd": "0.00",
"check_daily_drawdown": true,
"maximum_drawdown": "<string>",
"maximum_drawdown_usd": "0.00",
"trading_period_days": 0,
"leverage": "<string>",
"scaling_plan": false,
"minimum_trading_days": -1,
"consistency_percentage": "<string>",
"auto_pass": true,
"eod_flatten": false,
"matchtrader_offer_id": "<string>",
"metatrader_group_id": "<string>",
"metatrader5_group_id": "<string>",
"tradelocker_group_id": "<string>",
"ctrader_group_id": "<string>",
"volumetrica_groupUniverseId": "<string>",
"sim2funded_account_template": 1073741823,
"tradovate_account_template": 1073741823,
"volumetric_account_ruleID": "<string>",
"tradovateTrailingMaxDrawdownMode": "EOD",
"challenge": 123
}
],
"allowed_exchanges": "<string>",
"allowed_symbols": "<string>",
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z",
"title": "<string>",
"description": "<string>",
"global_drawdown_threshold_usd_currency": "<string>",
"max_trailing_drawdown_limit_currency": "<string>",
"initial_balance_currency": "<string>",
"prop_firm": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"swap_mode": "NORMAL",
"steps": 2,
"product_id": 1073741823,
"broker_type": "MatchTrade",
"global_drawdown_type": "STATIC",
"global_drawdown_threshold": "1.00",
"global_drawdown_threshold_usd": "0.00",
"lock_drawdown_withdrawal": true,
"lock_trailing_drawdown": false,
"max_trailing_drawdown_limit": "<string>",
"activation_fee_product_id": "<string>",
"soft_breach": false,
"no_activation_fee": false,
"initial_balance": "0.00",
"is_free_trial": false,
"is_competition": false,
"news_trading_enabled": false,
"archived": false,
"profit_split": "<string>",
"minimum_profit_type": "ABSOLUTE",
"minimum_profit": "<string>",
"maximum_profit_type": "ABSOLUTE",
"maximum_profit": "<string>",
"partial_payout": false,
"default_max_order_size": -1,
"max_position_size_account": "<string>"
}
]
}Authorizations
Token-based authentication with required prefix "Token"
Query Parameters
A page number within the paginated result set.
Number of results to return per page.
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