---
title: "List Instruments"
method: GET
path: "/instruments"
tags: ["Instruments"]
---

# List Instruments

`GET /instruments`

Retrives a list of Instruments.

## Query parameters

- `status` string
- `isOptionsEnabled` boolean

## Response `200`

Retrieving a list of Instruments was Successful.

- union[]
  - union
    - InstrumentInList
      - `id` string, uuid, required — A unique ID created by DriveWealth to identify a specific instrument.
      - `symbol` string — The ticker symbol of the associated Instrument.
      - `name` string — The official name of the company associated to the Instrument.
      - `enableExtendedHoursNotionalStatus` string — The Instrument's eligibility for extended hours notional trading. This will default to INACTIVE
      - `instrumentType` 'EQUITY' | 'ALTERNATIVE_ASSET' | 'MUTUAL_FUND' | 'DEBT' | 'OPTION' | 'CRYPTO' — The classification of the instrument.
      - `type` 'EQUITY' | 'ETF' | 'ETN' | 'ADR' | 'ALTERNATIVE_ASSET' | 'MUTUAL_FUND' | 'INTEREST_RATE' — The classification of the Instrument.
      - `status` 'ACTIVE' | 'INACTIVE' | 'CLOSE_ONLY' | 'HALTED', required — The current status of the instrument.
      - `ISIN` string — An `International Securities Identification Number` (ISIN) uniquely identifies a security. Its structure is defined in ISO 6166. ISINs are commonly used when an Instrument does not have a `symbol`, such as Debt Instruments and Global Mutual Funds.
      - `isOptionsEnabled` boolean — The ability to trade options for this equity instrument.
      - `payFrequency` 'ANNUALLY' | 'SEMI_ANNUALLY' | 'QUARTERLY' | 'MONTHLY' | 'WEEKLY' | 'DAILY' | 'EVERY_X_DAYS' | 'EVERY_X_MONTHS' | 'EVERY_X_WEEKS' | 'EVERY_X_YEARS' | 'AT_MATURITY' | 'SINGLE_DATE' | 'SINGLE_INTEREST_PAYMENT' | 'FLEXIBLE' | 'NOT_APPLICABLE' — The anticipated frequency of scheduled interest payments under the Bonds.
      - `couponRate` number, double — The annual rate of interest currently applicable to the instrument.
      - `maturityDate` string, date — The date on which the principal amount of the debt instrument becomes due.
      - `spRating` string — The long term S&P Rating of the issuer.
      - `bondType` 'OTHER' | 'CORPORATE_BOND' | 'GOVERNMENT/AGENCY_BOND' | 'US_MUNICIPAL_BOND' | 'COLLATERALIZED_MORTGAGE_OBLIGATION/ASSET-BACKED_SECURITY' | 'MORTGAGE-BACKED_SECURITY' | 'MONEY_MARKET' | 'COMMON_EQUITY' | 'PREFERRED_EQUITY' | 'RIGHT' | 'WARRANT' | 'OPTION' | 'FUTURE' | 'SWAP' | 'CURRENCY' | 'COMMODITY' | 'INDEX' | 'MUTUAL_FUND/UNIT_INVESTMENT_TRUST' | 'MONEY_MARKET_FUND' | 'EXCHANGE_TRADED_FUND' | 'HYBRID' | 'NON-US_MORTGAGE-BACKED_SECURITY' | 'COMPOSITE_UNIT' | 'DEBT/EQUITY_HYBRID' | 'STRATEGY' | 'OVER-THE-COUNTER_(OTC)' | 'BANK_LOAN' | 'MBS_GENERIC' — The type of bond.
      - `domicileCountry` string — The ISO standard country alpha-2 code.
    - DebtInstrumentDetails
      - `symbol` string, nullable — The ticker symbol of the Instrument. Debt Instruments and Global Mutual Funds do not have symbols and are referred to buy their `instrumentID` or `ISIN`.
      - `name` string — A friendly name of the Instrument, like the Company name for an equity
      - `orderSizeMax` number — The maximum share amount for any order of this Instrument.
      - `orderSizeMin` number — The minimum share amount for any order of this Instrument.
      - `orderSizeStep` number — Increment amount on order of this Instrument.
      - `id` string, uuid — A unique ID created by DriveWealth to identify a specific instrument.
      - `instrumentType` 'EQUITY' | 'ALTERNATIVE_ASSET' | 'MUTUAL_FUND' | 'DEBT' | 'OPTION' | 'CRYPTO' — The classification of the instrument.
      - `exchange` string — The stock exchange the instrument is listed on.
      - `status` 'ACTIVE' | 'INACTIVE' | 'CLOSE_ONLY' | 'HALTED' — The current status of the instrument.
      - `ISIN` string — An `International Securities Identification Number` (ISIN) uniquely identifies a security. Its structure is defined in ISO 6166. ISINs are commonly used when an Instrument does not have a `symbol`, such as Debt Instruments and Global Mutual Funds.
      - `CUSIP` string — CUSIP stands for `Committee on Uniform Securities Identification Procedures`. A CUSIP number identifies most financial instruments, including: stocks of all registered U.S. and Canadian companies, commercial paper, and U.S. government and municipal bonds. The CUSIP system facilitates the clearance and settlement process of securities. CUSIP numbers consist of nine characters (including letters and numbers) that uniquely identify a company or issuer and the type of financial instrument. A similar system is used to identify foreign securities (`CUSIP International Numbering System or CINS`). CINS employs the same nine character identifier as CUSIP, but also contains a letter in the first position to signify the issuer's country or geographic region.
      - `settlementDays` integer — Number of days for the instrument to settle

---

[API](https://skmtc.net/drivewealth/apis/authentication-apis.md) · [All operations](https://skmtc.net/drivewealth/apis/authentication-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/drivewealth/authentication-apis/versions/9fced6d0ac41/schema)