Instruments (v4)
Returns paginated base instruments, sorted alphabetically
get/v4/user/accounts/{server}/{accountId}/instruments/base
Request
- Base URLhttps://trading-api.oanda.com (the document declares no server; this is the origin it was published from)
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
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
listsstring[]
Filter instruments by list IDs.
idsstring[]
limitnumber required
offsetnumber required
searchstring
Optional search query to filter instruments
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
Example response
{
"data": [
{
"category": "INDEX"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.