Account Definitions

AccountIDThe string representation of an Account Identifier.

Type	string
Format	“-“-delimited string with format “{siteID}-{divisionID}-{userID}-{accountNumber}”
Example	001-011-5838423-001

AccountThe full details of a client’s Account. This includes full open Trade, open Position and pending Order representation.

Account is an application/json object with the following Schema:

{
    # 
    # The Account’s identifier
    # 
    id : (AccountID),

    # 
    # Client-assigned alias for the Account. Only provided if the Account has
    # an alias set
    # 
    alias : (string),

    # 
    # The home currency of the Account
    # 
    currency : (Currency),

    # 
    # ID of the user that created the Account.
    # 
    createdByUserID : (integer),

    # 
    # The date/time when the Account was created.
    # 
    createdTime : (DateTime),

    # 
    # The current guaranteed Stop Loss Order settings of the Account. This
    # field will only be present if the guaranteedStopLossOrderMode is not
    # ‘DISABLED’.
    # 
    guaranteedStopLossOrderParameters : (GuaranteedStopLossOrderParameters),

    # 
    # The current guaranteed Stop Loss Order mode of the Account.
    # 
    guaranteedStopLossOrderMode : (GuaranteedStopLossOrderMode),

    # 
    # The current guaranteed Stop Loss Order mutability setting of the Account.
    # This field will only be present if the guaranteedStopLossOrderMode is not
    # ‘DISABLED’.
    # 
    # 
    # Deprecated: Will be removed in a future API update.
    # 
    guaranteedStopLossOrderMutability : (GuaranteedStopLossOrderMutability, deprecated),

    # 
    # The date/time that the Account’s resettablePL was last reset.
    # 
    resettablePLTime : (DateTime),

    # 
    # Client-provided margin rate override for the Account. The effective
    # margin rate of the Account is the lesser of this value and the OANDA
    # margin rate for the Account’s division. This value is only provided if a
    # margin rate override exists for the Account.
    # 
    marginRate : (DecimalNumber),

    # 
    # The number of Trades currently open in the Account.
    # 
    openTradeCount : (integer),

    # 
    # The number of Positions currently open in the Account.
    # 
    openPositionCount : (integer),

    # 
    # The number of Orders currently pending in the Account.
    # 
    pendingOrderCount : (integer),

    # 
    # Flag indicating that the Account has hedging enabled.
    # 
    hedgingEnabled : (boolean),

    # 
    # The total unrealized profit/loss for all Trades currently open in the
    # Account.
    # 
    unrealizedPL : (AccountUnits),

    # 
    # The net asset value of the Account. Equal to Account balance +
    # unrealizedPL.
    # 
    NAV : (AccountUnits),

    # 
    # Margin currently used for the Account.
    # 
    marginUsed : (AccountUnits),

    # 
    # Margin available for Account currency.
    # 
    marginAvailable : (AccountUnits),

    # 
    # The value of the Account’s open positions represented in the Account’s
    # home currency.
    # 
    positionValue : (AccountUnits),

    # 
    # The Account’s margin closeout unrealized PL.
    # 
    marginCloseoutUnrealizedPL : (AccountUnits),

    # 
    # The Account’s margin closeout NAV.
    # 
    marginCloseoutNAV : (AccountUnits),

    # 
    # The Account’s margin closeout margin used.
    # 
    marginCloseoutMarginUsed : (AccountUnits),

    # 
    # The Account’s margin closeout percentage. When this value is 1.0 or above
    # the Account is in a margin closeout situation.
    # 
    marginCloseoutPercent : (DecimalNumber),

    # 
    # The value of the Account’s open positions as used for margin closeout
    # calculations represented in the Account’s home currency.
    # 
    marginCloseoutPositionValue : (DecimalNumber),

    # 
    # The current WithdrawalLimit for the account which will be zero or a
    # positive value indicating how much can be withdrawn from the account.
    # 
    withdrawalLimit : (AccountUnits),

    # 
    # The Account’s margin call margin used.
    # 
    marginCallMarginUsed : (AccountUnits),

    # 
    # The Account’s margin call percentage. When this value is 1.0 or above the
    # Account is in a margin call situation.
    # 
    marginCallPercent : (DecimalNumber),

    # 
    # The current balance of the account.
    # 
    balance : (AccountUnits),

    # 
    # The total profit/loss realized over the lifetime of the Account.
    # 
    pl : (AccountUnits),

    # 
    # The total realized profit/loss for the account since it was last reset by
    # the client.
    # 
    resettablePL : (AccountUnits),

    # 
    # The total amount of financing paid/collected over the lifetime of the
    # account.
    # 
    financing : (AccountUnits),

    # 
    # The total amount of commission paid over the lifetime of the Account.
    # 
    commission : (AccountUnits),

    # 
    # The total amount of dividend adjustment paid over the lifetime of the
    # Account in the Account’s home currency.
    # 
    dividendAdjustment : (AccountUnits),

    # 
    # The total amount of fees charged over the lifetime of the Account for the
    # execution of guaranteed Stop Loss Orders.
    # 
    guaranteedExecutionFees : (AccountUnits),

    # 
    # The date/time when the Account entered a margin call state. Only provided
    # if the Account is in a margin call.
    # 
    marginCallEnterTime : (DateTime),

    # 
    # The number of times that the Account’s current margin call was extended.
    # 
    marginCallExtensionCount : (integer),

    # 
    # The date/time of the Account’s last margin call extension.
    # 
    lastMarginCallExtensionTime : (DateTime),

    # 
    # The ID of the last Transaction created for the Account.
    # 
    lastTransactionID : (TransactionID),

    # 
    # The details of the Trades currently open in the Account.
    # 
    trades : (Array[TradeSummary]),

    # 
    # The details all Account Positions.
    # 
    positions : (Array[Position]),

    # 
    # The details of the Orders currently pending in the Account.
    # 
    orders : (Array[Order])
}

AccountChangesStateAn AccountState Object is used to represent an Account’s current price-dependent state. Price-dependent Account state is dependent on OANDA’s current Prices, and includes things like unrealized PL, NAV and Trailing Stop Loss Order state. Fields will be omitted if their value has not changed since the specified transaction ID.

AccountChangesState is an application/json object with the following Schema:

{
    # 
    # The total unrealized profit/loss for all Trades currently open in the
    # Account.
    # 
    unrealizedPL : (AccountUnits),

    # 
    # The net asset value of the Account. Equal to Account balance +
    # unrealizedPL.
    # 
    NAV : (AccountUnits),

    # 
    # Margin currently used for the Account.
    # 
    marginUsed : (AccountUnits),

    # 
    # Margin available for Account currency.
    # 
    marginAvailable : (AccountUnits),

    # 
    # The value of the Account’s open positions represented in the Account’s
    # home currency.
    # 
    positionValue : (AccountUnits),

    # 
    # The Account’s margin closeout unrealized PL.
    # 
    marginCloseoutUnrealizedPL : (AccountUnits),

    # 
    # The Account’s margin closeout NAV.
    # 
    marginCloseoutNAV : (AccountUnits),

    # 
    # The Account’s margin closeout margin used.
    # 
    marginCloseoutMarginUsed : (AccountUnits),

    # 
    # The Account’s margin closeout percentage. When this value is 1.0 or above
    # the Account is in a margin closeout situation.
    # 
    marginCloseoutPercent : (DecimalNumber),

    # 
    # The value of the Account’s open positions as used for margin closeout
    # calculations represented in the Account’s home currency.
    # 
    marginCloseoutPositionValue : (DecimalNumber),

    # 
    # The current WithdrawalLimit for the account which will be zero or a
    # positive value indicating how much can be withdrawn from the account.
    # 
    withdrawalLimit : (AccountUnits),

    # 
    # The Account’s margin call margin used.
    # 
    marginCallMarginUsed : (AccountUnits),

    # 
    # The Account’s margin call percentage. When this value is 1.0 or above the
    # Account is in a margin call situation.
    # 
    marginCallPercent : (DecimalNumber),

    # 
    # The current balance of the account.
    # 
    balance : (AccountUnits),

    # 
    # The total profit/loss realized over the lifetime of the Account.
    # 
    pl : (AccountUnits),

    # 
    # The total realized profit/loss for the account since it was last reset by
    # the client.
    # 
    resettablePL : (AccountUnits),

    # 
    # The total amount of financing paid/collected over the lifetime of the
    # account.
    # 
    financing : (AccountUnits),

    # 
    # The total amount of commission paid over the lifetime of the Account.
    # 
    commission : (AccountUnits),

    # 
    # The total amount of dividend adjustment paid over the lifetime of the
    # Account in the Account’s home currency.
    # 
    dividendAdjustment : (AccountUnits),

    # 
    # The total amount of fees charged over the lifetime of the Account for the
    # execution of guaranteed Stop Loss Orders.
    # 
    guaranteedExecutionFees : (AccountUnits),

    # 
    # The date/time when the Account entered a margin call state. Only provided
    # if the Account is in a margin call.
    # 
    marginCallEnterTime : (DateTime),

    # 
    # The number of times that the Account’s current margin call was extended.
    # 
    marginCallExtensionCount : (integer),

    # 
    # The date/time of the Account’s last margin call extension.
    # 
    lastMarginCallExtensionTime : (DateTime),

    # 
    # The price-dependent state of each pending Order in the Account.
    # 
    orders : (Array[DynamicOrderState]),

    # 
    # The price-dependent state for each open Trade in the Account.
    # 
    trades : (Array[CalculatedTradeState]),

    # 
    # The price-dependent state for each open Position in the Account.
    # 
    positions : (Array[CalculatedPositionState])
}

AccountPropertiesProperties related to an Account.

AccountProperties is an application/json object with the following Schema:

{
    # 
    # The Account’s identifier
    # 
    id : (AccountID),

    # 
    # The Account’s associated MT4 Account ID. This field will not be present
    # if the Account is not an MT4 account.
    # 
    mt4AccountID : (integer),

    # 
    # The Account’s tags
    # 
    tags : (Array[string])
}

GuaranteedStopLossOrderParametersThe current mutability and hedging settings related to guaranteed Stop Loss orders.

GuaranteedStopLossOrderParameters is an application/json object with the following Schema:

{
    # 
    # The current guaranteed Stop Loss Order mutability setting of the Account
    # when market is open.
    # 
    mutabilityMarketOpen : (GuaranteedStopLossOrderMutability),

    # 
    # The current guaranteed Stop Loss Order mutability setting of the Account
    # when market is halted.
    # 
    mutabilityMarketHalted : (GuaranteedStopLossOrderMutability)
}

GuaranteedStopLossOrderModeThe overall behaviour of the Account regarding guaranteed Stop Loss Orders.

Value	Description
DISABLED	The Account is not permitted to create guaranteed Stop Loss Orders.
ALLOWED	The Account is able, but not required to have guaranteed Stop Loss Orders for open Trades.
REQUIRED	The Account is required to have guaranteed Stop Loss Orders for all open Trades.

GuaranteedStopLossOrderMutabilityFor Accounts that support guaranteed Stop Loss Orders, describes the actions that can be be performed on guaranteed Stop Loss Orders.

Value	Description
FIXED	Once a guaranteed Stop Loss Order has been created it cannot be replaced or cancelled.
REPLACEABLE	An existing guaranteed Stop Loss Order can only be replaced, not cancelled.
CANCELABLE	Once a guaranteed Stop Loss Order has been created it can be either replaced or cancelled.
PRICE_WIDEN_ONLY	An existing guaranteed Stop Loss Order can only be replaced to widen the gap from the current price, not cancelled.

AccountSummaryA summary representation of a client’s Account. The AccountSummary does not provide to full specification of pending Orders, open Trades and Positions.

Implemented by: Account

AccountSummary is an application/json object with the following Schema:

{
    # 
    # The Account’s identifier
    # 
    id : (AccountID),

    # 
    # Client-assigned alias for the Account. Only provided if the Account has
    # an alias set
    # 
    alias : (string),

    # 
    # The home currency of the Account
    # 
    currency : (Currency),

    # 
    # ID of the user that created the Account.
    # 
    createdByUserID : (integer),

    # 
    # The date/time when the Account was created.
    # 
    createdTime : (DateTime),

    # 
    # The current guaranteed Stop Loss Order settings of the Account. This
    # field will only be present if the guaranteedStopLossOrderMode is not
    # ‘DISABLED’.
    # 
    guaranteedStopLossOrderParameters : (GuaranteedStopLossOrderParameters),

    # 
    # The current guaranteed Stop Loss Order mode of the Account.
    # 
    guaranteedStopLossOrderMode : (GuaranteedStopLossOrderMode),

    # 
    # The current guaranteed Stop Loss Order mutability setting of the Account.
    # This field will only be present if the guaranteedStopLossOrderMode is not
    # ‘DISABLED’.
    # 
    # 
    # Deprecated: Will be removed in a future API update.
    # 
    guaranteedStopLossOrderMutability : (GuaranteedStopLossOrderMutability, deprecated),

    # 
    # The date/time that the Account’s resettablePL was last reset.
    # 
    resettablePLTime : (DateTime),

    # 
    # Client-provided margin rate override for the Account. The effective
    # margin rate of the Account is the lesser of this value and the OANDA
    # margin rate for the Account’s division. This value is only provided if a
    # margin rate override exists for the Account.
    # 
    marginRate : (DecimalNumber),

    # 
    # The number of Trades currently open in the Account.
    # 
    openTradeCount : (integer),

    # 
    # The number of Positions currently open in the Account.
    # 
    openPositionCount : (integer),

    # 
    # The number of Orders currently pending in the Account.
    # 
    pendingOrderCount : (integer),

    # 
    # Flag indicating that the Account has hedging enabled.
    # 
    hedgingEnabled : (boolean),

    # 
    # The total unrealized profit/loss for all Trades currently open in the
    # Account.
    # 
    unrealizedPL : (AccountUnits),

    # 
    # The net asset value of the Account. Equal to Account balance +
    # unrealizedPL.
    # 
    NAV : (AccountUnits),

    # 
    # Margin currently used for the Account.
    # 
    marginUsed : (AccountUnits),

    # 
    # Margin available for Account currency.
    # 
    marginAvailable : (AccountUnits),

    # 
    # The value of the Account’s open positions represented in the Account’s
    # home currency.
    # 
    positionValue : (AccountUnits),

    # 
    # The Account’s margin closeout unrealized PL.
    # 
    marginCloseoutUnrealizedPL : (AccountUnits),

    # 
    # The Account’s margin closeout NAV.
    # 
    marginCloseoutNAV : (AccountUnits),

    # 
    # The Account’s margin closeout margin used.
    # 
    marginCloseoutMarginUsed : (AccountUnits),

    # 
    # The Account’s margin closeout percentage. When this value is 1.0 or above
    # the Account is in a margin closeout situation.
    # 
    marginCloseoutPercent : (DecimalNumber),

    # 
    # The value of the Account’s open positions as used for margin closeout
    # calculations represented in the Account’s home currency.
    # 
    marginCloseoutPositionValue : (DecimalNumber),

    # 
    # The current WithdrawalLimit for the account which will be zero or a
    # positive value indicating how much can be withdrawn from the account.
    # 
    withdrawalLimit : (AccountUnits),

    # 
    # The Account’s margin call margin used.
    # 
    marginCallMarginUsed : (AccountUnits),

    # 
    # The Account’s margin call percentage. When this value is 1.0 or above the
    # Account is in a margin call situation.
    # 
    marginCallPercent : (DecimalNumber),

    # 
    # The current balance of the account.
    # 
    balance : (AccountUnits),

    # 
    # The total profit/loss realized over the lifetime of the Account.
    # 
    pl : (AccountUnits),

    # 
    # The total realized profit/loss for the account since it was last reset by
    # the client.
    # 
    resettablePL : (AccountUnits),

    # 
    # The total amount of financing paid/collected over the lifetime of the
    # account.
    # 
    financing : (AccountUnits),

    # 
    # The total amount of commission paid over the lifetime of the Account.
    # 
    commission : (AccountUnits),

    # 
    # The total amount of dividend adjustment paid over the lifetime of the
    # Account in the Account’s home currency.
    # 
    dividendAdjustment : (AccountUnits),

    # 
    # The total amount of fees charged over the lifetime of the Account for the
    # execution of guaranteed Stop Loss Orders.
    # 
    guaranteedExecutionFees : (AccountUnits),

    # 
    # The date/time when the Account entered a margin call state. Only provided
    # if the Account is in a margin call.
    # 
    marginCallEnterTime : (DateTime),

    # 
    # The number of times that the Account’s current margin call was extended.
    # 
    marginCallExtensionCount : (integer),

    # 
    # The date/time of the Account’s last margin call extension.
    # 
    lastMarginCallExtensionTime : (DateTime),

    # 
    # The ID of the last Transaction created for the Account.
    # 
    lastTransactionID : (TransactionID)
}

AccumulatedAccountStateThe mutable state of a client’s Account.

Implemented by: AccountSummary, AccountChangesState

AccumulatedAccountState is an application/json object with the following Schema:

{
    # 
    # The current balance of the account.
    # 
    balance : (AccountUnits),

    # 
    # The total profit/loss realized over the lifetime of the Account.
    # 
    pl : (AccountUnits),

    # 
    # The total realized profit/loss for the account since it was last reset by
    # the client.
    # 
    resettablePL : (AccountUnits),

    # 
    # The total amount of financing paid/collected over the lifetime of the
    # account.
    # 
    financing : (AccountUnits),

    # 
    # The total amount of commission paid over the lifetime of the Account.
    # 
    commission : (AccountUnits),

    # 
    # The total amount of dividend adjustment paid over the lifetime of the
    # Account in the Account’s home currency.
    # 
    dividendAdjustment : (AccountUnits),

    # 
    # The total amount of fees charged over the lifetime of the Account for the
    # execution of guaranteed Stop Loss Orders.
    # 
    guaranteedExecutionFees : (AccountUnits),

    # 
    # The date/time when the Account entered a margin call state. Only provided
    # if the Account is in a margin call.
    # 
    marginCallEnterTime : (DateTime),

    # 
    # The number of times that the Account’s current margin call was extended.
    # 
    marginCallExtensionCount : (integer),

    # 
    # The date/time of the Account’s last margin call extension.
    # 
    lastMarginCallExtensionTime : (DateTime)
}

CalculatedAccountStateThe dynamically calculated state of a client’s Account.

Implemented by: AccountSummary, AccountChangesState

CalculatedAccountState is an application/json object with the following Schema:

{
    # 
    # The total unrealized profit/loss for all Trades currently open in the
    # Account.
    # 
    unrealizedPL : (AccountUnits),

    # 
    # The net asset value of the Account. Equal to Account balance +
    # unrealizedPL.
    # 
    NAV : (AccountUnits),

    # 
    # Margin currently used for the Account.
    # 
    marginUsed : (AccountUnits),

    # 
    # Margin available for Account currency.
    # 
    marginAvailable : (AccountUnits),

    # 
    # The value of the Account’s open positions represented in the Account’s
    # home currency.
    # 
    positionValue : (AccountUnits),

    # 
    # The Account’s margin closeout unrealized PL.
    # 
    marginCloseoutUnrealizedPL : (AccountUnits),

    # 
    # The Account’s margin closeout NAV.
    # 
    marginCloseoutNAV : (AccountUnits),

    # 
    # The Account’s margin closeout margin used.
    # 
    marginCloseoutMarginUsed : (AccountUnits),

    # 
    # The Account’s margin closeout percentage. When this value is 1.0 or above
    # the Account is in a margin closeout situation.
    # 
    marginCloseoutPercent : (DecimalNumber),

    # 
    # The value of the Account’s open positions as used for margin closeout
    # calculations represented in the Account’s home currency.
    # 
    marginCloseoutPositionValue : (DecimalNumber),

    # 
    # The current WithdrawalLimit for the account which will be zero or a
    # positive value indicating how much can be withdrawn from the account.
    # 
    withdrawalLimit : (AccountUnits),

    # 
    # The Account’s margin call margin used.
    # 
    marginCallMarginUsed : (AccountUnits),

    # 
    # The Account’s margin call percentage. When this value is 1.0 or above the
    # Account is in a margin call situation.
    # 
    marginCallPercent : (DecimalNumber)
}

AccountChangesAn AccountChanges Object is used to represent the changes to an Account’s Orders, Trades and Positions since a specified Account TransactionID in the past.

AccountChanges is an application/json object with the following Schema:

{
    # 
    # The Orders created. These Orders may have been filled, cancelled or
    # triggered in the same period.
    # 
    ordersCreated : (Array[Order]),

    # 
    # The Orders cancelled.
    # 
    ordersCancelled : (Array[Order]),

    # 
    # The Orders filled.
    # 
    ordersFilled : (Array[Order]),

    # 
    # The Orders triggered.
    # 
    ordersTriggered : (Array[Order]),

    # 
    # The Trades opened.
    # 
    tradesOpened : (Array[TradeSummary]),

    # 
    # The Trades reduced.
    # 
    tradesReduced : (Array[TradeSummary]),

    # 
    # The Trades closed.
    # 
    tradesClosed : (Array[TradeSummary]),

    # 
    # The Positions changed.
    # 
    positions : (Array[Position]),

    # 
    # The Transactions that have been generated.
    # 
    transactions : (Array[Transaction])
}

AccountFinancingModeThe financing mode of an Account

Value	Description
NO_FINANCING	No financing is paid/charged for open Trades in the Account
SECOND_BY_SECOND	Second-by-second financing is paid/charged for open Trades in the Account, both daily and when the the Trade is closed
DAILY	A full day’s worth of financing is paid/charged for open Trades in the Account daily at 5pm New York time

UserAttributesContains the attributes of a user.

UserAttributes is an application/json object with the following Schema:

{
    # 
    # The user’s OANDA-assigned user ID.
    # 
    userID : (integer),

    # 
    # The user-provided username.
    # 
    username : (string),

    # 
    # The user’s title.
    # 
    title : (string),

    # 
    # The user’s name.
    # 
    name : (string),

    # 
    # The user’s email address.
    # 
    email : (string),

    # 
    # The OANDA division the user belongs to.
    # 
    divisionAbbreviation : (string),

    # 
    # The user’s preferred language.
    # 
    languageAbbreviation : (string),

    # 
    # The home currency of the Account.
    # 
    homeCurrency : (Currency)
}

PositionAggregationModeThe way that position values for an Account are calculated and aggregated.

Value	Description
ABSOLUTE_SUM	The Position value or margin for each side (long and short) of the Position are computed independently and added together.
MAXIMAL_SIDE	The Position value or margin for each side (long and short) of the Position are computed independently. The Position value or margin chosen is the maximal absolute value of the two.
NET_SUM	The units for each side (long and short) of the Position are netted together and the resulting value (long or short) is used to compute the Position value or margin.

Endpoints

Definitions

Account Definitions