How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OANDA Accounts API

The Accounts API from OANDA — 29 operation(s) for accounts.

OANDA Accounts API is one of 11 APIs that OANDA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 31 operations across 29 paths, and defines 57 schemas. It is described by OpenAPI 2.0, at version 3.0.25.

31 operations 29 paths 57 schemas 22 GET1 PATCH1 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.0.25
License
Resource Areas
1

Paths & Operations 31

Across 29 paths, the API surfaces 31 operations — 22 GET, 1 PATCH, 1 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Accounts 31
GET
/accounts/{accountID}/positions
List Positions
listPositions 2 params → 200401404405
GET
/accounts/{accountID}/openPositions
Open Positions
listOpenPositions 2 params → 200401404405
GET
/accounts/{accountID}/positions/{instrument}
Instrument Position
getPosition 3 params → 200401404405
PUT
/accounts/{accountID}/positions/{instrument}/close
Close Position
closePosition 5 params → 200400401404405
GET
/accounts/{accountID}/trades
List Trades
listTrades 8 params → 200401404405
GET
/accounts/{accountID}/openTrades
List Open Trades
listOpenTrades 3 params → 200401404405
GET
/accounts/{accountID}/trades/{tradeSpecifier}
Trade Details
getTrade 4 params → 200401404405
PUT
/accounts/{accountID}/trades/{tradeSpecifier}/close
Close Trade
closeTrade 5 params → 200400401404405
PUT
/accounts/{accountID}/trades/{tradeSpecifier}/clientExtensions
Set Trade Client Extensions
setTradeClientExtensions 5 params → 200400401404405
PUT
/accounts/{accountID}/trades/{tradeSpecifier}/orders
Set Dependent Orders
setTradeDependentOrders 5 params → 200400401404405
GET
/accounts
List Accounts
listAccounts 1 param → 200401405
GET
/accounts/{accountID}
Account Details
getAccount 3 params → 200400401405
GET
/accounts/{accountID}/summary
Account Summary
getAccountSummary 3 params → 200400401405
GET
/accounts/{accountID}/instruments
Account Instruments
getAccountInstruments 3 params → 200400401405
PATCH
/accounts/{accountID}/configuration
Configure Account
configureAccount 4 params → 200400403401404405
GET
/accounts/{accountID}/changes
Poll Account Updates
getAccountChanges 4 params → 200401404405416
GET
/accounts/{accountID}/transactions
List Transactions
listTransactions 7 params → 200400401403404405416
GET
/accounts/{accountID}/transactions/{transactionID}
Transaction Details
getTransaction 4 params → 200401404405
GET
/accounts/{accountID}/transactions/idrange
Transaction ID Range
getTransactionRange 6 params → 200400401404405416
GET
/accounts/{accountID}/transactions/sinceid
Transactions Since ID
getTransactionsSinceId 4 params → 200400401404405416
GET
/accounts/{accountID}/transactions/stream
Transaction Stream
streamTransactions 2 params → 200400401404405
GET
/accounts/{accountID}/pricing
Current Account Prices
getPrices 7 params → 200400401404405
GET
/accounts/{accountID}/pricing/stream
Price Stream
streamPricing 5 params → 200400401404405
GET
/accounts/{accountID}/instruments/{instrument}/candles
Get Candlesticks
getInstrumentCandles 14 params → 200400401404405
POST
/accounts/{accountID}/orders
Create Order
createOrder 4 params → 201400401403404405
GET
/accounts/{accountID}/orders
List Orders
listOrders 8 params → 200400404405
GET
/accounts/{accountID}/pendingOrders
Pending Orders
listPendingOrders 3 params → 200401404405
GET
/accounts/{accountID}/orders/{orderSpecifier}
Get Order
getOrder 4 params → 200401404405
PUT
/accounts/{accountID}/orders/{orderSpecifier}
Replace Order
replaceOrder 6 params → 201400401404405
PUT
/accounts/{accountID}/orders/{orderSpecifier}/cancel
Cancel Order
cancelOrder 5 params → 200401404405
PUT
/accounts/{accountID}/orders/{orderSpecifier}/clientExtensions
Set Order Extensions
setOrderClientExtensions 5 params → 200400401404405

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are Account (39 properties), AccountSummary (36 properties), OrderFillTransaction (26 properties), MarketOrderRejectTransaction (24 properties). Each schema is shown below with its type and property counts.

Account
object
The full details of a client's Account. This includes full open Trade, open Position and pending Order representation.
39 properties
Instrument
object
Full specification of an Instrument.
13 properties
PriceBucket
object
A Price Bucket represents a price available for an amount of liquidity
2 properties
TradeReduce
object
A TradeReduce object represents a Trade for an instrument that was reduced (either partially or fully) in an Account. It is found embedded in Transactions that…
7 properties
AccountProperties
object
Properties related to an Account.
3 properties
ClientPrice
object
The specification of an Account-specific Price.
11 properties
ClientConfigureTransaction
object
A ClientConfigureTransaction represents the configuration of an Account by a client.
9 properties
Trade
object
The specification of a Trade within an Account. This includes the full representation of the Trade's dependent Orders in addition to the IDs of those Orders.
19 properties
InstrumentCommission
object
An InstrumentCommission represents an instrument-specific commission
3 properties
OrderRequest
object
The base Order specification used when requesting that an Order be created. Each specific Order-type extends this definition.
CandlestickData
object
The price data (open, high, low, close) for the Candlestick representation.
4 properties
OrderCancelTransaction
object
An OrderCancelTransaction represents the cancellation of an Order in the client's Account.
11 properties
OrderCancelRejectTransaction
object
An OrderCancelRejectTransaction represents the rejection of the cancellation of an Order in the client's Account.
10 properties
PositionSide
object
The representation of a Position for a single direction (long or short).
8 properties
HomeConversions
object
HomeConversions represents the factors to use to convert quantities of a given currency into the Account's home currency. The conversion factor depends on the…
4 properties
StopLossOrderRejectTransaction
object
A StopLossOrderRejectTransaction represents the rejection of the creation of a StopLoss Order.
20 properties
PricingHeartbeat
object
A PricingHeartbeat object is injected into the Pricing stream to ensure that the HTTP connection remains active.
2 properties
TakeProfitOrder
object
A TakeProfitOrder is an order that is linked to an open Trade and created with a price threshold. The Order will be filled (closing the Trade) by the first pri…
20 properties
UnitsAvailableDetails
object
Representation of many units of an Instrument are available to be traded for both long and short Orders.
2 properties
StopLossOrder
object
A StopLossOrder is an order that is linked to an open Trade and created with a price threshold. The Order will be filled (closing the Trade) by the first price…
23 properties
TrailingStopLossOrder
object
A TrailingStopLossOrder is an order that is linked to an open Trade and created with a price distance. The price distance is used to calculate a trailing stop…
21 properties
ClientConfigureRejectTransaction
object
A ClientConfigureRejectTransaction represents the reject of configuration of an Account by a client.
10 properties
TrailingStopLossOrderTransaction
object
A TrailingStopLossOrderTransaction represents the creation of a TrailingStopLoss Order in the user's Account.
18 properties
StopLossOrderTransaction
object
A StopLossOrderTransaction represents the creation of a StopLoss Order in the user's Account.
21 properties
TradeClientExtensionsModifyRejectTransaction
object
A TradeClientExtensionsModifyRejectTransaction represents the rejection of the modification of a Trade's Client Extensions.
11 properties
TradeSummary
object
The summary of a Trade within an Account. This representation does not provide the full details of the Trade's dependent Orders.
19 properties
TradeClientExtensionsModifyTransaction
object
A TradeClientExtensionsModifyTransaction represents the modification of a Trade's Client Extensions.
10 properties
Transaction
object
The base Transaction specification. Specifies properties that are common between all Transaction.
6 properties
CalculatedTradeState
object
The dynamic (calculated) state of an open Trade
3 properties
ClientExtensions
object
A ClientExtensions object allows a client to attach a clientID, tag and comment to Orders and Trades in their Account. Do not set, modify, or delete this field…
3 properties
AccountChangesState
object
An AccountState Object is used to represent an Account's current price-dependent state. Price-dependent Account state is dependent on OANDA's current Prices, a…
16 properties
CalculatedPositionState
object
The dynamic (calculated) state of a Position
5 properties
QuoteHomeConversionFactors
object
QuoteHomeConversionFactors represents the factors that can be used used to convert quantities of a Price's Instrument's quote currency into the Account's home…
2 properties
MarketOrderTradeClose
object
A MarketOrderTradeClose specifies the extensions to a Market Order that has been created specifically to close a Trade.
3 properties
Order
object
The base Order definition specifies the properties that are common to all Orders.
4 properties
Candlestick
object
The Candlestick representation
6 properties
TakeProfitOrderRejectTransaction
object
A TakeProfitOrderRejectTransaction represents the rejection of the creation of a TakeProfit Order.
18 properties
DynamicOrderState
object
The dynamic state of an Order. This is only relevant to TrailingStopLoss Orders, as no other Order type has dynamic state.
4 properties
Position
object
The specification of a Position within an Account.
10 properties
TransactionHeartbeat
object
A TransactionHeartbeat object is injected into the Transaction stream to ensure that the HTTP connection remains active.
3 properties
OrderClientExtensionsModifyRejectTransaction
object
A OrderClientExtensionsModifyRejectTransaction represents the rejection of the modification of an Order's Client Extensions.
12 properties
OrderClientExtensionsModifyTransaction
object
A OrderClientExtensionsModifyTransaction represents the modification of an Order's Client Extensions.
11 properties
MarketOrderDelayedTradeClose
object
Details for the Market Order extensions specific to a Market Order placed with the intent of fully closing a specific open trade that should have already been…
3 properties
TrailingStopLossOrderRejectTransaction
object
A TrailingStopLossOrderRejectTransaction represents the rejection of the creation of a TrailingStopLoss Order.
18 properties
UnitsAvailable
object
Representation of how many units of an Instrument are available to be traded by an Order depending on its postionFill option.
4 properties
TradeOpen
object
A TradeOpen object represents a Trade for an instrument that was opened in an Account. It is found embedded in Transactions that affect the position of an inst…
7 properties
TrailingStopLossDetails
object
TrailingStopLossDetails specifies the details of a Trailing Stop Loss Order to be created on behalf of a client. This may happen when an Order is filled that o…
4 properties
TakeProfitOrderTransaction
object
A TakeProfitOrderTransaction represents the creation of a TakeProfit Order in the user's Account.
18 properties
StopLossDetails
object
StopLossDetails specifies the details of a Stop Loss Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requ…
6 properties
MarketOrderPositionCloseout
object
A MarketOrderPositionCloseout specifies the extensions to a Market Order when it has been created to closeout a specific Position.
2 properties
MarketOrderRejectTransaction
object
A MarketOrderRejectTransaction represents the rejection of the creation of a Market Order.
24 properties
MarketOrderTransaction
object
A MarketOrderTransaction represents the creation of a Market Order in the user's account. A Market Order is an Order that is filled immediately at the current…
23 properties
MarketOrderMarginCloseout
object
Details for the Market Order extensions specific to a Market Order placed that is part of a Market Order Margin Closeout in a client's account
1 property
AccountChanges
object
An AccountChanges Object is used to represent the changes to an Account's Orders, Trades and Positions since a specified Account TransactionID in the past.
9 properties
TakeProfitDetails
object
TakeProfitDetails specifies the details of a Take Profit Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade…
4 properties
OrderFillTransaction
object
An OrderFillTransaction represents the filling of an Order in the client's Account.
26 properties
AccountSummary
object
A summary representation of a client's Account. The AccountSummary does not provide to full specification of pending Orders, open Trades and Positions.
36 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oanda-accounts-api-openapi.yml Raw ↑

Other APIs OANDA publishes across the network.

OANDA Account API
OANDA Order API
OANDA Trade API
OANDA Position API
OANDA Transaction API
OANDA Pricing API
OANDA Exchange Rates API
OANDA Instruments API
OANDA Pricing API
OANDA Users API
Where this information came from

This is an independent, third-party profile of OANDA Accounts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.