Organization
Get a specific trading account
Retrieve complete details for a single trading account by its ID.
When to use this:
- Display account details in your trader dashboard
- Check account status and progress
- View performance data and rule compliance
- Get purchase and trader information
What you get:
- Account status, balances, total/daily P&L, drawdown inputs, and performance data
- Complete trading plan and rule configuration (daily/max limits, drawdown type, consistency, scaling, max contracts)
- Live consistency status (best day, daily cap, profitable days, blocking reasons)
- Payout-cycle state, processed payout count, loss floor, markets, and active lockout
- Organization identity (name/logo), trader, linked user, and purchase record
- Trader info (your customer details)
Example:
GET /organization/trading-accounts/7c9e6679-7425-40de-944b-e07fc1f90ae7
Understanding the response:
trader= Your customer info (from when you created the account)userId/userEmail= Hyperprop platform user (when they claim the account)violationReason= Why the account failed (e.g., “max_daily_loss”)consistency= Live engine calculation; null only when no consistency rule is configured or the engine is temporarily unavailable
GET
/
v1
/
organization
/
trading-accounts
/
{accountId}
Get a specific trading account
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId} \
--header 'Authorization: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}', 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/organization/trading-accounts/{accountId}",
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.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}"
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.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}")
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{
"success": true,
"data": {
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"accountNumber": "APEX-100K-7845",
"type": "evaluation",
"status": "in_progress",
"initialBalance": 100000,
"currentBalance": 105000,
"highWaterMark": 108000,
"dailyStartingBalance": 104000,
"totalPnl": 5000,
"dailyPnl": 1000,
"startedAt": "2025-01-15T10:00:00.000Z",
"completedAt": null,
"violationReason": null,
"metadata": {
"referredBy": "john@partner.com",
"prioritySupport": true
},
"performanceData": {},
"markets": [
"CME",
"CBOT",
"NYMEX",
"COMEX"
],
"cycleStartingBalance": 100000,
"cycleStartedAt": "<string>",
"cycleProfit": 5000,
"lossFloorBalance": 123,
"payoutCount": 0,
"completionPendingReason": "<string>",
"consistency": {},
"organization": {
"id": "<string>",
"name": "<string>",
"logoUrl": "<string>"
},
"lockout": {
"active": true,
"id": "<string>",
"mode": "<string>",
"reason": "<string>",
"lockedBy": "<string>",
"startsAt": "<string>",
"endsAt": "<string>",
"remainingMinutes": 123
},
"tradingPlan": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "100K Challenge",
"accountSize": 100000,
"durationDays": 123
},
"tradingRule": {
"id": "660e8400-e29b-41d4-a716-446655440000",
"name": "Standard Rules",
"description": "<string>",
"profitTarget": 10000,
"dailyProfit": 123,
"maxProfit": 123,
"dailyLoss": 2500,
"maxLoss": 5000,
"dailyDrawdown": 2.5,
"maxDrawdown": 5,
"drawdownType": "static",
"consistency": 30,
"consistencyEnforced": true,
"consistencyBase": "<string>",
"consistencyTolerancePct": 123,
"consistencyLeniency": 123,
"consistencyMinDays": 123,
"consistencyProfitableDayMin": 123,
"maxPayouts": 123,
"payoutMllLockOffset": 123,
"maxContracts": 5,
"microConversionRatio": 10,
"scalingPlan": {}
},
"userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
"userEmail": "mike.trader@gmail.com",
"userAvatarUrl": "https://storage.hyperprop.com/avatars/user123.jpg",
"importKey": "HP-7K3QF-9XT2M-4WHRD",
"importedAt": "<string>",
"trader": {
"email": "john.smith@email.com",
"name": "John Smith"
},
"purchase": {
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"purchaseDate": "2025-01-10T10:00:00.000Z",
"pricePaid": 499,
"currency": "USD",
"metadata": {}
},
"createdAt": "2025-01-15T10:00:00.000Z",
"updatedAt": "2025-01-20T14:30:00.000Z"
}
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Invalid or expired session"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "This account does not belong to your organization",
"code": "ACCOUNT_NOT_IN_ORG"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Trading account not found",
"code": "ACCOUNT_NOT_FOUND"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}Authorizations
BearerX-API-Key
JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.
Path Parameters
The account ID to retrieve
Related topics
Get a specific trading planGet a specific trading ruleGet trading accounts for your organizationGet all trading accounts for the authenticated userGet current trading account with equity and P&L⌘I
Get a specific trading account
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId} \
--header 'Authorization: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}', 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/organization/trading-accounts/{accountId}",
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.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}"
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.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}")
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{
"success": true,
"data": {
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"accountNumber": "APEX-100K-7845",
"type": "evaluation",
"status": "in_progress",
"initialBalance": 100000,
"currentBalance": 105000,
"highWaterMark": 108000,
"dailyStartingBalance": 104000,
"totalPnl": 5000,
"dailyPnl": 1000,
"startedAt": "2025-01-15T10:00:00.000Z",
"completedAt": null,
"violationReason": null,
"metadata": {
"referredBy": "john@partner.com",
"prioritySupport": true
},
"performanceData": {},
"markets": [
"CME",
"CBOT",
"NYMEX",
"COMEX"
],
"cycleStartingBalance": 100000,
"cycleStartedAt": "<string>",
"cycleProfit": 5000,
"lossFloorBalance": 123,
"payoutCount": 0,
"completionPendingReason": "<string>",
"consistency": {},
"organization": {
"id": "<string>",
"name": "<string>",
"logoUrl": "<string>"
},
"lockout": {
"active": true,
"id": "<string>",
"mode": "<string>",
"reason": "<string>",
"lockedBy": "<string>",
"startsAt": "<string>",
"endsAt": "<string>",
"remainingMinutes": 123
},
"tradingPlan": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "100K Challenge",
"accountSize": 100000,
"durationDays": 123
},
"tradingRule": {
"id": "660e8400-e29b-41d4-a716-446655440000",
"name": "Standard Rules",
"description": "<string>",
"profitTarget": 10000,
"dailyProfit": 123,
"maxProfit": 123,
"dailyLoss": 2500,
"maxLoss": 5000,
"dailyDrawdown": 2.5,
"maxDrawdown": 5,
"drawdownType": "static",
"consistency": 30,
"consistencyEnforced": true,
"consistencyBase": "<string>",
"consistencyTolerancePct": 123,
"consistencyLeniency": 123,
"consistencyMinDays": 123,
"consistencyProfitableDayMin": 123,
"maxPayouts": 123,
"payoutMllLockOffset": 123,
"maxContracts": 5,
"microConversionRatio": 10,
"scalingPlan": {}
},
"userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
"userEmail": "mike.trader@gmail.com",
"userAvatarUrl": "https://storage.hyperprop.com/avatars/user123.jpg",
"importKey": "HP-7K3QF-9XT2M-4WHRD",
"importedAt": "<string>",
"trader": {
"email": "john.smith@email.com",
"name": "John Smith"
},
"purchase": {
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"purchaseDate": "2025-01-10T10:00:00.000Z",
"pricePaid": 499,
"currency": "USD",
"metadata": {}
},
"createdAt": "2025-01-15T10:00:00.000Z",
"updatedAt": "2025-01-20T14:30:00.000Z"
}
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Invalid or expired session"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "This account does not belong to your organization",
"code": "ACCOUNT_NOT_IN_ORG"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Trading account not found",
"code": "ACCOUNT_NOT_FOUND"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}