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 ... provider | Write using the ... provider |
| Instruments of any type (no full economic definition) | Lusid.Instrument | Lusid.Instrument.Writer |
| Bonds | Lusid.Instrument.Bond | Lusid.Instrument.Bond.Writer |
| Equities | Lusid.Instrument.Equity | Lusid.Instrument.Equity.Writer |
| Equity options | Lusid.Instrument.EquityOption | Lusid.Instrument.EquityOption.Writer |
| Exchange-traded options | Lusid.Instrument.ExchangeTradedOption | Lusid.Instrument.ExchangeTradedOption.Writer |
| Funding legs | Lusid.Instrument.FundingLeg | Lusid.Instrument.FundingLeg.Writer |
| Futures | Lusid.Instrument.Future | Lusid.Instrument.Future.Writer |
| FxForwards | Lusid.Instrument.FxForward | Lusid.Instrument.FxForward.Writer |
| FxOptions | Lusid.Instrument.FxOption | Lusid.Instrument.FxOption.Writer |
| Term deposits | Lusid.Instrument.TermDeposit | Lusid.Instrument.TermDeposit.Writer |
| Simple instruments (no full economic definition) | Lusid.Instrument.SimpleInstrument | Lusid.Instrument.SimpleInstrument.Writer |
Portfolios
| To interact with... | Read using the ... provider | Write using the ... provider |
| Portfolio metadata | Lusid.Portfolio | Lusid.Portfolio.Writer |
| Transactions in a transaction portfolio | Lusid.Portfolio.Txn | Lusid.Portfolio.Txn.Writer |
| Constituents in a reference portfolio | Lusid.Portfolio.Constituent | Lusid.Portfolio.Constituent.Writer |
| Holdings in a transaction portfolio | Lusid.Portfolio.Holding | Lusid.Portfolio.Holding.Writer |
| All the portfolios nested in a portfolio group | Lusid.PortfolioGroup | Lusid.PortfolioGroup.Writer |
| Performance returns for portfolios | Lusid.Portfolio.Return | Lusid.Portfolio.Return.Writer |
| Aggregated performance returns | Lusid.Portfolio.AggregatedReturn |
Corporate actions
| To interact with... | Read using the ... provider | Write using the ... provider |
| Corporate actions | Lusid.CorporateAction | Lusid.CorporateAction.Writer |
Quotes
| To interact with... | Read using the ... provider | Write using the ... provider |
| Quotes in the LUSID quote store | Lusid.Instrument.Quote | Lusid.Instrument.Quote.Writer |
Valuation
| To interact with... | Read using the ... provider | Write using the ... provider |
| Valuations | Lusid.Portfolio.Valuation | |
| A2B reports (PnL) | Lusid.Portfolio.AtoB | |
| Recipes | Lusid.Valuation.Recipe | |
| Metrics/queryable keys | Lusid.Portfolio.Valuation.Measure | |
| Manifests | Lusid.Logs.Valuations.Manifest |
Properties
You can either use the dedicated property providers below, or alternatively configure some of the entity providers in the tables above to retrieve custom properties or identifiers. Find out more about this.
| To interact with... | Read using the ... provider | Write using the ... provider |
| Properties on instruments, portfolios and portfolio groups | Lusid.Property | Lusid.Property.Writer |
| Instrument properties (also custom identifiers) | Lusid.Instrument.Property | |
| Holding properties | Lusid.Portfolio.Holding.Property | |
| Transaction properties | Lusid.Portfolio.Txn.Property | Lusid.Portfolio.Txn.Property.Writer |
| Property definitions | Lusid.Property.Definition | Lusid.Property.Definition.Writer |
Scopes
| To interact with... | Read using the ... provider | Write using the ... provider |
| Scopes | Lusid.Scope |
Order management
| To interact with... | Read using the ... provider | Write using the ... provider |
| Orders | Lusid.PortfolioOrder | Lusid.PortfolioOrder.Writer |
| Allocations | Lusid.Allocation | Lusid.Allocation.Writer |
| Executions | Lusid.Execution | Lusid.Execution.Writer |
| Placements | Lusid.Placement | Lusid.Placement.Writer |
| Fee rules | Lusid.FeeRule | Lusid.FeeRule.Writer |
People, legal entities, custom entities and relationships
| To interact with... | Read using the ... provider | Write using the ... provider |
| Persons | Lusid.Person | Lusid.Person.Writer |
| Legal entities | Lusid.LegalEntity | Lusid.LegalEntity.Writer |
| Relationships | Lusid.Relationship | Lusid.Relationship.Writer |
| Custom entities | Lusid.CustomEntity | Lusid.CustomEntity.Writer |
| Custom entity types | Lusid.CustomEntity.Definition |
Structured Result Store data
| To interact with... | Read using the ... provider | Write using the ... provider |
| Structured result store data | Lusid.UnitResult.StructuredResult | Lusid.UnitResult.StructuredResult.Writer |
| Atomised results (virtual documents) | Lusid.UnitResult.AtomisedResult |
Logs
| To interact with... | Read using the ... provider | Write using the ... provider |
| HTTP 5xx server error responses | Lusid.Logs.Error | |
| HTTP 4xx client error responses | Lusid.Logs.Failure | |
| HTTP requests and responses | Lusid.Logs.Request | |
| Access requests | Lusid.Logs.Metrics.Entitlement | |
| Application requests | Lusid.Logs.AppRequest |