Get current trading account with equity and P&L

GET

trade

account

fetch

const response = await fetch('/trade/account', {
  headers: { 'Authorization': `Bearer ${token}` }
});
const { data } = await response.json();
console.log('Equity:', data.equity);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/trade/account",
  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/trade/account"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/trade/account")

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

{
  "account_number": "HP-12345",
  "current_balance": 50250,
  "current_drawdown": 125,
  "daily_pnl": 375,
  "daily_starting_balance": 50000,
  "drawdown_from_hwm": 125,
  "equity": 50375,
  "high_water_mark": 50500,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "initial_balance": 50000,
  "lockout": {
    "active": true,
    "ends_at": "2026-03-01T22:00:00Z",
    "mode": "trading_day",
    "reason": "Initiated by user",
    "remaining_minutes": 540,
    "starts_at": "2026-02-28T13:00:00Z"
  },
  "rule": {
    "consistency": 30,
    "daily_drawdown": 2,
    "daily_loss": 1500,
    "daily_profit": 0,
    "description": "Standard evaluation rules",
    "drawdown_type": "trailing",
    "id": "935ba1f8-c21a-41a5-bc1a-3f94449e80ea",
    "max_contracts": 5,
    "max_drawdown": 5,
    "max_loss": 2500,
    "max_profit": 0,
    "micro_conversion_ratio": 10,
    "name": "Standard 50K Rules",
    "profit_target": 3000
  },
  "started_at": "2024-01-15T10:00:00Z",
  "status": "InProgress",
  "total_pnl": 250,
  "unrealized_pnl": 125,
  "violation_reason": null
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

Response

Account details with real-time equity

Trading account summary with real-time equity

Example Response

{
"id": "550e8400-e29b-41d4-a716-446655440000",
"account_number": "HP-12345",
"initial_balance": 50000.00,
"current_balance": 50250.00,
"high_water_mark": 50500.00,
"daily_starting_balance": 50000.00,
"total_pnl": 250.00,
"unrealized_pnl": 125.00,
"equity": 50375.00,
"drawdown_from_hwm": 125.00,
"daily_pnl": 375.00,
"current_drawdown": 125.00,
"status": "InProgress",
"started_at": "2024-01-15T10:00:00Z",
"violation_reason": null,
"rule": { ... }
}

account_number

string

required

Human-readable account number (e.g., "HP-12345")

Example:

"HP-12345"

current_balance

number<double>

required

Current realized balance (not including open positions)

Example:

50250

current_drawdown

number<double>

required

Current drawdown amount from high water mark

Example:

125

daily_pnl

number<double>

required

Today's realized P&L (current_balance - daily_starting_balance)

Example:

375

daily_starting_balance

number<double>

required

Balance at start of current trading day

Example:

50000

drawdown_from_hwm

number<double>

required

Drawdown from high water mark (equity - HWM, always >= 0)

Example:

125

equity

number<double>

required

Current equity = current_balance + unrealized_pnl

Example:

50375

high_water_mark

number<double>

required

Highest equity reached (for drawdown calculation)

Example:

50500

string<uuid>

required

Unique account identifier

Example:

"550e8400-e29b-41d4-a716-446655440000"

initial_balance

number<double>

required

Starting balance when evaluation began

Example:

50000

status

string

required

Account status: "Active", "InProgress", "Completed", "Violated"

Example:

"Active"

total_pnl

number<double>

required

Total realized P&L from closed trades

Example:

250

unrealized_pnl

number<double>

required

Unrealized P&L from open positions (real-time)

Example:

125

lockout

object | null

Show child attributes

rule

object | null

Trading rules and limits for an evaluation account

Defines the profit targets, loss limits, and position constraints. All monetary values are in dollars, percentages are whole numbers (e.g., 5 = 5%).

Example

{
"id": "rule-uuid",
"name": "50K Evaluation",
"description": "Standard 50K evaluation rules",
"profit_target": 3000,
"daily_profit": 0,
"max_profit": 0,
"daily_loss": 1000,
"max_loss": 2500,
"daily_drawdown": 2,
"max_drawdown": 5,
"consistency": 30,
"max_contracts": 5,
"micro_conversion_ratio": 10
}

Show child attributes

Example:

{
  "consistency": 30,
  "daily_drawdown": 2,
  "daily_loss": 1000,
  "daily_profit": 0,
  "description": "Standard 50K evaluation rules",
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "max_contracts": 5,
  "max_drawdown": 5,
  "max_loss": 2500,
  "max_profit": 0,
  "micro_conversion_ratio": 10,
  "name": "50K Evaluation",
  "profit_target": 3000
}

session

any | null

started_at

string | null

ISO 8601 timestamp when evaluation started

Example:

"2024-01-15T10:00:00Z"

violation_reason

string | null

Reason for violation (if status is "Violated")

Example:

null

⌘I

fetch

const response = await fetch('/trade/account', {
  headers: { 'Authorization': `Bearer ${token}` }
});
const { data } = await response.json();
console.log('Equity:', data.equity);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/trade/account",
  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/trade/account"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/trade/account")

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

{
  "account_number": "HP-12345",
  "current_balance": 50250,
  "current_drawdown": 125,
  "daily_pnl": 375,
  "daily_starting_balance": 50000,
  "drawdown_from_hwm": 125,
  "equity": 50375,
  "high_water_mark": 50500,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "initial_balance": 50000,
  "lockout": {
    "active": true,
    "ends_at": "2026-03-01T22:00:00Z",
    "mode": "trading_day",
    "reason": "Initiated by user",
    "remaining_minutes": 540,
    "starts_at": "2026-02-28T13:00:00Z"
  },
  "rule": {
    "consistency": 30,
    "daily_drawdown": 2,
    "daily_loss": 1500,
    "daily_profit": 0,
    "description": "Standard evaluation rules",
    "drawdown_type": "trailing",
    "id": "935ba1f8-c21a-41a5-bc1a-3f94449e80ea",
    "max_contracts": 5,
    "max_drawdown": 5,
    "max_loss": 2500,
    "max_profit": 0,
    "micro_conversion_ratio": 10,
    "name": "Standard 50K Rules",
    "profit_target": 3000
  },
  "started_at": "2024-01-15T10:00:00Z",
  "status": "InProgress",
  "total_pnl": 250,
  "unrealized_pnl": 125,
  "violation_reason": null
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

Platform API

Trade API

Market Data API

Get current trading account with equity and P&L

Response

Example Response

Example