API Reference

V1

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Accounts

Manage trading accounts, balances, and portfolio history.

Get Accounts

client.V1.Accounts.GetAccounts(ctx, query) (*V1AccountGetAccountsResponse, error)

GET/v1/accounts

Get Account By ID

client.V1.Accounts.GetAccountByID(ctx, accountID) (*V1AccountGetAccountByIDResponse, error)

GET/v1/accounts/{account_id}

Patch Account By ID

client.V1.Accounts.PatchAccountByID(ctx, accountID, body) (*V1AccountPatchAccountByIDResponse, error)

PATCH/v1/accounts/{account_id}

Get Account Balances

client.V1.Accounts.GetAccountBalances(ctx, accountID, query) (*V1AccountGetAccountBalancesResponse, error)

GET/v1/accounts/{account_id}/balances

Get Portfolio History

client.V1.Accounts.GetPortfolioHistory(ctx, accountID, query) (*V1AccountGetPortfolioHistoryResponse, error)

GET/v1/accounts/{account_id}/portfolio-history

ModelsExpand Collapse

type Account struct{…}

Represents a trading account

ID int64

The unique identifier for the account

formatint64

AccountHolderEntityID int64

The account holder entity identifier

formatint64

AccountHolderEntityKind AccountHolderEntityKind

Whether the account holder is a natural person or a legal entity.

One of the following:

const AccountHolderEntityKindNaturalPerson AccountHolderEntityKind = "NATURAL_PERSON"

const AccountHolderEntityKindLegalEntity AccountHolderEntityKind = "LEGAL_ENTITY"

const AccountHolderEntityKindOther AccountHolderEntityKind = "OTHER"

FullName string

The full legal name of the account

OpenDate Time

The date the account was opened

formatdate

OptionsLevel int64

The options level of the account

formatint64

ShortName string

The short name of the account

Status AccountStatus

The current status of the account

One of the following:

const AccountStatusActive AccountStatus = "ACTIVE"

const AccountStatusInactive AccountStatus = "INACTIVE"

const AccountStatusClosed AccountStatus = "CLOSED"

Subtype AccountSubtype

The sub-type of account

One of the following:

const AccountSubtypeCash AccountSubtype = "CASH"

const AccountSubtypeMargin AccountSubtype = "MARGIN"

const AccountSubtypeOther AccountSubtype = "OTHER"

Type AccountType

The type of account

One of the following:

const AccountTypeCustomer AccountType = "CUSTOMER"

const AccountTypeOther AccountType = "OTHER"

CloseDate TimeOptional

The date the account was closed, if applicable When a null/undefined value is observed, it indicates it does not apply.

formatdate

type AccountBalances struct{…}

Represents the balance details for a trading account

AccountID int64

The unique identifier for the account

formatint64

BuyingPower string

The total buying power available in the account: base buying power plus the open order adjustment, where base buying power is maintenance margin excess times the multiplier for intraday and initial margin excess times the multiplier for overnight.

Currency string

Currency identifier for all monetary values.

DailyChange string

Difference between current equity and start-of-day equity.

DailyPnl string

Total profit or loss since start of day.

DailyRealizedPnl string

Realized profit or loss since start of day.

DailyUnrealizedPnl string

Total unrealized profit or loss across all positions relative to prior close.

Equity string

The total equity in the account: cash plus long market value plus short market value, where short market value is negative.

LongMarketValue string

The total market value of all long positions.

MarginType MarginType

The applicable margin model for the account

One of the following:

const MarginTypeOther MarginType = "OTHER"

const MarginTypeNone MarginType = "NONE"

const MarginTypePortfolioMargin MarginType = "PORTFOLIO_MARGIN"

const MarginTypeRiskBasedHaircutBrokerDealer MarginType = "RISK_BASED_HAIRCUT_BROKER_DEALER"

const MarginTypeRegT MarginType = "REG_T"

const MarginTypeRiskBasedHaircutMarketMaker MarginType = "RISK_BASED_HAIRCUT_MARKET_MAKER"

const MarginTypeCiro MarginType = "CIRO"

const MarginTypeFuturesNlv MarginType = "FUTURES_NLV"

const MarginTypeFuturesTotEq MarginType = "FUTURES_TOT_EQ"

OpenOrderAdjustment string

Buying power correction from open orders, computed as projected buying power minus actual buying power. A negative value means open orders are consuming buying power.

SettledCash string

The amount of cash that is settled and available for withdrawal or trading.

Sod AccountBalancesSod

Start-of-day snapshot balances.

BuyingPower string

Start-of-day buying power.

Equity string

Start-of-day equity.

LongMarketValue string

Start-of-day long market value.

ShortMarketValue string

Start-of-day short market value.

Asof TimeOptional

Timestamp for the start-of-day values. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

MaintenanceMarginExcess stringOptional

Start-of-day maintenance margin excess: the difference between equity and the maintenance margin requirement. When a null/undefined value is observed, it indicates it does not apply.

MaintenanceMarginRequirement stringOptional

Start-of-day maintenance margin requirement: the amount of equity required to maintain current positions. When a null/undefined value is observed, it indicates it does not apply.

TradeCash stringOptional

Start-of-day trade cash. When a null/undefined value is observed, it indicates it does not apply.

TradeCash string

Trade-date effective cash.

UnrealizedPnl string

Total unrealized profit or loss across all open positions.

UnsettledCredits string

Trade-date unsettled cash credits.

UnsettledDebits string

Trade-date unsettled cash debits.

WithdrawableCash string

The amount of cash currently available to withdraw.

MarginDetails MarginDetailsOptional

Margin-account-only details. When a null/undefined value is observed, it indicates it does not apply.

InitialMarginExcess string

The difference between equity and the initial margin requirement.

InitialMarginRequirement string

The amount of equity required to open new positions.

IntradayDetails MarginSessionDetails

Intraday session margin calculation details.

BuyingPower string

Maximum buying power available in the account during the session: base buying power plus the open order adjustment, where base buying power is maintenance margin excess times the multiplier for intraday and initial margin excess times the multiplier for overnight.

Multiplier stringOptional

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

MaintenanceMarginExcess string

The difference between equity and the maintenance margin requirement.

MaintenanceMarginRequirement string

The amount of equity required to maintain current positions.

OvernightDetails MarginSessionDetails

Overnight session margin calculation details.

BuyingPower string

Maximum buying power available in the account during the session: base buying power plus the open order adjustment, where base buying power is maintenance margin excess times the multiplier for intraday and initial margin excess times the multiplier for overnight.

Multiplier stringOptional

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

TopContributors []MarginTopContributorOptional

Optional top margin contributors, returned only when explicitly requested.

InitialMarginRequirement string

Initial margin requirement attributable to this underlying.

MaintenanceMarginRequirement string

Maintenance margin requirement attributable to this underlying.

MarketValue string

Net market value attributable to this underlying.

UnderlyingInstrumentID string

UUID of the underlying security contributing to margin requirement.

formatuuid

Usage MarginDetailsUsageOptional

Current usage totals. When a null/undefined value is observed, it indicates that there is no available data.

Total string

The total margin available in the current model.

Used string

The amount of margin that is currently being utilized.

Multiplier stringOptional

Margin multiplier: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session. When a null/undefined value is observed, it indicates it does not apply.

ShortMarketValue stringOptional

The total market value of all short positions. When null/undefined, the value should be assumed to be zero. The field is omitted to simplify the response.

type AccountBalancesSod struct{…}

BuyingPower string

Start-of-day buying power.

Equity string

Start-of-day equity.

LongMarketValue string

Start-of-day long market value.

ShortMarketValue string

Start-of-day short market value.

Asof TimeOptional

Timestamp for the start-of-day values. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

MaintenanceMarginExcess stringOptional

Start-of-day maintenance margin excess: the difference between equity and the maintenance margin requirement. When a null/undefined value is observed, it indicates it does not apply.

MaintenanceMarginRequirement stringOptional

Start-of-day maintenance margin requirement: the amount of equity required to maintain current positions. When a null/undefined value is observed, it indicates it does not apply.

TradeCash stringOptional

Start-of-day trade cash. When a null/undefined value is observed, it indicates it does not apply.

type AccountHolderEntityKind string

Whether an account holder is a natural person or a legal entity.

One of the following:

const AccountHolderEntityKindNaturalPerson AccountHolderEntityKind = "NATURAL_PERSON"

const AccountHolderEntityKindLegalEntity AccountHolderEntityKind = "LEGAL_ENTITY"

const AccountHolderEntityKindOther AccountHolderEntityKind = "OTHER"

type AccountList []Account

ID int64

The unique identifier for the account

formatint64

AccountHolderEntityID int64

The account holder entity identifier

formatint64

AccountHolderEntityKind AccountHolderEntityKind

Whether the account holder is a natural person or a legal entity.

One of the following:

const AccountHolderEntityKindNaturalPerson AccountHolderEntityKind = "NATURAL_PERSON"

const AccountHolderEntityKindLegalEntity AccountHolderEntityKind = "LEGAL_ENTITY"

const AccountHolderEntityKindOther AccountHolderEntityKind = "OTHER"

FullName string

The full legal name of the account

OpenDate Time

The date the account was opened

formatdate

OptionsLevel int64

The options level of the account

formatint64

ShortName string

The short name of the account

Status AccountStatus

The current status of the account

One of the following:

const AccountStatusActive AccountStatus = "ACTIVE"

const AccountStatusInactive AccountStatus = "INACTIVE"

const AccountStatusClosed AccountStatus = "CLOSED"

Subtype AccountSubtype

The sub-type of account

One of the following:

const AccountSubtypeCash AccountSubtype = "CASH"

const AccountSubtypeMargin AccountSubtype = "MARGIN"

const AccountSubtypeOther AccountSubtype = "OTHER"

Type AccountType

The type of account

One of the following:

const AccountTypeCustomer AccountType = "CUSTOMER"

const AccountTypeOther AccountType = "OTHER"

CloseDate TimeOptional

The date the account was closed, if applicable When a null/undefined value is observed, it indicates it does not apply.

formatdate

type AccountSettings struct{…}

Risk RiskSettingsOptional

Risk settings for the account When a null/undefined value is observed, it indicates that there is no available data.

MaxNotional stringOptional

The maximum notional value available to the account When a null/undefined value is observed, it indicates that there is no available data.

type AccountStatus string

Account status

One of the following:

const AccountStatusActive AccountStatus = "ACTIVE"

const AccountStatusInactive AccountStatus = "INACTIVE"

const AccountStatusClosed AccountStatus = "CLOSED"

type AccountSubtype string

Account subtype classification providing more granular categorization

One of the following:

const AccountSubtypeCash AccountSubtype = "CASH"

const AccountSubtypeMargin AccountSubtype = "MARGIN"

const AccountSubtypeOther AccountSubtype = "OTHER"

type AccountType string

Account type classification

One of the following:

const AccountTypeCustomer AccountType = "CUSTOMER"

const AccountTypeOther AccountType = "OTHER"

type AccountWithPersonalDetails struct{…}

Represents a trading account

ID int64

The unique identifier for the account

formatint64

AccountHolderEntityID int64

The account holder entity identifier

formatint64

AccountHolderEntityKind AccountHolderEntityKind

Whether the account holder is a natural person or a legal entity.

One of the following:

const AccountHolderEntityKindNaturalPerson AccountHolderEntityKind = "NATURAL_PERSON"

const AccountHolderEntityKindLegalEntity AccountHolderEntityKind = "LEGAL_ENTITY"

const AccountHolderEntityKindOther AccountHolderEntityKind = "OTHER"

FullName string

The full legal name of the account

OpenDate Time

The date the account was opened

formatdate

OptionsLevel int64

The options level of the account

formatint64

ShortName string

The short name of the account

Status AccountStatus

The current status of the account

One of the following:

const AccountStatusActive AccountStatus = "ACTIVE"

const AccountStatusInactive AccountStatus = "INACTIVE"

const AccountStatusClosed AccountStatus = "CLOSED"

Subtype AccountSubtype

The sub-type of account

One of the following:

const AccountSubtypeCash AccountSubtype = "CASH"

const AccountSubtypeMargin AccountSubtype = "MARGIN"

const AccountSubtypeOther AccountSubtype = "OTHER"

Type AccountType

The type of account

One of the following:

const AccountTypeCustomer AccountType = "CUSTOMER"

const AccountTypeOther AccountType = "OTHER"

CloseDate TimeOptional

The date the account was closed, if applicable When a null/undefined value is observed, it indicates it does not apply.

formatdate

CountryOfTaxResidency stringOptional

The country of tax residency of the account-holder entity. null when not on file or entity reference data is unavailable. When a null/undefined value is observed, it indicates that there is no available data.

DateOfBirth TimeOptional

The date of birth of the account holder’s primary contact. null when not on file or entity reference data is unavailable. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

MailingAddress AddressOptional

The mailing address of the account-holder entity. null when no mailing address is on file or entity reference data is unavailable. When a null/undefined value is observed, it indicates that there is no available data.

City string

City

Country string

Country

Line1 string

First street address line

PostalCode string

Postal code

Line2 stringOptional

Second street address line When a null/undefined value is observed, it indicates it does not apply.

State stringOptional

State or province When a null/undefined value is observed, it indicates it does not apply.

PhoneNumber stringOptional

The phone number of the account holder’s primary contact. null when not on file or entity reference data is unavailable. When a null/undefined value is observed, it indicates that there is no available data.

type Address struct{…}

A postal address.

City string

City

Country string

Country

Line1 string

First street address line

PostalCode string

Postal code

Line2 stringOptional

Second street address line When a null/undefined value is observed, it indicates it does not apply.

State stringOptional

State or province When a null/undefined value is observed, it indicates it does not apply.

type MarginDetails struct{…}

InitialMarginExcess string

The difference between equity and the initial margin requirement.

InitialMarginRequirement string

The amount of equity required to open new positions.

IntradayDetails MarginSessionDetails

Intraday session margin calculation details.

BuyingPower string

Maximum buying power available in the account during the session: base buying power plus the open order adjustment, where base buying power is maintenance margin excess times the multiplier for intraday and initial margin excess times the multiplier for overnight.

Multiplier stringOptional

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

MaintenanceMarginExcess string

The difference between equity and the maintenance margin requirement.

MaintenanceMarginRequirement string

The amount of equity required to maintain current positions.

OvernightDetails MarginSessionDetails

Overnight session margin calculation details.

BuyingPower string

Maximum buying power available in the account during the session: base buying power plus the open order adjustment, where base buying power is maintenance margin excess times the multiplier for intraday and initial margin excess times the multiplier for overnight.

Multiplier stringOptional

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

TopContributors []MarginTopContributorOptional

Optional top margin contributors, returned only when explicitly requested.

InitialMarginRequirement string

Initial margin requirement attributable to this underlying.

MaintenanceMarginRequirement string

Maintenance margin requirement attributable to this underlying.

MarketValue string

Net market value attributable to this underlying.

UnderlyingInstrumentID string

UUID of the underlying security contributing to margin requirement.

formatuuid

Usage MarginDetailsUsageOptional

Current usage totals. When a null/undefined value is observed, it indicates that there is no available data.

Total string

The total margin available in the current model.

Used string

The amount of margin that is currently being utilized.

type MarginDetailsUsage struct{…}

Total string

The total margin available in the current model.

Used string

The amount of margin that is currently being utilized.

type MarginSessionDetails struct{…}

BuyingPower string

Maximum buying power available in the account during the session: base buying power plus the open order adjustment, where base buying power is maintenance margin excess times the multiplier for intraday and initial margin excess times the multiplier for overnight.

Multiplier stringOptional

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

type MarginTopContributor struct{…}

InitialMarginRequirement string

Initial margin requirement attributable to this underlying.

MaintenanceMarginRequirement string

Maintenance margin requirement attributable to this underlying.

MarketValue string

Net market value attributable to this underlying.

UnderlyingInstrumentID string

UUID of the underlying security contributing to margin requirement.

formatuuid

type MarginType string

An account’s margin type

One of the following:

const MarginTypeOther MarginType = "OTHER"

const MarginTypeNone MarginType = "NONE"

const MarginTypePortfolioMargin MarginType = "PORTFOLIO_MARGIN"

const MarginTypeRiskBasedHaircutBrokerDealer MarginType = "RISK_BASED_HAIRCUT_BROKER_DEALER"

const MarginTypeRegT MarginType = "REG_T"

const MarginTypeRiskBasedHaircutMarketMaker MarginType = "RISK_BASED_HAIRCUT_MARKET_MAKER"

const MarginTypeCiro MarginType = "CIRO"

const MarginTypeFuturesNlv MarginType = "FUTURES_NLV"

const MarginTypeFuturesTotEq MarginType = "FUTURES_TOT_EQ"

type PortfolioHistoryResponse struct{…}

Segments []PortfolioHistorySegment

Date Time

The date for this segment

formatdate

EodEquity string

The equity at the end of the trading day.

RealizedPnl string

Sum of the profit and loss realized from position closing trading activity.

SodEquity string

The equity at the start of the trading day.

UnrealizedPnl string

Sum of the profit and loss from market changes.

BoughtNotional stringOptional

Amount bought MTM

DayPnl stringOptional

Sum of the profit and loss from intraday trading activities for the trading day.

NetPnl stringOptional

P&L after netting all realized and unrealized P&L, adjustments, dividends, change in accruals, income and expenses

PositionPnl stringOptional

P&L attributable to start-of-day (carried) positions from market movement during this trading day.

SoldNotional stringOptional

Amount sold MTM

type PortfolioHistorySegment struct{…}

Date Time

The date for this segment

formatdate

EodEquity string

The equity at the end of the trading day.

RealizedPnl string

Sum of the profit and loss realized from position closing trading activity.

SodEquity string

The equity at the start of the trading day.

UnrealizedPnl string

Sum of the profit and loss from market changes.

BoughtNotional stringOptional

Amount bought MTM

DayPnl stringOptional

Sum of the profit and loss from intraday trading activities for the trading day.

NetPnl stringOptional

P&L after netting all realized and unrealized P&L, adjustments, dividends, change in accruals, income and expenses

PositionPnl stringOptional

P&L attributable to start-of-day (carried) positions from market movement during this trading day.

SoldNotional stringOptional

Amount sold MTM

type RiskSettings struct{…}

Risk settings for an account

MaxNotional stringOptional

The maximum notional value available to the account When a null/undefined value is observed, it indicates that there is no available data.