Skip to main content
Version: 2.1

InstrumentList

A collection of instruments. Use this type for use cases that require not just a single instrument, but multiple (e.g. to populate a watchlist).

When holding information for each instrument is required, it is recommended to use the Portfolio type, though.

Notes:

  • The instrument list schema does not explicitly include identifiers in the id section, as there is not a common standard for such identifiers. Applications can, however, populate this part of the contract with custom identifiers if so desired.

Type

fdc3.instrumentList

Schema

https://fdc3.finos.org/schemas/2.1/context/instrumentList.schema.json https://fdc3.finos.org/schemas/2.1/context/instrumentList.schema.json

Details

PropertyTypeRequiredExample Value
typestringYes'fdc3.instrumentList'
namestringNo'Interesting instruments...'
idobjectNo{ customId: '5464' }
instrumentsInstrument[]Yes[instrument1, instrument2]

Example

const instruments = {
type: "fdc3.instrumentList",
instruments: [
{
type: "fdc3.instrument",
id: {
ticker: "AAPL"
},
market: {
MIC: "XNAS"
}
},
{
type: "fdc3.instrument",
id: {
ISIN: "US5949181045"
}
},
]
}

fdc3.joinUserChannel('Channel 1')
fdc3.broadcast(instruments)

See Also

Other Types

Intents

FINOS Financial Objects