Skip to main content
The API separates raw data extraction, computed analytics, and metadata discovery. Pick the route whose output shape matches what you need: raw entity rows, a trend line, a rating histogram, a sector table, a list of movers, or reference metadata. The four analytics routes compute summaries server-side from your scope. Use getdata when you need one row per entity and date. Use metadata routes before building a UI or integration, especially metadata/columns for available field names, data types, filters, facets, and entitlements.

Output shape by route: portfolio trend, rating distribution, sector breakdown, and rating changes.

Data and analytics routes

Metadata routes

If you already plan to aggregate, bucket, sort, or group the data yourself, prefer the analytic route instead of pulling rows with getdata and reshaping them client-side.

Request order

Every analytic route follows the same order:
  1. scope selects the input universe.
  2. The route computes its result for that universe.
  3. result_filter shapes the returned rows.
scope.filters decides which entities enter the analytic. result_filter.filters only filters the rows that come back. See Scope and empty results for patterns and edge cases. For metric and rating_scale, see Metrics and scales. For copy-paste payloads, see Payload examples.