Any dataset in one layout: entity + fact + provenance.

The shared shape the Python SDK builds from the release (certvas.shared), served: each row is one fact (fact_id, entity_id, entity_name, country_iso3, dataset, measure, value, unit, period_end, period_type, available_at, vintage, provenance_id) with its provenance (source_ref, license_class, extraction_confidence, observed_at, method). Pass exactly one of entity_id or country. The latest vintage of each value is served; award facts and every macro vintage are in the bulk release. Column reference: https://github.com/KingMandase/dataco/blob/main/docs/data/SHARED_SHAPE.md

get/v1/shared/facts

Request

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

Query parameters

entity_idstring

A Certvas ID (DC...) for an issuer's AF-FUND facts, or an ISO 3166-1 alpha-3 country code for its AF-MACRO facts.

countrystring

ISO 3166-1 alpha-3 country code; needs dataset.

dataset'AF-FUND' | 'AF-TENDER' | 'AF-MACRO'

With country: AF-TENDER (tender values, newest release first) or AF-MACRO. With an issuer's entity_id (DC...): AF-FUND (the default, its financials) or AF-TENDER (the contract awards it won).

as_ofstring date

Keep only facts whose available_at is on or before this date (YYYY-MM-DD). Annual macro has no evidenced release date, so it is left out rather than guessed.

measurestring

One measure only, e.g. revenue, FX.ZAR.USD, tender_value.

limitinteger

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

Response

Shared-shape facts with their provenance.

object required

Changes

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