Scopes

A scope is a kind of data a key may read. You choose a key’s scopes when you create it, and they cannot be changed afterwards: create a new key if you need different ones.

Scope	Name in the dashboard	Endpoints
risk_scores	Risk scores	State risk, LGA risk, State transmission, LGA transmission, Transmission model, State context, LGA context
forecasts	Forecasts	State forecasts, LGA forecasts
lga_boundaries	LGA boundaries	State boundaries, LGA boundaries

Periods needs no scope: any valid key can call it.

If a key lacks a scope

The request is refused with 403 and the code SCOPE_REQUIRED:

{
  "statusCode": 403,
  "code": "SCOPE_REQUIRED",
  "message": "This key doesn't include forecasts"
}

Independent researchers

For an independent researcher, the AI4M team decides which scopes the account may use when it unlocks API access. A researcher’s keys can only include those scopes. If you need another, ask from Settings → API access.