Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name
Type
Description
MandatoryAvailable from version
BrickIdGuidNot used

InstrumentTypeInteger

https://bricknode.atlassian.net/wiki/display/API/Instrument

True
CurrencyCodeStringISO-code for currency in which instrument is traded.True
ISINStringThe International Securities Identification Number of the instrument

NameString


LastSubscriptionDateDateTimeThe last subscription date of the instrument

ExpirationDateDateTimeThe expiration date of the instrument

PriceDoubleCurrent price

QuantityDecimalsIntegerThe number of decimals to use on the quantity of units for the instrument

DisplayDecimalsPriceInteger
True
ValueMultiplierDoubleThe value multiplier for the instrument
2.02
DisplayPercentagePriceBooleanTrue if BFS should display percentage price
2.02
InstrumentStatusInteger

https://bricknode.atlassian.net/wiki/display/API/Instrument

True
IsUnitOrderBooleanTrue if instrument is traded in units, false if instrument is traded in amountThis property is deprecated, and is used on executioninterfaces instead

InstrumentCategorizationInstrumentCategorizationItem[]An InstrumentCategorizationItem is a custom field that makes it possible to add instrument categories or other values to an instrument. This is explained here: InstrumentCategorizationItem

TaxCountryStringAccording to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

VisibleStatusKeyString

https://bricknode.atlassian.net/wiki/display/API/Instrument



SymbolStringThe short symbol name for the instrument Must be unique

ExternalReferenceStringThis is an external reference that can be set on the instrument, for example this could be an identifier for an external system, a delimited list of various symbols for different systems like Bloomberg symbol for example

CommentStringThe comment for the instrument
2.09
DefaultMarketPlaceGuidThis is the BrickId of the default marketplace for the instrument

TradingCalendarString

For future use
SettlementCalendarString

For future use
IssuerGuidThe Issuer of the instrument. Issuer must be allowed to manage current InstrumentType.

CustomFieldsobject[]CustomFields is an array of CustomField objects. Each CustomField consists of two strings, FieldName and Value. There are no datatypes associated with these properties, they are just a way for api-users to add custimized data to the object.
2.09

...