GetInstruments

Filter inputs

NameTypeDescriptionMandatoryAvailable from version
BrickIdsGuid[]Specific ids to search for. BrickId is the internal id of a trade order.

InstrumentTypeInt?Instrument

ISINsString[]Specific ISINs to search for

CurrencyCodeStringFilter by ISO-code for currency in which the instrument is traded. ("SEK", "USD" etc.)

ExternalReferencesString[]Filter instruments by external references in BFS.

CommentsString[]Filter instruments by comments in BFS.
2.09
LastSubscriptionDateFromDateTime?Last subscription date (Securities terms - Date concepts within the securities market)

LastSubscriptionDateToDateTime?Last subscription date (Securities terms - Date concepts within the securities market)

ExpirationDateFromDateTime?Expiration date from (Securities terms - Date concepts within the securities market)

ExpirationDateToDateTime?Expiration date to (Securities terms - Date concepts within the securities market)

DisplayPercentagePricebool?True if BFS should display percentage price
2.02
DisplayDecimalsPriceInt[]The number of decimals to display for the price of the instrument
2.02
MICsString[]The MIC-code for the default marketplace
2.02
NamesString[]The names of the instruments
2.02
SymbolsString[]The short name symbols of the instruments
2.02
DefaultMarketplaceGuid[]The BrickId of a TradingVenue that is associated with the instrument as DefaultMarketplace
2.02
VisibleStatusKeyString[]Instrument
2.02
InstrumentStatusesint[]The status of the instrument according to table found in this page Instrument
2.09
IssuersGuid[]The BrickIds of the Issuer of the instruments.

DebtInstrumentBoolDebt instrument classification that will be used in TRS2 reporting
2.13
PreviousClosePricedoublePrevious close price on instrument
2.15
IsUnitOrderBoolIf Instrument is UnitOrder
2.15
TaxCountriesGuid[]TaxCountry of instrument
2.15
WhiteLabelsGuid[]Id of WhiteLabel that instrument belong to
2.16
HasMifidIIDataBoolTrue if instrument has Mifid-data in external app
2.17
CreatedDateFromDateTime?CreatedDate larget than
2.17
CreatedDateToDateTime?CreatedDate less than
2.17
KnowledgeGroupsString[]The knowledgroups of the instrument
2.17
ExPostCalcMethodString

Method for ExPost Calculation

Within Bricknode Broker this can be set in the GUI

A value of "1" is read as Market Value and a value of "2" is read as Nominal Amount.


2.17
FundEntityGuid[]The BrickId of a FundEntity that is associated with the instrument
2.20
FundCompanyGuid[]The BrickId of a FundCompany that is associated with the instrument
2.20
FeeGroupsstring[]Filter by the key of the FeeGroup that is associated with the instrument
2.23
EnableMifidIITenPercentAlertBoolIf instrument is of a type that requires warnings for the customers if the value of the instrument drops with 10%
2.24

Response rows (Array) inherits from EntityBase

NameTypeDescriptionAvailable from version
BrickIdGuidThe internal id of the instrument
InstrumentTypeIntInstrument
CurrencyCodeStringISO-code for currency in which the instrument is traded
ISINStringThe International Securities Identification Number of the instrument
NameStringThe name of the instrument
LastSubscriptionDateDateTimeLast subscription date of the instrument (Securities terms - Date concepts within the securities market)
ExpirationDateDateTimeThe expiration date of the instrument (Securities terms - Date concepts within the securities market)
PriceDoubleThe current price of the instrument
QuantityDecimalsIntNumber of decimals for the units of the instrument
DisplayDecimalsPriceIntNumber of decimals for the price of the instrument
MinAmountDecimalThe minimum number of units allowed for trading
MaxAmountDecimalThe maximum number of units allowed for trading
ExternalReferenceStringExternal reference of the instrument
CommentStringComment of the instrument2.09
VisibleStatusKeyStringInstrument
DisplayPercentagePriceBoolTrue if BFS should display percentage price2.02
SymbolStringThe short name symbol for the instrument2.02
MICStringThe MIC-code of the default marketplace for the instrument2.02
ValueMultiplierDoubleThe value multiplier for the instrument2.02
InstrumentCategorizationInstrumentCategorizationItem[]Will return an array of InstrumentCategorizationItems if any2.02
DefaultMarketPlaceGuidThe BrickId of the default marketplace2.02
IssuerGuidThe BrickId of the Issuer of the instrument.
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
InstrumentStatusIntThe status of the instrument according to table found in this page Instrument2.09
OrganizerGuidThe BrickId of the Organizer of the instrument2.10
PriceDateDateTimePriceDate is when the current Price of the instrument was set2.10
FeeCategoryKeyStringWhich FeeCategory the instrument is associated with2.10
BuyCommissionPercentageDoubleBuyCommissionPercentage of the instrument2.10
SellCommissionPercentageDoubleSellCommissionPercentage of the instrument2.10
EarlySellFeePercentageDoubleEarlySellFeePercentage of the instrument2.10
ProductCompensationPercentageDoubleProductCompensationPercentage of the instrument2.10
FirstTradeDateDateTimeFirstTradeDate of the instrument (Securities terms - Date concepts within the securities market)2.10
LastTradeDateDateTimeLastTradeDate of the instrument (Securities terms - Date concepts within the securities market)2.10
DatasheetURLStringDatasheetURL of the instrument2.10
LockInPeriodDaysIntNumber of days from the Buy date where the owner has to pay an early sell fee2.10
IsLimitedToAccountTypesBoolIf the instrument is limited to different account types2.10
DebtInstrumentBoolDebt instrument classification that will be used in TRS2 reporting2.13
PreviousClosePricedoublePrevious close price on instrument2.15
IsUnitOrderBoolIf Instrument is UnitOrder2.15
TaxCountryGuidTaxCountry of instrument2.15
WhiteLabelGuidId of WhiteLabel that instrument belong to2.16
HasMifidIIDataBoolTrue if instrument has Mifid-data in external app2.17
CreatedDateDateTimeDate of creation2.17
KnowledgeGroupStringKnowledgegroup of the instrument2.17
ExPostCalcMethodStringMethod for ExPost Calculation2.17
ManagementFeePercentagedecimalField to save ManagementFeePercentage on instrument2.19
FundEntityGuidThe BrickId of a FundEntity that is associated with the instrument2.20
FundCompanyGuidThe BrickId of a FundCompany that is associated with the instrument2.20
FeeGroupstringThe key of the FeeGroup that is associated with the instrument2.23
EnableMifidIITenPercentAlertBoolIf instrument is of a type that requires warnings for the customers if the value of the instrument drops with 10%2.24
ExecutionInterfacesExecutionInterface[]Array of ExecutionInterface2.26
DefaultExecutionInterfaceKeystringThe key of the DefaultExecutionInterface.


Code examples