LookupDefinition

The lookup service is a convenient, reasonably efficient way to find a single best match for each of a list of symbol terms in a given symbology.

Syntax

ILookupDefinition Definition(string terms) => new LookupDefinition(terms)

ILookupDefinition Definition() => new LookupDefinition()

Returned value

LookupDefinition object.

LookupDefinition Methods

ILookupDefinition View(Search.View view)

The supported View to search against the full service.

The view parameter is optional. Default: Search.LightView.SearchAllLight

ILookupDefinition View(Search.LightView view)

The supported View to search against the light service.

The view parameter is optional. Default: Search.LightView.SearchAllLight

ILookupDefinition Terms(string terms)

A string of terms defining the symbols to be resolved.

ILookupDefinition Scope(string scope)

Identifies the symbology which Terms belong to.

Optional. Default: "_AllUnique" (full service), "RIC" (light service)

ILookupDefinition Select(string select)

A comma-separated list of the properties of a document to be returned in the response.

Optional. Default: '_' (same as main Search service)

ILookupDefinition Filter(string filter)

Filter values are boolean predicate expressions to be applied to documents. Required.

ILookupDefinition Boost(string boost)

Boost applies a scoring boost to matched documents, which will almost always guarantee that they appear at the top of the results.

Boost supports exactly the same predicate expression syntax as Filter, except Filter restricts which documents are matched.

ILookupDefinition Closure(object closure)

Optionally, include a user-defined Closure to match specific requests and responses.

Usage

Below we have a provided a code snippet containing several search cases

// RICs - convert to all known symbol types using default output
var lookup = Lookup.Definition()
                    .View(Search.View.SearchAll)
                    .Terms("VOD.L,037833100,IBM,US5949181045")
                    .GetData();

// RICs - convert to all known symbol types using targeted output
lookup = Lookup.Definition()
               .View(Search.View.SearchAll)
               .Terms("VOD.L,037833100,IBM,US5949181045")
               .Select("DocumentTitle, CUSIP, SEDOL, RIC, TickerSymbol, IssueISIN, IssuerOAPermID, FundClassLipperID")
               .GetData();

// RICs - convert RICs with default output
lookup = Lookup.Definition()
               .Terms("VOD.L,AAPL.O,IBM,MSFT.O")
               .Scope("RIC")
               .GetData();

// RICs - convert to all known symbol types using targeted output
lookup = Lookup.Definition()
               .Terms("VOD.L,AAPL.O,IBM,MSFT.O")
               .Scope("RIC")
               .Select("DocumentTitle,CUSIP,SEDOL,RIC,TickerSymbol,IssueISIN,IssuerOAPermID,FundClassLipperID")
               .GetData();

// CUSIPs - convert to all known symbol types using targeted output
lookup = Lookup.Definition()
               .Terms("037833100,459200101,594918104")
               .Scope("CUSIP")
               .Select("DocumentTitle,SEDOL,RIC,TickerSymbol,IssueISIN,IssuerOAPermID,FundClassLipperID")
               .GetData();

// Invalid request - Scope must be defined
lookup = Lookup.Definition()
               .Terms("037833100,459200101,594918104")
               .Select("DocumentTitle,SEDOL,RIC,TickerSymbol,IssueISIN,IssuerOAPermID,FundClassLipperID")
               .GetData();