Skip to main content
Version: 1.2

Position

A financial position made up of an instrument and a holding in that instrument. This type is a good example of how new context types can be composed from existing types.

In this case, the instrument and the holding amount for that instrument are required values.

The Position type goes hand-in-hand with the Portfolio type, which represents multiple holdings in a combination of instruments.

Notes:

  • Like all other FDC3 context types, extra properties for the position can be added, the schema just specifies the minimum contract.

  • The position 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.position

Schema

https://fdc3.finos.org/schemas/1.2/position.schema.json

Details

PropertyTypeRequiredExample Value
typestringYes'fdc3.position'
idobjectNo{ positionId: '6475' }
namestringNo'My Apple shares'
holdingnumberYes2000000
instrumentInstrumentYes{ type: 'fdc3.instrument', ... }

Example

const position = {
type: 'fdc3.position',
instrument: {
type: 'fdc3.instrument',
id: {
ticker: 'AAPL'
}
},
holding: 2000000
}

fdc3.raiseIntent('ViewChart', position)

See Also

Other Types

Intents

FINOS Financial Objects