Views:

Related resources:

Explanation

Tutorials

Reference

Providing you are a LUSID user with sufficient access control permissions, you can write a Luminesce SQL query to retrieve the investment data stored in LUSID itself.

Note: If you are the LUSID domain owner, you are automatically assigned the built-in lusid-administrator role, which has all the permissions necessary to use the providers in this article.

You can retrieve information about entities such as portfolios, instruments and transactions, and also properties decorated onto those entities, for analysis at any point in time. You can calculate holdings, valuations and performance returns on demand. You can also access system information such as logs, scopes and property definitions.

Additionally, you can write certain types of investment data back into LUSID. You must construct a valid table of data in your Luminesce query and use a special toWrite parameter on the provider to actually write data back into LUSID. The query returns a table indicating whether each record has been successfully upserted or not.

Instruments

See a list of all the supported instrument types. Not all have reader/writer providers yet.

To interact with...Read using the ... providerWrite using the ... provider
Instruments of any type (no full economic definition)Lusid.InstrumentLusid.Instrument.Writer
BondsLusid.Instrument.BondLusid.Instrument.Bond.Writer
CFDsLusid.Instrument.ContractForDifferenceLusid.Instrument.ContractForDifference.Writer
EquitiesLusid.Instrument.EquityLusid.Instrument.Equity.Writer
Equity optionsLusid.Instrument.EquityOptionLusid.Instrument.EquityOption.Writer
Exchange-traded optionsLusid.Instrument.ExchangeTradedOptionLusid.Instrument.ExchangeTradedOption.Writer
Funding legsLusid.Instrument.FundingLegLusid.Instrument.FundingLeg.Writer
FuturesLusid.Instrument.FutureLusid.Instrument.Future.Writer
FxForwardsLusid.Instrument.FxForwardLusid.Instrument.FxForward.Writer
FxOptionsLusid.Instrument.FxOptionLusid.Instrument.FxOption.Writer
Term depositsLusid.Instrument.TermDepositLusid.Instrument.TermDeposit.Writer
Simple instruments (no full economic definition)Lusid.Instrument.SimpleInstrumentLusid.Instrument.SimpleInstrument.Writer

Portfolios

To interact with...Read using the ... providerWrite using the ... provider
Portfolio metadataLusid.PortfolioLusid.Portfolio.Writer
Transactions in a transaction portfolioLusid.Portfolio.TxnLusid.Portfolio.Txn.Writer
Constituents in a reference portfolioLusid.Portfolio.ConstituentLusid.Portfolio.Constituent.Writer
Holdings in a transaction portfolioLusid.Portfolio.HoldingLusid.Portfolio.Holding.Writer
All the portfolios nested in a portfolio groupLusid.PortfolioGroupLusid.PortfolioGroup.Writer
Performance returns for portfoliosLusid.Portfolio.ReturnLusid.Portfolio.Return.Writer
Aggregated performance returnsLusid.Portfolio.AggregatedReturn 

Corporate actions

To interact with...Read using the ... providerWrite using the ... provider
Corporate actionsLusid.CorporateActionLusid.CorporateAction.Writer

Quotes

To interact with...Read using the ... providerWrite using the ... provider
Quotes in the LUSID quote storeLusid.Instrument.QuoteLusid.Instrument.Quote.Writer

Valuation and reconciliation

To interact with...Read using the ... providerWrite using the ... provider
ValuationsLusid.Portfolio.Valuation 
A2B reports (PnL)Lusid.Portfolio.AtoB 
RecipesLusid.Valuation.Recipe 
Metrics/queryable keysLusid.Portfolio.Valuation.Measure 
ManifestsLusid.Logs.Valuations.Manifest 
Holdings or valuation reconciliationLusid.Portfolio.Reconciliation.Generic 

Properties

You can either use the dedicated property providers below, or alternatively configure some of the entity providers in the tables above to retrieve properties or identifiers. Find out more about this.

To interact with...Read using the ... providerWrite using the ... provider
Properties on instruments, portfolios and portfolio groupsLusid.PropertyLusid.Property.Writer
Instrument properties (also custom identifiers)Lusid.Instrument.Property 
Holding propertiesLusid.Portfolio.Holding.Property 
Transaction propertiesLusid.Portfolio.Txn.PropertyLusid.Portfolio.Txn.Property.Writer
Property types and derived property typesLusid.Property.DefinitionLusid.Property.Definition.Writer

Scopes and cut labels

To interact with...Read using the ... providerWrite using the ... provider
ScopesLusid.Scope 
Cut labelsLusid.CutLabelLusid.CutLabel.Writer

Order management

To interact with...Read using the ... providerWrite using the ... provider
OrdersLusid.PortfolioOrderLusid.PortfolioOrder.Writer
AllocationsLusid.AllocationLusid.Allocation.Writer
ExecutionsLusid.ExecutionLusid.Execution.Writer
PlacementsLusid.PlacementLusid.Placement.Writer
Fee rulesLusid.FeeRuleLusid.FeeRule.Writer

People, legal entities and relationships

To interact with...Read using the ... providerWrite using the ... provider
PersonsLusid.PersonLusid.Person.Writer
Legal entitiesLusid.LegalEntityLusid.LegalEntity.Writer
RelationshipsLusid.RelationshipLusid.Relationship.Writer

Custom entities

By default, Luminesce knows nothing about your custom entities, so providers for them do not exist out-of-the-box. You must create a read/write provider pair for each type of custom entity you wish to interact with. Find out more about this.

To interact with...Read using the ... providerWrite using the ... provider
Custom entity typesLusid.CustomEntity.Definition 

Structured Result Store data

To interact with...Read using the ... providerWrite using the ... provider
Structured result store dataLusid.UnitResult.StructuredResultLusid.UnitResult.StructuredResult.Writer
Atomised results (virtual documents)Lusid.UnitResult.AtomisedResult 

Logs

To interact with...Read using the ... providerWrite using the ... provider
HTTP 5xx server error responsesLusid.Logs.Error 
HTTP 4xx client error responsesLusid.Logs.Failure 
HTTP requests and responsesLusid.Logs.Request 
Access requestsLusid.Logs.Metrics.Entitlement 
Application requestsLusid.Logs.AppRequest