Can I request property meta data for search API result values?

martin.grunwald

For example when I request a property of the quotes view:

Search.Definition(Search.View.Quotes).Filter(<some filter>).Select("AssetCategory")

I get results like "ORD" or "EIF"

Is there a way too lookup possible values (and what they mean) for this specific property, or other properties in general?

I tried the meta data lookup for views but could not see a way to request information for the properties themselves.

Alex Putkov.1

@martin.grunwald

Search API has the concept of Navigators to help you with this task. Take a look at the section on Navigators in the Reference documentation for the Search API endpoint (/discovery/search/v1/) on https://apidocs.refinitiv.com/Apps/ApiDocs

E.g. the following request asks for all documents in the Quotes view excluding the documents where AssetCategory property equals 'UNC' (unclassified) to be grouped into buckets by the value of AssetCategory property. AssetCategoryName property, which is more descriptive than the short code in AssetCategory property, is included as a subnavigator.

{
  "View": "Quotes",
  "Filter": "AssetCategory ne 'UNC'",
  "Top": 0,
  "Navigators": "AssetCategory(sub:AssetCategoryName)"
}

The result (abridged to top 3 entries) is

{
  "Total": 76631676,
  "Hits": [],
  "Navigators": {
    "AssetCategory": {
      "Buckets": [
        {
          "Label": "EIW",
          "Count": 30560496,
          "AssetCategoryName": {
            "Buckets": [
              {
                "Label": "Equity/Equity/Index Warrant",
                "Count": 30560496
              }
            ]
          }
        },
        {
          "Label": "EFU",
          "Count": 5277788,
          "AssetCategoryName": {
            "Buckets": [
              {
                "Label": "Energy/Energy Future",
                "Count": 5277788
              }
            ]
          }
        },
        {
          "Label": "FIN",
          "Count": 4539266,
          "AssetCategoryName": {
            "Buckets": [
              {
                "Label": "Fixed Income",
                "Count": 4539266
              }
            ]
          }
        },
...

Effectively this gives you the list of values (or labels) used for AssetCategory property and the corresponding value of AssetCategoryName property.