Demo
List demo organization plans
Returns available trading plans for a demo organization, including their rules (profit target, max loss, consistency template, etc.). Plans with accountType: sim_funded import as sim-funded accounts where consistency gates payouts instead of passing.
GET
/
v1
/
user
/
demo
/
organizations
/
{organizationId}
/
plans
List demo organization plans
curl --request GET \
--url https://api.hyperprop.com/platform/v1/user/demo/organizations/{organizationId}/plansimport requests
url = "https://api.hyperprop.com/platform/v1/user/demo/organizations/{organizationId}/plans"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.hyperprop.com/platform/v1/user/demo/organizations/{organizationId}/plans', 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.hyperprop.com/platform/v1/user/demo/organizations/{organizationId}/plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.hyperprop.com/platform/v1/user/demo/organizations/{organizationId}/plans"
req, _ := http.NewRequest("GET", url, nil)
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.hyperprop.com/platform/v1/user/demo/organizations/{organizationId}/plans")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/user/demo/organizations/{organizationId}/plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"organization": {
"id": "<string>",
"name": "FakePropFirm"
},
"plans": [
{
"id": "<string>",
"name": "50K Consistency Challenge",
"accountSize": 50000,
"price": 0,
"currency": "USD",
"accountType": "evaluation",
"rule": {
"id": "<string>",
"name": "50K Consistency Challenge Rules",
"description": "<string>",
"profitTarget": 3000,
"dailyProfit": 123,
"maxProfit": 123,
"dailyLoss": 1500,
"maxLoss": 2500,
"dailyDrawdown": 3,
"maxDrawdown": 5,
"consistency": 50,
"consistencyEnforced": true,
"consistencyBase": null,
"consistencyTolerancePct": 0.2,
"consistencyLeniency": 0,
"consistencyMinDays": 123,
"consistencyProfitableDayMin": 0,
"maxPayouts": 5,
"payoutMllLockOffset": 100,
"maxContracts": 123,
"microConversionRatio": 10
}
}
]
}
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "This organization does not offer demo accounts",
"code": "DEMO_NOT_ENABLED"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Organization not found",
"code": "ORG_NOT_FOUND"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}Related topics
List demo organizationsList demo accountsImport demo accountDelete demo accountIntroduction⌘I
List demo organization plans
curl --request GET \
--url https://api.hyperprop.com/platform/v1/user/demo/organizations/{organizationId}/plansimport requests
url = "https://api.hyperprop.com/platform/v1/user/demo/organizations/{organizationId}/plans"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.hyperprop.com/platform/v1/user/demo/organizations/{organizationId}/plans', 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.hyperprop.com/platform/v1/user/demo/organizations/{organizationId}/plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.hyperprop.com/platform/v1/user/demo/organizations/{organizationId}/plans"
req, _ := http.NewRequest("GET", url, nil)
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.hyperprop.com/platform/v1/user/demo/organizations/{organizationId}/plans")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/user/demo/organizations/{organizationId}/plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"organization": {
"id": "<string>",
"name": "FakePropFirm"
},
"plans": [
{
"id": "<string>",
"name": "50K Consistency Challenge",
"accountSize": 50000,
"price": 0,
"currency": "USD",
"accountType": "evaluation",
"rule": {
"id": "<string>",
"name": "50K Consistency Challenge Rules",
"description": "<string>",
"profitTarget": 3000,
"dailyProfit": 123,
"maxProfit": 123,
"dailyLoss": 1500,
"maxLoss": 2500,
"dailyDrawdown": 3,
"maxDrawdown": 5,
"consistency": 50,
"consistencyEnforced": true,
"consistencyBase": null,
"consistencyTolerancePct": 0.2,
"consistencyLeniency": 0,
"consistencyMinDays": 123,
"consistencyProfitableDayMin": 0,
"maxPayouts": 5,
"payoutMllLockOffset": 100,
"maxContracts": 123,
"microConversionRatio": 10
}
}
]
}
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "This organization does not offer demo accounts",
"code": "DEMO_NOT_ENABLED"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Organization not found",
"code": "ORG_NOT_FOUND"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}