Skip to main content
GET
/
instruments
/
{id_or_symbol}
Retrieve an instrument
curl --request GET \
  --url https://api.example.com/instruments/{id_or_symbol} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "symbol": "<string>",
  "instrument_type": "<unknown>",
  "trading_status": "buy_sell",
  "trading_increment": "<string>",
  "isin": "<string>",
  "issuer_country": "<string>",
  "issuer_credit_rating": "<string>",
  "minimum_trading_quantity": "<string>",
  "trading_currency": "EUR",
  "pro_traders_only": true,
  "maturity_date": "2023-12-25",
  "supports_automatic_rollover": true,
  "initial_auction_date": "2023-12-25",
  "initial_issue_date": "2023-12-25",
  "latest_auction_date": "2023-12-25",
  "latest_issue_date": "2023-12-25",
  "days_to_maturity": 123,
  "issuer": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id_or_symbol
string
required

The ID or symbol of the instrument to retrieve.

Response

OK

​
id
string
required

Unique resource identifier.

​
name
string
required

The name of the instrument.

​
symbol
string
required

A unique, secondary, identifier representing the instrument in financial markets (e.g. ISIN or currency pair). For example, 'US5949181045' for the Apple Inc. stock and 'EUR/USD' for the EUR/USD currency pair.

​
instrument_type
any
required

The type of instrument.

​
trading_status
enum<string>
required

The trading status of the instrument.

Available options:
buy_sell,
buy_only,
sell_only,
not_trading
​
trading_increment
string
required

The trading increment refers to the smallest quantity or value of a financial instrument that can be traded. This means orders must be executed in multiples of this increment.

​
isin
string
required

International Securities Identification Number.

​
issuer_country
string | null
required

The country code (in ISO 3166-1 alpha-2 format) of the instrument issuer.

​
issuer_credit_rating
string | null
required

Credit rating from a credit agency e.g AA.

​
minimum_trading_quantity
string
required

The minimum trading quantity allowed for the given financial instrument.

​
trading_currency
enum<string>
required

The instrument's trading currency.

Available options:
EUR,
USD,
GBP
​
pro_traders_only
boolean
required

Flag indicating if this instrument is only available to professional (incl. elective) investors under MiFID II.

​
maturity_date
string<date> | null
required

The maturity date of the instrument.

​
supports_automatic_rollover
boolean
required

Flag indicating whether account positions in this instrument can be configured to automatically rollover upon maturity.

​
initial_auction_date
string<date> | null
required

The initial auction date (ISO 8601) of the instrument.

​
initial_issue_date
string<date> | null
required

The initial issue date (ISO 8601) of the instrument.

​
latest_auction_date
string<date> | null
required

The latest auction date (ISO 8601) of the instrument (in case of tap issues).

​
latest_issue_date
string<date> | null
required

The latest issue date (ISO 8601) of the instrument (in case of tap issues).

​
days_to_maturity
integer | null
required

The number of days until the instrument matures.

​
issuer
string | null

The name of the instrument issuer.