Inputs (Array of Instruments) inherits from EntityBase
Name | Type | Description | Mandatory | Available from version |
|---|---|---|---|---|
| BrickId | Guid | Not used | ||
| InstrumentType | Integer | True | ||
| CurrencyCode | String | ISO-code for currency in which instrument is traded. | True | |
| ISIN | String | The International Securities Identification Number of the instrument | ||
| Name | String | |||
| LastSubscriptionDate | DateTime | The last subscription date of the instrument | ||
| ExpirationDate | DateTime | The expiration date of the instrument | ||
| Price | Double | Current price | ||
| QuantityDecimals | Integer | The number of decimals to use on the quantity of units for the instrument | ||
| DisplayDecimalsPrice | Integer | True | ||
| ValueMultiplier | Double | The value multiplier for the instrument. 1 as default if not set. | 2.02 | |
| DisplayPercentagePrice | Boolean | True if BFS should display percentage price | 2.02 | |
| InstrumentStatus | Integer | True | ||
| IsUnitOrder | Boolean | This property is deprecated, and is used on executioninterfaces instead | ||
| InstrumentCategorization | InstrumentCategorizationItem[] | 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 | ||
| TaxCountry | String | According to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 | ||
| VisibleStatusKey | String | |||
| Symbol | String | The short symbol name for the instrument Must be unique | ||
| ExternalReference | String | This 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 | ||
| Comment | String | The comment for the instrument | 2.09 | |
| DefaultMarketPlace | Guid | This is the BrickId of the default marketplace for the instrument | ||
| TradingCalendar | String | For future use | ||
| SettlementCalendar | String | For future use | ||
| Issuer | Guid | The Issuer of the instrument. Issuer must be allowed to manage current InstrumentType. | ||
| CustomFields | object[] | 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 | |
| Organizer | Guid | The BrickId of the Organizer of the instrument | 2.10 | |
| PriceDate | DateTime | PriceDate is when the current Price of the instrument was set | 2.10 | |
| FeeCategoryKey | String | Which FeeCategory the instrument is associated with | 2.10 | |
| BuyCommissionPercentage | Double | BuyCommissionPercentage of the instrument | 2.10 | |
| SellCommissionPercentage | Double | SellCommissionPercentage of the instrument | 2.10 | |
| EarlySellFeePercentage | Double | EarlySellFeePercentage of the instrument | 2.10 | |
| ProductCompensationPercentage | Double | ProductCompensationPercentage of the instrument | 2.10 | |
| FirstTradeDate | DateTime | FirstTradeDate of the instrument (Securities terms - Date concepts within the securities market) | 2.10 | |
| LastTradeDate | DateTime | LastTradeDate of the instrument (Securities terms - Date concepts within the securities market) | 2.10 | |
| DatasheetURL | String | DatasheetURL of the instrument | 2.10 | |
| LockInPeriodDays | Int | Number of days from the Buy date where the owner has to pay an early sell fee | 2.10 | |
| IsLimitedToAccountTypes | Bool | If the instrument is limited to different account types | 2.10 |
Outputs
Name | Type | Description |
|---|---|---|
| Entities | Array | All accounts in the request is returned along with each instrument's BrickId and array of Errors per instrument |
...