Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name
Type
Description
MandatoryAvailable from version
BrickIdGuidNot used  
InstrumentTypeInteger

https://bricknode.atlassian.net/wiki/display/API/Instrument

True 
CurrencyCodeStringISO-code for currency in which instrument is traded.True 
ISINStringThe International Securities Identification Number of the instrument  
NameString   
LastSubscriptionDateDateTime(optional)The last subscription date of the instrument  
ExpirationDateDateTime(optional)The expiration date of the instrument  
PriceDoubleCurrent price  
QuantityDecimalsIntegerThe number of decimals to use on the quantity of units for the instrument  
DisplayDecimalsPriceInteger  
MultiplierDouble(optional) 
 
ValueMultiplierDoubleThe value multiplier for the instrument 2.02.20160422
DisplayMultipierDoubleThe display price multiplier for the instrument For future use
InstrumentStatusInteger

https://bricknode.atlassian.net/wiki/display/API/Instrument

True 
IsUnitOrderBooleanTrue if instrument is traded in units, false if instrument is traded in amount  
InstrumentCategorizationInstrumentCategorizationItem[]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  
TaxCountryStringAccording to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2  
VisibleStatusKeyString

https://bricknode.atlassian.net/wiki/display/API/Instrument

  
MICSymbolStringThe short symbol name for the instrument Must be unique  
SymbolExternalReferenceStringMust be unique 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  
TradingVenueGuidThis is the BrickId of the default TradingVenue for the instrument  
TradingCalendarString  For future use
SettlementCalendarString  For future use

 

Outputs

Name
Type
Description
EntitiesArray

All accounts in the request is returned along with each instrument's BrickId and array of Errors per instrument

Code Block
languagexml
themeRDark
titleXML request example
collapsetrue
 //Create an instrument using the CreateInstruments 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 IC = new InstrumentCategorizationItem()
{    
    GroupKey = "Industry",
    Key = "Technology",
    Weight = 0.3
};

var response = client.CreateInstruments(new BFSServiceReference.CreateInstrumentRequest()
{
    Credentials = credentials,

    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS

    Entities = new[]
    {
        new Instrument()
        {
            InstrumentType = 1,
            CurrencyCode = "SEK",
            ISIN = "SE0000108656",                        
            Name = "TestInstrument",
            Symbol = "TEST",
            TradingCalendar = "ForFutureUse", 
            SettlementCalendar = "ForFutureUse",
            QuantityDecimals = 2,
            DisplayDecimalsPrice = 2,
            ValueMultiplier = 1,
            DisplayMultiplier = 2,
            InstrumentStatus = 1,
            IsUnitOrder = true,
            InstrumentCategorization = new InstrumentCategorizationArray() 
            {
                Array = new InstrumentCategorizationItem[]
                {
                    IC,
                }
            },
            ExternalReference = "External system ID",
            TaxCountry = "SE",           
            Price = 100,
            TradingVenue = new Guid("25d5a96c-87f0-481f-a9b2-bc96e58012fd"),
            VisibleStatusKey = "Open"                                              

        }
    }

});

//Show information about the created instrument

foreach (var c in response.Entities)
{
    Console.WriteLine(c.BrickId + ", " + c.Errors);
}

 

 

International Securities Identification Number