All instrument related paths.
/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).
sort
string
Sort the result by created_at
or 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.
offset
int
Use the offset
argument to specify where in the list of results to start when returning items for a particular query.
limit
int
Use the limit
argument to specify the maximum number of items returned.
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"
}
]
}
/instruments/{instrument_id}
Returns the instrument.
instrument_id
One Of
required
Instrument unique identifier.
Must match one of
International securities identification number defined by ISO 6166, prefixed with a 'isin:' URN scheme.
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
required
Event unique identifier
created_at
string
required
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
type
string
required
Event type
object
object
required
id
string
required
Instrument unique identifier.
created_at
string
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
isin
string
International securities identification number defined by ISO 6166.
wkn
string
German securities identification code known as Wertpapierkennnummer.
name
string
required
Instrument name
fractional_trading
boolean
required
Determines whether the platform can handle fractional investments within this instrument.
trading_status
string
required
Instrument trading status
details
object (Details)
Details
webhook_id
string
required
Webhook unique identifier.
{
"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"
}
Request has been processed successfully.
Empty response
Was this page helpful?