Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 24
Next »
Name | Type | Description | Mandatory | Available from version |
---|
| Guid[] | Specific ids to search for. BrickId is the internal id of a trade order. |
|
|
InstrumentType | Int? | Instrument |
|
|
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 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[] | Instrument |
| 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. |
|
|
Response rows (Array) inherits from EntityBase
Name | Type | Description | Available from version |
---|
BrickId | Guid | The internal id of the instrument |
|
InstrumentType | Int | Instrument |
|
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 | Instrument |
|
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 |
Code examples
//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);
}
}
}