Instruments

flBondAdd

Add one or more bonds

Parameters

Name	Description	Required Field	Format	Example
instruments	Populated table from flBondAdd_Template	Yes	Cell reference	See template
scope	Scope of instruments being added	No	string	MyScope

flBondsGetAll

Get a list of all bonds in LUSID

Parameters

Name	Description	Required Field	Format	Example
as_at_date	Specify AsAt date	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
effective_date	Specify EffectiveDate	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
sort_by	Order results by particular fields.	No	Cell reference	Use the '-' sign to denote descending order, for example '-MyFieldName'.
limit	Limit the number of returned results to this many	No	Whole number	50
filter	Filter results based on filtering expression	No	filtering expression	id.code eq 'test-code'
instruments_property_keys	List of property keys to paint onto instruments	No	Cell reference	A set of cells containing values in the format "domain/scope/code"
scope	Scope of requested instruments	No	string	MyScope
columns	Select your result columns	No	Comma delimited list of strings	"Column1,Column2"

flContractForDifferenceAdd

Add one or more CFDs

Parameters

Name	Description	Required Field	Format	Example
instruments	Populated table from flContractForDifferenceAdd_Template	Yes	Cell reference	See template
scope	Scope of instruments being added	No	string	MyScope

flContractForDifferencesGetAll

Get a list of all CFDs in LUSID

Parameters

Name	Description	Required Field	Format	Example
as_at_date	Specify AsAt date	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
effective_date	Specify EffectiveDate	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
sort_by	Order results by particular fields.	No	Cell reference	Use the '-' sign to denote descending order, for example '-MyFieldName'.
limit	Limit the number of returned results to this many	No	Whole number	50
filter	Filter results based on filtering expression	No	filtering expression	id.code eq 'test-code'
instruments_property_keys	List of property keys to paint onto instruments	No	Cell reference	A set of cells containing values in the format "domain/scope/code"
scope	Scope of requested instruments	No	string	MyScope
columns	Select your result columns	No	Comma delimited list of strings	"Column1,Column2"

flEquitiesGetAll

Get a list of all equities in LUSID

Parameters

Name	Description	Required Field	Format	Example
as_at_date	Specify AsAt date	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
effective_date	Specify EffectiveDate	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
sort_by	Order results by particular fields.	No	Cell reference	Use the '-' sign to denote descending order, for example '-MyFieldName'.
limit	Limit the number of returned results to this many	No	Whole number	50
filter	Filter results based on filtering expression	No	filtering expression	id.code eq 'test-code'
instruments_property_keys	List of property keys to paint onto instruments	No	Cell reference	A set of cells containing values in the format "domain/scope/code"
scope	Scope of requested instruments	No	string	MyScope
columns	Select your result columns	No	Comma delimited list of strings	"Column1,Column2"

flEquityAdd

Add one or more equities

Parameters

Name	Description	Required Field	Format	Example
instruments	Populated table from flEquityAdd_Template	Yes	Cell reference	See template
scope	Scope of instruments being added	No	string	MyScope

flEquityOptionAdd

Add one or more equity options

Parameters

Name	Description	Required Field	Format	Example
instruments	Populated table from flEquityOptionAdd_Template	Yes	Cell reference	See template
scope	Scope of instruments being added	No	string	MyScope

flEquityOptionsGetAll

Get a list of all equity options in LUSID

Parameters

Name	Description	Required Field	Format	Example
as_at_date	Specify AsAt date	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
effective_date	Specify EffectiveDate	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
sort_by	Order results by particular fields.	No	Cell reference	Use the '-' sign to denote descending order, for example '-MyFieldName'.
limit	Limit the number of returned results to this many	No	Whole number	50
filter	Filter results based on filtering expression	No	filtering expression	id.code eq 'test-code'
instruments_property_keys	List of property keys to paint onto instruments	No	Cell reference	A set of cells containing values in the format "domain/scope/code"
scope	Scope of requested instruments	No	string	MyScope
columns	Select your result columns	No	Comma delimited list of strings	"Column1,Column2"

flExchangeTradedOptionAdd

Add one or more Exchange Traded Options

Parameters

Name	Description	Required Field	Format	Example
instruments	Populated table from flExchangeTradedOptionAdd_Template	Yes	Cell reference	See template
scope	Scope of instruments being added	No	string	MyScope

flExchangeTradedOptionsGetAll

Get a list of all Exchange Traded Options in LUSID

Parameters

Name	Description	Required Field	Format	Example
as_at_date	Specify AsAt date	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
effective_date	Specify EffectiveDate	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
sort_by	Order results by particular fields.	No	Cell reference	Use the '-' sign to denote descending order, for example '-MyFieldName'.
limit	Limit the number of returned results to this many	No	Whole number	50
filter	Filter results based on filtering expression	No	filtering expression	id.code eq 'test-code'
instruments_property_keys	List of property keys to paint onto instruments	No	Cell reference	A set of cells containing values in the format "domain/scope/code"
scope	Scope of requested instruments	No	string	MyScope
columns	Select your result columns	No	Comma delimited list of strings	"Column1,Column2"

flFutureAdd

Add one or more futures

Parameters

Name	Description	Required Field	Format	Example
instruments	Populated table from flFutureAdd_Template	Yes	Cell reference	See template
scope	Scope of instruments being added	No	string	MyScope

flFuturesGetAll

Get a list of all futures in LUSID

Parameters

Name	Description	Required Field	Format	Example
as_at_date	Specify AsAt date	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
effective_date	Specify EffectiveDate	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
sort_by	Order results by particular fields.	No	Cell reference	Use the '-' sign to denote descending order, for example '-MyFieldName'.
limit	Limit the number of returned results to this many	No	Whole number	50
filter	Filter results based on filtering expression	No	filtering expression	id.code eq 'test-code'
instruments_property_keys	List of property keys to paint onto instruments	No	Cell reference	A set of cells containing values in the format "domain/scope/code"
scope	Scope of requested instruments	No	string	MyScope
columns	Select your result columns	No	Comma delimited list of strings	"Column1,Column2"

flFxForwardAdd

Add one or more Fx Forwards

Parameters

Name	Description	Required Field	Format	Example
instruments	Populated table from flFxForwardAdd_Template	Yes	Cell reference	See template
scope	Scope of instruments being added	No	string	MyScope

flFxForwardsGetAll

Get a list of all fx forwards in LUSID

Parameters

Name	Description	Required Field	Format	Example
as_at_date	Specify AsAt date	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
effective_date	Specify EffectiveDate	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
sort_by	Order results by particular fields.	No	Cell reference	Use the '-' sign to denote descending order, for example '-MyFieldName'.
limit	Limit the number of returned results to this many	No	Whole number	50
filter	Filter results based on filtering expression	No	filtering expression	id.code eq 'test-code'
instruments_property_keys	List of property keys to paint onto instruments	No	Cell reference	A set of cells containing values in the format "domain/scope/code"
scope	Scope of requested instruments	No	string	MyScope
columns	Select your result columns	No	Comma delimited list of strings	"Column1,Column2"

flFxOptionAdd

Add one or more fx options

Parameters

Name	Description	Required Field	Format	Example
instruments	Populated table from flFxOptionAdd_Template	Yes	Cell reference	See template
scope	Scope of instruments being added	No	string	MyScope

flFxOptionsGetAll

Get a list of all fx options in LUSID

Parameters

Name	Description	Required Field	Format	Example
as_at_date	Specify AsAt date	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
effective_date	Specify EffectiveDate	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
sort_by	Order results by particular fields.	No	Cell reference	Use the '-' sign to denote descending order, for example '-MyFieldName'.
limit	Limit the number of returned results to this many	No	Whole number	50
filter	Filter results based on filtering expression	No	filtering expression	id.code eq 'test-code'
instruments_property_keys	List of property keys to paint onto instruments	No	Cell reference	A set of cells containing values in the format "domain/scope/code"
scope	Scope of requested instruments	No	string	MyScope
columns	Select your result columns	No	Comma delimited list of strings	"Column1,Column2"

flFxSwapAdd

Add one or more Fx Swaps

Parameters

Name	Description	Required Field	Format	Example
instruments	Populated table from flFxSwapAdd_Template	Yes	Cell reference	See template
scope	Scope of instruments being added	No	string	MyScope

flFxSwapsGetAll

Get a list of all fx swaps in LUSID

Parameters

Name	Description	Required Field	Format	Example
as_at_date	Specify AsAt date	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
effective_date	Specify EffectiveDate	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
sort_by	Order results by particular fields.	No	Cell reference	Use the '-' sign to denote descending order, for example '-MyFieldName'.
limit	Limit the number of returned results to this many	No	Whole number	50
filter	Filter results based on filtering expression	No	filtering expression	id.code eq 'test-code'
instruments_property_keys	List of property keys to paint onto instruments	No	Cell reference	A set of cells containing values in the format "domain/scope/code"
scope	Scope of requested instruments	No	string	MyScope
columns	Select your result columns	No	Comma delimited list of strings	"Column1,Column2"

flInstrumentIdentifiersUpdate

Update one or more instrument identifiers

Parameters

Name	Description	Required Field	Format	Example
instrument_id_type	Instrument identifier type	Yes	String	"Figi"
instrument_id	Unique instrument identifier	Yes	String	"BBG000B9XRY4"
updated_instrument_id_type	Instrument identifier you wish to update	Yes	String	"Cusip"
updated_instrument_id	New unique instrument identifier	Yes	String	"037833100"
effective_date	Specify EffectiveDate	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55

flInstrumentLookupUid

Lookup one or more instruments by code. Returns the LUSID instrument identifiers.

Parameters

Name	Description	Required Field	Format	Example
instrument_id_type	Instrument identifier type	Yes	String	"Figi"
instrument_id	Unique instrument identifiers	Yes	Cell reference or list	See template

flInstrumentsAdd

Add one or more instruments

Parameters

Name	Description	Required Field	Format	Example
instruments	Populated table from flInstrumentsAdd_Template	Yes	Cell reference	See template
scope	Scope of instruments being added	No	string	MyScope

flInstrumentsDelete

Delete one or more instruments

Parameters

Name	Description	Required Field	Format	Example
instruments	Instrument identifiers	Yes	Cell reference or list	See template

flInstrumentsGetAll

Get a list of all instruments in LUSID

Parameters

Name	Description	Required Field	Format	Example
as_at_date	Specify AsAt date	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
effective_date	Specify EffectiveDate	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
limit	Limit the number of returned results to this many	No	Whole number	50
filter	Filter results based on filtering expression	No	filtering expression	id.code eq 'test-code'
instruments_property_keys	List of property keys to paint onto instruments	No	Cell reference	A set of cells containing values in the format "domain/scope/code"
scope	Scope of requested instruments	No	string	MyScope
columns	Select your result columns	No	Comma delimited list of strings	"Column1,Column2"

flInstrumentsLookup

Lookup one or more instruments by code. Returns a table containing the instrument details of the specified instruments.

Parameters

Name	Description	Required Field	Format	Example
instrument_id_type	Instrument identifier type	Yes	String	"Figi"
instrument_id	Unique instrument identifiers	Yes	Cell reference	"BBG000B9XRY4"
instruments_property_keys	List of property keys to paint onto the instruments	No	Cell reference	A set of cells containing values in the format "domain/scope/code"

flInstrumentTypesGet

Get a list of allowable instrument types

Parameters

Name	Description	Required Field	Format	Example
columns	Select your result columns	No	Comma delimited list of strings	"Column1,Column2"

flSimpleInstrumentAdd

Add one or more Simple Instruments

Parameters

Name	Description	Required Field	Format	Example
instruments	Populated table from flSimpleInstrumentAdd_Template	Yes	Cell reference	See template
scope	Scope of instruments being added	No	string	MyScope

flSimpleInstrumentsGetAll

Get a list of all Simple Instruments in LUSID

Parameters

Name	Description	Required Field	Format	Example
as_at_date	Specify AsAt date	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
effective_date	Specify EffectiveDate	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
sort_by	Order results by particular fields.	No	Cell reference	Use the '-' sign to denote descending order, for example '-MyFieldName'.
limit	Limit the number of returned results to this many	No	Whole number	50
filter	Filter results based on filtering expression	No	filtering expression	id.code eq 'test-code'
instruments_property_keys	List of property keys to paint onto instruments	No	Cell reference	A set of cells containing values in the format "domain/scope/code"
scope	Scope of requested instruments	No	string	MyScope
columns	Select your result columns	No	Comma delimited list of strings	"Column1,Column2"

flTermDepositAdd

Add one or more term deposits

Parameters

Name	Description	Required Field	Format	Example
instruments	Populated table from flTermDepositAdd_Template	Yes	Cell reference	See template
scope	Scope of instruments being added	No	string	MyScope

flTermDepositsGetAll

Get a list of all Term Deposits in LUSID

Parameters

Name	Description	Required Field	Format	Example
as_at_date	Specify AsAt date	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
effective_date	Specify EffectiveDate	No	YYYY-MM-DD T HH:MM:SS.ms	2019-04-10 T 13:30:45.55
sort_by	Order results by particular fields.	No	Cell reference	Use the '-' sign to denote descending order, for example '-MyFieldName'.
limit	Limit the number of returned results to this many	No	Whole number	50
filter	Filter results based on filtering expression	No	filtering expression	id.code eq 'test-code'
instruments_property_keys	List of property keys to paint onto instruments	No	Cell reference	A set of cells containing values in the format "domain/scope/code"
scope	Scope of requested instruments	No	string	MyScope
columns	Select your result columns	No	Comma delimited list of strings	"Column1,Column2"