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 20 Next »

Inputs (Array of Instruments) inherits from EntityBase

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


LastSubscriptionDateDateTimeThe last subscription date of the instrument

ExpirationDateDateTimeThe expiration date of the instrument

PriceDoubleCurrent price

QuantityDecimalsIntegerThe number of decimals to use on the quantity of units for the instrument

DisplayDecimalsPriceInteger
True
ValueMultiplierDoubleThe value multiplier for the instrument
2.02
DisplayPercentagePriceBooleanTrue if BFS should display percentage price
2.02
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



SymbolStringThe short symbol name for the instrument Must be unique

ExternalReferenceStringThis 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

CommentStringThe comment for the instrument
2.09
DefaultMarketPlaceGuidThis is the BrickId of the default marketplace for the instrument

TradingCalendarString

For future use
SettlementCalendarString

For future use
IssuerGuidThe Issuer of the instrument. Issuer must be allowed to manage current InstrumentType.


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 examples

C# - CreateInstrument
 //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,
            InstrumentStatus = 1,
            IsUnitOrder = true,
            InstrumentCategorization = new InstrumentCategorizationArray() 
            {
                Array = new InstrumentCategorizationItem[]
                {
                    IC,
                }
            },
            ExternalReference = "External system ID",
            TaxCountry = "SE",           
            Price = 100,
            DefaultMarketPlace = 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);
}


Blog stream

Create a blog post to share news and announcements with your team and company.

  • No labels