OAoanda
Instruments (v4)

Returns paginated instruments, sort alphabetically

get/v4/user/accounts/{server}/{accountId}/instruments/extended

Request

Path parameters

server'oanda' | 'oanda-demo' | 'otms' | 'v20' | 'v20-demo' | 'oj' | 'oj-demo' | 'opt' | 'ftmo-1' required

Account trading server.

accountIdstring required

The user's account identifier.

Query parameters

categorystring
idsstring[]
limitnumber required
offsetnumber required
sortBy'SYMBOL' | 'NAME' | 'DESCRIPTION'

Display-name field by which a collection of instruments can be sorted.

Example:NAME

Optional sort criterion for instrument collections. Sorts the returned instruments alphabetically by the chosen display-name type. When omitted the response keeps its default order.

Response

response

countnumber required
limitnumber required
offsetnumber required

Example response

{
  "data": [
    {
      "category": "INDEX",
      "tradeMode": "TRADE_FULL",
      "marginCalcMode": "TRADE_MODE_FOREX",
      "profitConvert": "BY_MARKET",
      "type": "CFD",
      "marketHours": [
        {
          "type": "MARKET_OPEN"
        }
      ],
      "tradeHours": [
        {
          "type": "MARKET_OPEN"
        }
      ],
      "quoteHours": [
        {
          "type": "MARKET_OPEN"
        }
      ],
      "marginCurrency": "USD"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.