Skip to end of metadata
Go to start of metadata

Filter inputs

NameTypeDescriptionMandatoryAvailable from version
BrickIdGuid[]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.

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


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