Skip to main content
API docs by Redocly

Vontobel Reference Data API (all-versions)

Download OpenAPI specification:Download

Product Data Engineering Team: supportfpdataservice@vontobel.com

Part of the Structured Products Reference Data API suite offering access to Vontobel structured products information

Instruments (v1)

Get single Instrument By ISIN

Authorizations:
Bearer
path Parameters
isin
required
string

The requested Instrument ISIN

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "legalCountry": "string",
  • "currency": "string",
  • "priceType": "string",
  • "issuePrice": 0,
  • "denomination": 0,
  • "subscriptionEndTime": "string",
  • "initialFixingTime": "string",
  • "finalFixingTime": "string",
  • "paymentDate": "string",
  • "repaymentDate": "string",
  • "settlementType": "string",
  • "quanto": true,
  • "exerciseType": "string",
  • "direction": "string",
  • "identifiers": [
    ],
  • "classifications": [
    ],
  • "underlyings": [
    ],
  • "interests": [
    ],
  • "repayment": {
    },
  • "markets": [
    ],
  • "parties": [
    ],
  • "distributions": [
    ],
  • "documents": [
    ],
  • "regulations": {
    }
}

Get my Instruments

This allows a client user to request only instruments that they are "related" to, for example distributor. This has to be setup for your API user once before this route is available

Authorizations:
Bearer
query Parameters
limit
integer <int32>
Default: 1000

Max number of instruments to return. The limit of this maximum is 10000

minId
integer or null <int64>

ID to start retrieving from (used to loop through all instruments)

legalCountry
string or null

Optional filter for legal country

partnerRelationship
string or null

Optional filter for type of relationship with Vontobel - for example distribution

Responses

Response samples

Content type
application/json
{
  • "instruments": [
    ],
  • "links": {
    }
}

Get Instruments

This allows a client user to request all Vontobel instruments

Authorizations:
Bearer
query Parameters
limit
integer <int32>
Default: 1000

Max number of instruments to return. The limit of this maximum is 10000

minId
integer or null <int64>

ID to start retrieving from (used to loop through all instruments)

legalCountry
string or null

Optional filter for legal country

Responses

Response samples

Content type
application/json
{
  • "instruments": [
    ],
  • "links": {
    }
}

Get Instrument Events

This is used to get instrument events that have happened since a certain time. For example, get all new issues or redemptions in the last 10 seconds or last day.

Authorizations:
Bearer
query Parameters
since
string or null

Get events since this time/ID

maxEvents
integer <int32>
Default: 100

Max events to return

legalCountry
string or null

Optional filter for legal country

eventType
string or null

Optional filter for event type

Responses

Response samples

Content type
application/json
{
  • "nextId": "string",
  • "events": [
    ],
  • "links": {
    }
}

Get Instrument Events

This is used to get instrument events that have happened since a certain time. For example, get all new issues or redemptions in the last 10 seconds or last day.

Authorizations:
Bearer
query Parameters
since
string or null

Get events since this time/ID

maxEvents
integer <int32>
Default: 100

Max events to return

legalCountry
string or null

Optional filter for legal country

eventType
string or null

Optional filter for event type

Responses

Response samples

Content type
application/json
{
  • "nextId": "string",
  • "events": [
    ],
  • "links": {
    }
}

Get My Instrument Events

This is used to get instrument events for the API user that have happened since a certain time. For example, get all new issues or redemptions related to instruments related to the API user in the last 10 seconds or last day.

Authorizations:
Bearer
query Parameters
since
string or null

Get events since this time/ID

maxEvents
integer <int32>
Default: 100

Max events to return

legalCountry
string or null

Optional filter for legal country

eventType
string or null

Optional filter for event type

partnerRelationship
string or null

Optional filter for type of relationship with Vontobel - for example distribution

Responses

Response samples

Content type
application/json
{
  • "nextId": "string",
  • "events": [
    ],
  • "links": {
    }
}

Simulation (v1)

Get single Simulation By Instrument Id

Authorizations:
Bearer
path Parameters
id
required
integer <int64>

The requested Simulation's Instrument Id

Responses

Response samples

Content type
application/json
{
  • "instrument": {
    }
}

Get single Simulation By ISIN

Authorizations:
Bearer
path Parameters
isin
required
string

The requested Simulation's ISIN

Responses

Response samples

Content type
application/json
{
  • "instrument": {
    }
}