Get a specific trading account

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<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 => [
    "X-API-Key: <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("X-API-Key", "<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("X-API-Key", "<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["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "accountNumber": "ACME-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://cdn.example.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"
}