Instruments

Download Spec

All instrument related paths.

List instruments

get /instruments

List instruments

trading_status

string

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"

sort

string

Sort the result by created_at or updated_at.

Default
"created_at"
Enum
  • created_at
  • updated_at

order

string

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

offset

int

int32

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

Min
0

limit

int

int32

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

Default
100
Min
0
Max
1000

Response

ExamplesSchema

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 instrument

get /instruments/{instrument_id}

Returns the instrument.

instrument_id

One Of

required

Instrument unique identifier.

Response

ExamplesSchema

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"
}

id

string

uuid

required

Event unique identifier

created_at

string

date-time

required

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

type

string

required

Event type

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

object

object (object)

required

webhook_id

string

uuid

required

Webhook unique identifier.

Request

{
  "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

ExamplesSchema

Request has been processed successfully.

Empty response

Was this page helpful?