GetInstruments
Filter inputs
Name | Type | Description | Mandatory | Available from version |
---|---|---|---|---|
BrickIds | Guid[] | Specific ids to search for. BrickId is the id of the instrument. | ||
InstrumentType | Int? | |||
ISINs | String[] | Specific ISINs to search for | ||
CurrencyCode | String | Filter by ISO-code for currency in which the instrument is traded. ("SEK", "USD" etc.) | ||
ExternalReferences | String[] | Filter instruments by external references in BFS. | ||
Comments | String[] | Filter instruments by comments in BFS. | 2.09 | |
LastSubscriptionDateFrom | DateTime? | Last subscription date (Securities terms - Date concepts within the securities market) | ||
LastSubscriptionDateTo | DateTime? | Last subscription date (Securities terms - Date concepts within the securities market) | ||
ExpirationDateFrom | DateTime? | Expiration date from (Securities terms - Date concepts within the securities market) | ||
ExpirationDateTo | DateTime? | Expiration date to (Securities terms - Date concepts within the securities market) | ||
DisplayPercentagePrice | bool? | True if BFS should display percentage price | 2.02 | |
DisplayDecimalsPrice | Int[] | The number of decimals to display for the price of the instrument | 2.02 | |
MICs | String[] | The MIC-code for the default marketplace | 2.02 | |
Names | String[] | The full names of the instruments | 2.02 | |
Symbols | String[] | The short name symbols of the instruments | 2.02 | |
DefaultMarketplace | Guid[] | The BrickId of a TradingVenue that is associated with the instrument as DefaultMarketplace | 2.02 | |
VisibleStatusKey | String[] | 2.02 | ||
InstrumentStatuses | int[] | The status of the instrument according to table found in this page Instrument | 2.09 | |
Issuers | Guid[] | The BrickIds of the Issuer of the instruments. | ||
DebtInstrument | Bool | Debt instrument classification that will be used in TRS2 reporting | 2.13 | |
PreviousClosePrice | double | Previous close price on instrument | 2.15 | |
IsUnitOrder | Bool | If Instrument is UnitOrder | 2.15 | |
TaxCountries | Guid[] | TaxCountry of instrument | 2.15 | |
WhiteLabels | Guid[] | Id of WhiteLabel that instrument belong to | 2.16 | |
HasMifidIIData | Bool | True if instrument has Mifid-data in external app | 2.17 | |
CreatedDateFrom | DateTime? | CreatedDate larget than | 2.17 | |
CreatedDateTo | DateTime? | CreatedDate less than | 2.17 | |
KnowledgeGroups | String[] | The knowledgroups of the instrument | 2.17 | |
ExPostCalcMethod | String | 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 | |
FundEntity | Guid[] | The BrickId of a FundEntity that is associated with the instrument | 2.20 | |
FundCompany | Guid[] | The BrickId of a FundCompany that is associated with the instrument | 2.20 | |
FeeGroups | string[] | Filter by the key of the FeeGroup that is associated with the instrument | 2.23 | |
EnableMifidIITenPercentAlert | Bool | If instrument is of a type that requires warnings for the customers if the value of the instrument drops with 10% | 2.24 | |
LastUpdatedDateFrom | DateTime? | Filter within a specific date range when the instrument was updated. | 2.33 | |
LastUpdatedDateTo | DateTime? | |||
ExcludeFromFeeRelatedSelling | Bool | Says whether an instrument should be considered for selling to free up funds for fees (if this has been specifically set up) | 2.38 | |
FundClass | string | Filter by FundClass of the instrument | Â | Ongoing development |
Response rows (Array) inherits from EntityBase
Name | Type | Description | Available from version |
---|---|---|---|
BrickId | Guid | The internal id of the instrument | |
InstrumentType | Int | ||
CurrencyCode | String | ISO-code for currency in which the instrument is traded | |
ISIN | String | The International Securities Identification Number of the instrument | |
Name | String | The name of the instrument | |
LastSubscriptionDate | DateTime | Last subscription date of the instrument (Securities terms - Date concepts within the securities market) | |
ExpirationDate | DateTime | The expiration date of the instrument (Securities terms - Date concepts within the securities market) | |
Price | Double | The current price of the instrument | |
QuantityDecimals | Int | Number of decimals for the units of the instrument | |
DisplayDecimalsPrice | Int | Number of decimals for the price of the instrument | |
MinAmount | Decimal | The minimum number of units allowed for trading | |
MaxAmount | Decimal | The maximum number of units allowed for trading | |
ExternalReference | String | External reference of the instrument | |
Comment | String | Comment of the instrument | 2.09 |
VisibleStatusKey | String | ||
DisplayPercentagePrice | Bool | True if BFS should display percentage price | 2.02 |
Symbol | String | The short name symbol for the instrument | 2.02 |
MIC | String | The MIC-code of the default marketplace for the instrument | 2.02 |
ValueMultiplier | Double | The value multiplier for the instrument | 2.02 |
InstrumentCategorization | InstrumentCategorizationItem[] | Will return an array of InstrumentCategorizationItems if any | 2.02 |
DefaultMarketPlace | Guid | The BrickId of the default marketplace | 2.02 |
Issuer | Guid | The BrickId of the Issuer of the instrument. | |
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 |
InstrumentStatus | Int | The status of the instrument according to table found in this page Instrument | 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 |
DebtInstrument | Bool | Debt instrument classification that will be used in TRS2 reporting | 2.13 |
PreviousClosePrice | double | Previous close price on instrument | 2.15 |
IsUnitOrder | Bool | If Instrument is UnitOrder | 2.15 |
TaxCountry | Guid | TaxCountry of instrument | 2.15 |
WhiteLabel | Guid | Id of WhiteLabel that instrument belong to | 2.16 |
HasMifidIIData | Bool | True if instrument has Mifid-data in external app | 2.17 |
CreatedDate | DateTime | Date of creation | 2.17 |
KnowledgeGroup | String | Knowledgegroup of the instrument | 2.17 |
ExPostCalcMethod | String | Method for ExPost Calculation | 2.17 |
ManagementFeePercentage | decimal | Field to save ManagementFeePercentage on instrument | 2.19 |
FundEntity | Guid | The BrickId of a FundEntity that is associated with the instrument | 2.20 |
FundCompany | Guid | The BrickId of a FundCompany that is associated with the instrument | 2.20 |
FeeGroup | string | The key of the FeeGroup that is associated with the instrument | 2.23 |
EnableMifidIITenPercentAlert | Bool | If instrument is of a type that requires warnings for the customers if the value of the instrument drops with 10% | 2.24 |
ExecutionInterfaces | Array of ExecutionInterface | 2.26 | |
DefaultExecutionInterfaceKey | string | The key of the DefaultExecutionInterface. | |
LastUpdatedDate | DateTime | The date when the instrument was updated. | 2.33 |
ExcludeFromFeeRelatedSelling | Bool | Says whether an instrument should be considered for selling to free up funds for fees (if this has been specifically set up) | 2.38 |
FundClass | string | FundClass of the instrument | Ongoing development |
Code examples
C# - GetInstruments
//Use the GetInstruments method
var client = new BFSServiceReference.bfsapiSoapClient();
var credentials = new BFSServiceReference.Credentials()
{
UserName = bfsusername, //Username of administrative user in your instance of BFS
Password = bfspassword, //Password of the administrative user in your instance of BFS
};
var orders = client.GetInstruments(new BFSServiceReference.GetInstrumentsRequest()
{
Credentials = credentials,
identify = bfsidentifier, //Identifier is a unique token for your instance of BFS
Args = new GetInstrumentsArgs()
{
MICs = new string[]
{
"MIC2",
},
},
Fields = new BFSServiceReference.GetInstrumentsFields()
{
BrickId = true,
VisibleStatusKey = true,
ExternalReference = true,
Name = true,
CurrencyCode = true,
Price = true,
DisplayDecimalsPrice = true,
InstrumentType = true,
ISIN = true,
QuantityDecimals = true,
Symbol = true,
LastSubscriptionDate = true,
MIC = true,
ValueMultiplier = true,
InstrumentCategorization = true,
DefaultMarketPlace = true,
ExpirationDate = true,
MaxAmount = true,
MinAmount = true
},
});
foreach (var c in orders.Result)
{
Console.WriteLine(c.BrickId + ";" + c.VisibleStatusKey + ";" + c.ExternalReference + ";" + c.Name + ";" + c.CurrencyCode + ";" + c.Price + ";" + c.DisplayDecimalsPrice + ";" +
c.InstrumentType + ";" + c.ISIN + ";" + c.QuantityDecimals + ";" + c.Symbol + ";" + c.LastSubscriptionDate + ";" + c.MIC + ";" + c.ValueMultiplier + ";" + c.DefaultMarketPlace + ";" +
c.ExpirationDate + ";" + c.MaxAmount + ";" + c.MinAmount);
if (c.InstrumentCategorization != null)
{
foreach (var d in c.InstrumentCategorization.Array)
{
Console.WriteLine("Categorization");
Console.WriteLine(d.GroupKey + ", " + d.Key + ", " + d.Weight);
}
}
}
Blog Posts
-
How to manage cash deposits from an external system
created by
Apr 14, 2016
Terms of License
Change Policy
© 2009 - 2024 Huddlestock Technologies AB All rights reserved