Rank issuers on a metric.

Per issuer, the latest full-year period published by as_of (see the parameter), ranked by the metric. rank is a mechanical sort position by metric size, not a rating.

get/v1/screen

Request

  • Base URL: https://api.certvas.com
  • URL: https://api.certvas.com/v1/screen
  • Auth: API key in header X-API-Key

Query parameters

metricstring required

Metric slug from metrics-v1, e.g. gross_margin.

order'asc' | 'desc'

Sort direction.

as_ofstring date

Point-in-time date (YYYY-MM-DD). Per issuer and metric, takes the latest full-year period that had been published by that date, and returns its value only if every filing the value is computed from was available by then with the figures it holds today: the value is exactly what was computable on that date, with no look-ahead. Where that year's figures were revised or completed later, the value is left out rather than replaced by the revised value or an older year, so a historical query can return fewer issuers than were covered then. Because values are recomputed from current figures, a later restatement can remove a value from a past as_of; it never adds one dated before its filing.

countrystring

ISO 3166-1 alpha-2 country code.

limitinteger

Maximum rows to return. Sandbox keys are capped well below the paid ceiling.

Response

Screen results.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.