---
title: "Returns paginated base instruments, sorted alphabetically"
method: GET
path: "/v4/user/accounts/{server}/{accountId}/instruments/base"
tags: ["Instruments (v4)"]
---

# Returns paginated base instruments, sorted alphabetically

`GET /v4/user/accounts/{server}/{accountId}/instruments/base`

## Request

- Base URL: `https://trading-api.oanda.com` (the document declares no server; this is the origin it was published from)
- URL: `https://trading-api.oanda.com/v4/user/accounts/{server}/{accountId}/instruments/base`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/oanda/apis/up-gateway-v1/docs/v4/user/accounts/:server/:accountId/instruments/base/get.ts> (a 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
- `accountId` string, required

## Query parameters

- `lists` string[]
- `ids` string[]
- `limit` number, required
- `offset` number, required
- `search` string
- `sortBy` 'SYMBOL' | 'NAME' | 'DESCRIPTION': Display-name field by which a collection of instruments can be sorted.

## Response `200`

response

- object
  - `count` number, required
  - `limit` number, required
  - `offset` number, required
  - `data` object[]
    - `id` string, required
    - `name` string, required
    - `description` string, required
    - `category` 'CURRENCY' | 'STOCK' | 'FUTURES' | 'CRYPTO' | 'INDEX' | 'BOND' | 'COMMODITY' | 'EQUITY' | 'EQUITY_CZ' | 'EQUITY_UK' | 'EQUITY_ES' | 'EQUITY_PL' | 'EQUITY_DE' | 'EQUITY_NL' | 'EQUITY_FR' | 'EQUITY_BE' | 'EQUITY_DK' | 'EQUITY_FI' | 'EQUITY_PT' | 'EQUITY_SE' | 'EQUITY_US' | 'ETF', required
    - `pipLocation` number, required
    - `displayPrecision` number, required
    - `icons` string[]: A list of URLs for the instrument's icons.

---

[API](https://skmtc.dev/oanda/apis/up-gateway-v1.md) - [All operations](https://skmtc.dev/oanda/apis/up-gateway-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/oanda/apis/up-gateway-v1/revisions/395d645513bf?raw)