Read the index
GET /v1/qscore/index is public and requires no credential. If period is
omitted, the API selects the most recently closed UTC quarter. Optional
filters are:
Public index
200 OK
items is ordered by country, industry code and band. There is no pagination:
the endpoint returns the filtered snapshot.
Methodology and privacy
At the end of each quarter, the index takes the latest score of each subject whose score existed before the quarter closed. It groups by country, industry code and score band (A, B, C, D, E or SC). A bucket is published
only when it contains at least five subjects. avg_score is the rounded
integer average of the scores in that bucket.
The index is append-only by period and bucket. It is not a live score for any
individual, and the API does not expose a subject-level drill-down.
Response states and period validation
Valid values are
YYYY-Q1, YYYY-Q2, YYYY-Q3 and YYYY-Q4. The year must
be between 2020 and 9999. An invalid value returns 400 invalid_period.
See the error catalog.
Authenticated equivalent
GET /v1/qscore/index/account returns the same snapshot and filters for an
authenticated account or organization read scope. Account-level callers must
have the risk service enabled; administrative read scopes are not tied to a
single account flag.
The index does not charge a fee, emit a webhook or send an email.
FAQ
Can I identify a subject from a bucket?
Can I identify a subject from a bucket?
No. Buckets with fewer than five subjects are omitted and the response
never contains document or account identifiers.
Does an omitted period mean the current quarter?
Does an omitted period mean the current quarter?
No. It means the most recently closed UTC quarter, so a partially completed
quarter is never presented as final.
Can I request only one industry?
Can I request only one industry?
Yes. Send
industry_code together with country and period.