API status
  • Instruments & Price Data

Instruments

All instrument related paths.

get

List instruments

List instruments

trading_statusstring

Filters the list to only show instruments with a certain status (e.g. only instruments that can be currently traded).

Enum
  • ACTIVE
  • INACTIVE
Example
"ACTIVE"
sortstring

Sort the result by created_at or updated_at.

Default
"created_at"
Enum
  • created_at
  • updated_at
orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default
"ASC"
Enum
  • ASC
  • DESC
offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format
int32
Min
0
limitint

Use the limit argument to specify the maximum number of items returned.

Format
int32
Default
100
Min
0
Max
1000

Responses

Response examples

OK

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 10,
    "sort": "created_at",
    "order": "ASC"
  },
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2022-08-31T17:28:00.00Z",
      "updated_at": "2022-08-31T17:28:00.00Z",
      "isin": "DE0007664005",
      "wkn": "766400",
      "name": "Volkswagen (VW) St. Aktie.",
      "fractional_trading": true,
      "trading_status": "ACTIVE"
    }
  ]
}
get

Get instrument

Returns the instrument.

instrument_idOne Of

required

Instrument unique identifier.

Must match one of

International securities identification number defined by ISO 6166, prefixed with a 'isin:' URN scheme.

Pattern
^(urn:)?isin:[A-Z]{2}[A-Z0-9]{9}[0-9]$

Responses

Response examples

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2022-08-31T17:28:00.00Z",
  "updated_at": "2022-08-31T17:28:00.00Z",
  "isin": "DE0007664005",
  "wkn": "766400",
  "name": "Volkswagen (VW) St. Aktie.",
  "fractional_trading": true,
  "trading_status": "ACTIVE"
}
webhook

Instruments events

idstring

required

Event unique identifier

Format
uuid
created_atstring

required

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

Format
date-time
typestring

required

Event type

Enum
  • INSTRUMENT.ONBOARDED
  • INSTRUMENT.ACTIVATED
  • INSTRUMENT.DEACTIVATED
  • INSTRUMENT.FRACTIONAL_TRADING_ENABLED
  • INSTRUMENT.FRACTIONAL_TRADING_DISABLED
  • INSTRUMENT.DATA_CHANGED
objectobject

required

idstring

required

Instrument unique identifier.

Format
uuid
created_atstring

required

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

Format
date-time
updated_atstring

required

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

Format
date-time
isinstring

International securities identification number defined by ISO 6166.

Pattern
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
wknstring

German securities identification code known as Wertpapierkennnummer.

Pattern
^[A-HJ-NP-Z0-9]{6}$
namestring

required

Instrument name

Max Length
100
fractional_tradingboolean

required

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

trading_statusstring

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.
Enum
  • ACTIVE
  • INACTIVE
detailsobject (Details)

Details

webhook_idstring

required

Webhook unique identifier.

Format
uuid

Responses

Request examples

{
  "id": "de4e9e75-5c74-44c7-b741-9b3e0d85f4de",
  "created_at": "2022-08-31T17:28:00.00Z",
  "type": "INSTRUMENT.ACTIVATED",
  "object": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2022-03-31T17:28:00.00Z",
    "updated_at": "2022-08-31T17:28:00.00Z",
    "isin": "DE0007664005",
    "wkn": "766400",
    "name": "Volkswagen (VW) St. Aktie.",
    "fractional_trading": true,
    "trading_status": "ACTIVE"
  },
  "webhook_id": "0af63506-289c-4051-8859-4e17ec89b002"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?