Instruments

Get instrument

Returns the instrument identified by instrument_id, including its identifiers, name, trading status, and whether it supports fractional investing.

See the instruments guide (TOL / BYOL / Omnibus) for instrument onboarding, delisting, and trading bans.

get/instruments/{instrument_id}

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/instruments/{instrument_id}
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: instruments:read)

Response

OK

idstring uuid required

Instrument unique identifier.

created_atstring date-time required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

updated_atstring date-time required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

isinstring

International securities identification number defined by ISO 6166.

wknstring

German securities identification code known as Wertpapierkennnummer.

namestring required

The name of the instrument.

fractional_tradingboolean required

Determines whether the platform can handle fractional investments within this instrument.

trading_status'ACTIVE' | 'INACTIVE' required

Instrument trading status

  • ACTIVE - The instrument can currently be traded on the Upvest platform.
  • INACTIVE - The instrument cannot currently be traded on the Upvest platform.

Changes

No recorded changes to this operation across all 25 revisions of this API.