--- title: "Lusid.Instrument.Quote.Writer" slug: "lusidinstrumentquotewriter" updated: 2024-08-22T09:29:52Z published: 2024-08-22T09:29:52Z canonical: "support.lusid.com/lusidinstrumentquotewriter" --- > ## Documentation Index > Fetch the complete documentation index at: https://support.lusid.com/llms.txt > Use this file to discover all available pages before exploring further. # Lusid.Instrument.Quote.Writer | **Type** | **Read/write** | **Author** | **Availability** | | --- | --- | --- | --- | | [Data provider](/v1/docs/what-are-a-data-provider-and-a-direct-provider) | Write | Finbourne | Provided with LUSID | The `Lusid.Instrument.Quote.Writer` provider enables you to write a [Luminesce SQL query](/v1/docs/understanding-the-luminesce-sql-query-syntax) that either upserts or deletes one or more [quotes](/v1/docs/how-do-i-upload-a-market-price-or-fx-spot-rate-to-the-quote-store) to or from the LUSID Quote Store. > **Note:** The LUSID user running the query must have sufficient [access control permissions](/v1/docs/creating-policies-to-control-access-to-providers-for-different-luminesce-end-users) to both use the provider *and* upsert or delete quote data in LUSID. This should automatically be the case if you are the domain owner. You must construct a valid table of data to write, one quote per record. `Lusid.Instrument.Quote.Writer` lists the fields (columns) available to populate with values for each record, and has a set of parameters to help you construct a valid table. Your query can use the `WriteAction` field to perform one of the following operations: - Upsert a quote; that is, create a quote if it does not exist, and update it if it does. This is the default operation if you omit `WriteAction`. - Delete a quote. **See also:** [Lusid.Instrument.Quote](/v1/docs/lusidinstrumentquote) ## Basic usage ```sql @table_of_data = ; select * from Lusid.Instrument.Quote.Writer where toWrite = @table_of_data; ``` ## Query parameters `Lusid.Instrument.Quote.Writer` has parameters that help you construct a valid table of data to write. > **Note:** The `toWrite` parameter is mandatory and used to actually write the table of data into LUSID. To list available parameters, their data types, default values, and an explanation for each, run the following query using a [suitable tool](/v1/docs/what-tools-are-available-to-write-luminesce-queries): ```sql select FieldName, DataType, ParamDefaultValue, Description from Sys.Field where TableName = 'Lusid.Instrument.Quote.Writer' and FieldType = 'Parameter'; ``` ## Data fields `Lusid.Instrument.Quote.Writer` lists the fields you can populate in your table of data to write. Depending on the operation you want to perform, the following fields are mandatory to include in the table of data: | **Operation** | **Mandatory fields in table of data to write** | | --- | --- | | Upsert | `QuoteScope` `Provider` `InstrumentId` `InstrumentIdType` `QuoteType` `Field` `Value` `Unit` `QuoteEffectiveAt` | | Delete | `QuoteScope` `Provider` `InstrumentId` `InstrumentIdType` `Field` `QuoteEffectiveAt` | Notes on providing values for mandatory fields: - The `Provider` field accepts enumerated values, which include `Bloomberg`, `DataScope`, `SIX`, `FactSet`, `TraderMade`, `Edi`, `Lusid` and `Client`. If your provider isn't listed, you can represent it using `Lusid` or `Client`. - For equity and bond prices, use the `InstrumentIdType` field to specify the required ID type, such as `Figi`, and the `InstrumentId` field to specify the instrument for the price quote, for example `BBG000C05BD1`. - For FX rates, specify `CurrencyPair` for the `InstrumentIdType` field and `<baseCurrency>/<quoteCurrency>` for the `InstrumentId` field, for example `USD/GBP`. - The `QuoteType` field accepts enumerated values, which include `Price`, `Spread`, `Rate`, `LogNormalVol`, `NormalVol`, `ParSpread`, `IsdaSpread`, `Upfront`, `Index`, `Ratio` and `Delta`. - `Field` identifies the type of price provided such as `bid`, `mid` or `ask`. To list all available fields, their data types, whether fields are considered 'main', and an explanation for each, run the following query using a [suitable tool](/v1/docs/what-tools-are-available-to-write-luminesce-queries): ```sql select FieldName, DataType, IsMain, IsPrimaryKey, SampleValues, Description from Sys.Field where TableName = 'Lusid.Instrument.Quote.Writer' and FieldType = 'Column'; ``` ## Write errors We recommend examining the results of every write query using one or more of the `WriteError`, `WriteErrorCode` and `WriteErrorDetail` fields. For each record in the table of data to write, `Lusid.Instrument.Quote.Writer` returns an error code. If the operation is successful, the error code is `0`. If unsuccessful, a positive error code and explanation help you discover why LUSID considers the operation invalid. For example, the query: ```sql @table_of_data = select 'FinbourneMarketData' as QuoteScope, 'Lusid' as Provider, 'BBG000DMBXR2' as InstrumentId, 'Figi' as InstrumentIdType, 'Price' as QuoteType, 'mid' as Field, 117.09 as Value, #2022-07-11# as QuoteEffectiveAt; select WriteErrorCode, WriteError, WriteErrorDetail from Lusid.Instrument.Quote.Writer where toWrite = @table_of_data; ``` ...fails because a `Unit` is not specified. ## Examples > **Note:** For more example Luminesce SQL queries, visit our [Github repo](https://github.com/finbourne/luminesce-examples/tree/master/examples). ### Example 1: Upsert a USD/GBP exchange rate quote for a particular effective date In this example, the instrument identifier type is `CurrencyPair`: ```sql @table_of_data = select 'FinbourneMarketData' as QuoteScope, 'Lusid' as Provider, 'USD/GBP' as InstrumentId, 'CurrencyPair' as InstrumentIdType, 'Rate' as QuoteType, 'mid' as Field, 0.82 as Value, 'GBP' as Unit, #2022-07-08# as QuoteEffectiveAt; select * from Lusid.Instrument.Quote.Writer where ToWrite = @table_of_data; ``` ### Example 2: Delete an existing USD/GBP exchange rate quote In this example, the explicit use of `'Delete' as WriteAction` performs the delete operation: ```sql @table_of_data = select 'FinbourneMarketData' as QuoteScope, 'Lusid' as Provider, 'USD/GBP' as InstrumentId, 'CurrencyPair' as InstrumentIdType, 'mid' as Field, #2022-07-08# as QuoteEffectiveAt, 'Delete' as WriteAction; select * from Lusid.Instrument.Quote.Writer where ToWrite = @table_of_data; ```