Skip to main content
GET
Retrieve trading account information

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
integer
required

A unique integer value identifying this account.

Response

id
integer
required
read-only
email
string<email>
required
read-only

Email address of the account owner.

account_type
string
required
read-only

Type of trading account (e.g. challenge, verification, funded).

user_id
integer
required
read-only

Unique identifier of the user who owns the trading account.

prop_firm_id
string<uuid>
required

Unique identifier of the proprietary trading firm.

prop_firm_name
string
required
read-only

Display name of the proprietary trading firm.

challenge_title
string | null
required
read-only

Title of the challenge attached to the account's current phase.

challenge_short_code
string | null
required
read-only

Short code copied from the challenge attached to the account's current phase.

auto_liquidate_triggered_timestamp
string | null
required
read-only

Deprecated legacy field. Account-level auto-liquidation data is unavailable; this field always returns null.

failure_metadata
any
required
read-only

Structured breach or failure context for the account, when available.

current_balance
string
required
read-only

Current account balance.

current_equity
string
required
read-only

Current account equity, including unrealized profit or loss.

previous_end_of_day_balance
string
required
read-only

Account balance at the end of the previous trading day.

daily_pnl
string<decimal> | null
required
read-only

Profit or loss for the account during the current trading day.

Pattern: ^-?\d{0,26}(?:\.\d{0,2})?$
realized_pnl
string<decimal> | null
required
read-only

Realized profit or loss for the account.

Pattern: ^-?\d{0,26}(?:\.\d{0,2})?$
unrealized_pnl
string<decimal> | null
required
read-only

Unrealized profit or loss from currently open exposure.

Pattern: ^-?\d{0,26}(?:\.\d{0,2})?$
total_pnl
string<decimal> | null
required
read-only

Realized lifetime profit or loss for the account.

Pattern: ^-?\d{0,26}(?:\.\d{0,2})?$
realized_lifetime_pnl
string<decimal> | null
required
read-only

Realized lifetime profit or loss for the account.

Pattern: ^-?\d{0,26}(?:\.\d{0,2})?$
total_commission
string<decimal> | null
required
read-only

Total commission charged to the account.

Pattern: ^-?\d{0,26}(?:\.\d{0,2})?$
closed_pnl_today
string
required
read-only

Realized profit or loss from positions closed during the current trading day.

open_pnl
string
required
read-only

Legacy open-position profit or loss value. Prefer unrealized_pnl when present.

open_positions_count
string
required
read-only

Number of currently open positions.

peak_realized_balance
string
required
read-only

Highest realized account balance reached for the relevant risk window.

peak_balance
string<decimal> | null
required
read-only

Peak realized account balance for the relevant risk window, excluding open-position profit or loss.

Pattern: ^-?\d{0,24}(?:\.\d{0,4})?$
peak_equity
string<decimal> | null
required
read-only

Peak account equity for the relevant risk window, including open-position profit or loss.

Pattern: ^-?\d{0,24}(?:\.\d{0,4})?$
peak_equity_timestamp
string<date-time> | null
required
read-only

Timestamp when the peak account equity was recorded.

lowest_realized_balance
string
required
read-only

Lowest realized account balance reached historically.

peak_unrealized_balance
string
required
read-only

Highest account equity reached for the relevant risk window.

lowest_unrealized_balance
string
required
read-only

Lowest unrealized equity value reached historically.

low_equity_timestamp
string<date-time> | null
required
read-only

Timestamp when the lowest account equity was recorded.

eod_peak_balance
string<decimal> | null
required
read-only

End-of-day peak balance used for EOD trailing drawdown calculations.

Pattern: ^-?\d{0,24}(?:\.\d{0,4})?$
failure_threshold
string<decimal> | null
required
read-only

Current account failure threshold supplied by OMS, when available.

Pattern: ^-?\d{0,24}(?:\.\d{0,4})?$
daily_drawdown_floor
string<decimal> | null
required
read-only

Current daily drawdown floor supplied by OMS, when available.

Pattern: ^-?\d{0,24}(?:\.\d{0,4})?$
account_currency
string
required
read-only

Currency in which the trading account is denominated.

auto_liquidation_eNonebled
string | null
required
read-only

Deprecated legacy field retaining its historical spelling. Account-level auto-liquidation data is unavailable; this field always returns null.

auto_liquidation_enabled
boolean | null
required
read-only

Whether account-level auto-liquidation is enabled. This data is unavailable and always returns null. See auto_liquidation_data_status.

auto_liquidation_data_status
enum<string>
default:unavailable
required

Deprecated availability indicator for account-level auto-liquidation data. Always unavailable.

  • unavailable - unavailable
Available options:
unavailable
auto_liquidation_criteria
string | null
required
read-only

Deprecated legacy field. Account-level auto-liquidation data is unavailable; this field always returns null.

auto_liquidation_triggered
string | null
required
read-only

Deprecated legacy field. Account-level auto-liquidation data is unavailable; this field always returns null.

auto_liquidation_timestamp
string | null
required
read-only

Deprecated legacy field. Account-level auto-liquidation data is unavailable; this field always returns null.

long_positions_count
string
required
read-only

Number of open long (buy) positions.

short_positions_count
string
required
read-only

Number of open short (sell) positions.

net_positions_count
string
required
read-only

Net number of open positions (long minus short).

is_trading_allowed
string
required
read-only

Indicates whether the account is currently allowed to place trades.

oms_flags
string
required
read-only

Operational or risk flags reported for the account.

last_trade_timestamp
string
required
read-only

Timestamp of the most recent trade executed on the account.

risk_algorithm
string
required
read-only

Risk management algorithm currently applied to the account.

drawdown_type
string
required
read-only

Type of drawdown applied to the account (e.g. static, trailing).

max_drawdown
string
required
read-only

Maximum allowed drawdown for the account.

daily_max_drawdown
string
required
read-only

Maximum allowed daily drawdown for the account.

minimum_account_balance
string<decimal> | null
required
read-only

Lowest observed account balance for the relevant risk window.

Pattern: ^-?\d{0,24}(?:\.\d{0,4})?$
minimum_account_balance_timestamp
string
required
read-only

Timestamp when the lowest observed account balance was recorded, if applicable.

trading_days
string
required
read-only

Number of distinct trading days with at least one executed trade.

consistency_score
string
required
read-only

Score representing the trader's consistency based on risk and performance metrics.

initial_balance_decimal
string
required
read-only
current_balance_decimal
string
required
read-only
created
string<date-time>
required
read-only
modified
string<date-time>
required
read-only
live_account_balance_currency
string
required
read-only
live_account_equity_currency
string
required
read-only
profit_loss_currency
string
required
read-only
last_daily_drawdown_amount_currency
string | null
required
read-only
last_global_drawdown_amount_currency
string | null
required
read-only
deleted
boolean
default:false
comment
string | null
Maximum string length: 255
is_giveaway
boolean
default:false
start_date
string<date-time> | null
end_date
string<date-time> | null

Specified for Time Limited accounts. Leave blank to allow unlimited duration

source
enum<string>
default:WEBHOOK
  • WEBHOOK - Webhook
  • ADMIN_MANUAL_CREATE - Admin Manual Create
  • ADMIN_VERIFICATION - Admin Verification
  • DATA_IMPORT - Data Import
Available options:
WEBHOOK,
ADMIN_MANUAL_CREATE,
ADMIN_VERIFICATION,
DATA_IMPORT
initial_balance
string<decimal>
default:0.00
Pattern: ^-?\d{0,12}(?:\.\d{0,2})?$
live_account_equity
string<decimal>
default:0.00
Pattern: ^-?\d{0,26}(?:\.\d{0,2})?$
leverage
string<decimal> | null
Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
mae
string<decimal> | null
Pattern: ^-?\d{0,26}(?:\.\d{0,2})?$
mfe
string<decimal> | null
Pattern: ^-?\d{0,26}(?:\.\d{0,2})?$
mae_timestamp
string<date-time> | null
mfe_timestamp
string<date-time> | null
min_balance
string<decimal> | null

Lowest observed account balance for the relevant risk window.

Pattern: ^-?\d{0,24}(?:\.\d{0,4})?$
min_balance_timestamp
string<date-time> | null
profit_loss
string<decimal>
default:0.00
Pattern: ^-?\d{0,12}(?:\.\d{0,2})?$
broker_type
enum<string>
default:TickblazeOMS
  • ALL - Do not filter
  • MatchTrade - Match Trader
  • MetaTrader - MetaTrader
  • TradeLocker - TradeLocker
  • MetaTrader5 - MetaTrader5
  • Ctrader - Ctrader
  • Sim2Funded - Sim2Funded
  • Tradovate - Tradovate
  • Volumetrica - Volumetrica
  • Tickblaze - Tickblaze
  • TickblazeOMS - TickblazeOMS
Available options:
ALL,
MatchTrade,
MetaTrader,
TradeLocker,
MetaTrader5,
Ctrader,
Sim2Funded,
Tradovate,
Volumetrica,
Tickblaze,
TickblazeOMS
last_daily_drawdown_amount
string<decimal> | null
Pattern: ^-?\d{0,12}(?:\.\d{0,2})?$
last_global_drawdown_amount
string<decimal> | null
Pattern: ^-?\d{0,12}(?:\.\d{0,2})?$
daily_drawdown_expiry
string<date-time> | null
status
enum<string>
default:ACTIVE
  • PENDING_ACTIVATION - Pending Activation
  • ACTIVE - Active
  • PASSED - Passed
  • FAILED - Failed
  • BLOCKED - Blocked
  • DELETED - Deleted
  • LIVE_VERIFICATION - Live Account Verification Required
  • KYC_VERIFICATION_REQD - KYC Verification Required
  • PHASE_VERIFICATION_REQD - Phase Verification Required
  • PAUSED - PAUSED
  • SUBSCRIPTION_EXPIRED - Subscription Expired
  • PAYMENT_REQUESTED - Payment Requested
Available options:
PENDING_ACTIVATION,
ACTIVE,
PASSED,
FAILED,
BLOCKED,
DELETED,
LIVE_VERIFICATION,
KYC_VERIFICATION_REQD,
PHASE_VERIFICATION_REQD,
PAUSED,
SUBSCRIPTION_EXPIRED,
PAYMENT_REQUESTED
status_finalised_timestamp
string<date-time> | null
status_reason
  • DAILY_DRAWDOWN_EXCEEDED - Daily drawdown limit exceeded
  • MAX_DRAWDOWN_EXCEEDED - Maximum drawdown limit exceeded
  • FLOATING_PNL_EXCEEDED - Floating PNL limit exceeded
  • PROFIT_TARGET_REACHED - Profit target completed
  • ACCOUNT_EXPIRED - Account expired
  • TRADING_STRATEGY_NOT_SUITABLE - Trading strategy does not suit our Organization
  • COPY_TRADING_DETECTED - Copy trading detected
  • RULE_BREACHED - Rule Breached
  • WITHDRAWAL_REQUESTED - Withdrawal Requested
  • CHALLENGE_RESET - Challenge Reset
  • SUBSCRIPTION_EXPIRED - Subscription Expired
Available options:
DAILY_DRAWDOWN_EXCEEDED,
MAX_DRAWDOWN_EXCEEDED,
FLOATING_PNL_EXCEEDED,
PROFIT_TARGET_REACHED,
ACCOUNT_EXPIRED,
TRADING_STRATEGY_NOT_SUITABLE,
COPY_TRADING_DETECTED,
RULE_BREACHED,
WITHDRAWAL_REQUESTED,
CHALLENGE_RESET,
SUBSCRIPTION_EXPIRED
custom_status_reason
string | null
profit_split
string<decimal> | null

Percentage value (0 to 1)

Pattern: ^-?\d{0,1}(?:\.\d{0,2})?$
payout_frequency
enum<integer>
default:30
  • 30 - Monthly
  • 14 - Bi-Weekly
  • 7 - Weekly
  • 10 - Every 10 days
  • 3 - Every 3 days
  • 5 - Every 5 days
  • -1 - Triple Payout
  • 21 - Every 21 days
  • 28 - Every 28 days
  • 1 - Daily
Available options:
30,
14,
7,
10,
3,
5,
-1,
21,
28,
1
Required range: -2147483648 <= x <= 2147483647
next_withdrawal_date
string<date-time> | null
copy_trading_detected
boolean
default:false
failed_review_reason
string | null
first_withdrawal_delay
integer | null
Required range: -2147483648 <= x <= 2147483647
reconciliation_status
enum<string>
default:not_reconciled
  • not_reconciled - Not reconciled
  • original_superseded - Original superseded
  • replacement_account - Replacement account
Available options:
not_reconciled,
original_superseded,
replacement_account
reconciliation_transferred_at
string<date-time> | null
reconciliation_note
string | null
max_position_size_account
string<decimal> | null
Pattern: ^-?\d{0,10}(?:\.\d{0,3})?$
order
integer | null
phase
integer | null
match_trader_trading_account
string<uuid> | null
metatrader_trading_account
integer | null
metatrader5_trading_account
integer | null
tradelocker_trading_account
string | null
sim2funded_trading_account
integer | null
ctrader_trading_account
integer | null
tradovate_trading_account
integer | null
volumetrica_trading_account
string | null
reconciliation_original_account
integer | null
reconciliation_superseded_by
integer | null