Skip to content

I-Global Risks Index

The Global Risks Index · developer portal

Build on the index, and contribute to it

Every API and engine in one place, every value addressable by key, and open routes to contribute data, code, design and research.

22
interfaces
5
engines
20
domain index keys
451
indicator keys

01APIs

Every interface in one place

Hosts are announced at launch; paths and payloads are stable. Open routes need no key; engines need an API key; account routes need a signed-in Foundry account.

Group Indlela yokusebenza Path Access What it returns
Public cut GET /api/v1/public/grix/layers Vula Layer catalogue with licence and attribution
Public cut GET /api/v1/public/grix/layers/{id}/features Vula Features of an admitted live layer
Public cut GET /api/v1/public/grix/attribution?layers= Vula Attribution lines for the layers on a map
Platform GET /v1/public/catalogue Vula Everything the index publishes, with identifiers
Platform GET /v1/public/countries Vula The 195 countries and their sites
Platform GET /v1/public/indices Vula The twenty domain indices and their structure
Platform GET /v1/public/indicators Vula Indicator definitions and sources
Platform GET /v1/public/series Vula Global, regional and thematic series
Platform GET /v1/public/standards Vula The Nexus Standards the index implements
Platform GET /v1/public/journeys Vula Guided journeys by audience
Platform GET /v1/public/uni/{uni} Vula Resolve any NS-1 identifier to its record
Engines POST /v1/engines/tail Key Exceedance curves, average annual loss and layer splits on your numbers
Engines POST /v1/engines/composite Key Composite index construction with intervals
Engines POST /v1/engines/cascade Key Cascades across coupled systems
Engines POST /v1/engines/pathways Key Scenario pathways
Engines POST /v1/engines/verify Key Forecast and trigger verification
Idatha GET /v1/export/indicators.csv Key Indicator export with source and licence on every row
Account GET /v1/me Account Your plan and entitlements
Account GET POST /v1/me/api-keys Account Create, list and revoke API keys
Account GET POST /v1/me/watchlists Account Watchlists of countries and indices
Auth POST /api/v1/oauth/token · /introspect · /revoke Account OAuth 2.0 with S256 PKCE through the Foundry
Health GET /v1/health Vula Service state
02Console

The console and your keys

The console opens with the enterprise launch; its address is announced then. Until then, the account page shows what each plan includes.

Account

One Foundry account

Sign-in, plan and entitlements come from the Foundry; the index keeps no passwords.

Keys

API keys

Create, label and revoke keys; every call is metered once and logged.

Usage

Usage and limits

Usage by key and engine, with the limits of your plan.

Engines

Run engines

Run the engines on your own numbers in the browser before calling them from code.

03Contribute

Contribute data, code, design and research

Open contributions travel through two open routes: Zenodo for a citable deposit with a DOI, and the Nexus Reports gateway for review and publication.

Idatha

Datasets and corrections

Deposit a dataset with its licence on Zenodo to get a DOI, then submit it through the Nexus Reports gateway for review and admission.

Ikhowudi

Methods and tools

Deposit code and notebooks on Zenodo with an open licence and a citation file; propose a method through the gateway and its working group.

Design

Figures, maps and interfaces

Deposit designs, styles and figure templates on Zenodo; submit them to the Nexus Reports gateway for the next edition.

Uphando

Papers and evidence

Deposit papers, preprints and evidence on Zenodo; the gateway routes them to the series and the right of reply.

Deposit Upload to Zenodo with an open licence (CC BY 4.0 for data and text, an OSI licence for code), a clear title and the keyword “The Global Risks Index”.
Link Add the page or indicator identifier (UNI) you contribute to as a related identifier, so the record and the page point at each other.
Submit Send the DOI through the Nexus Reports gateway or the contribution form.
Review Every submission is acknowledged, reviewed in public and recorded with its disposition and its effect on any value.
04Repository

The public code repository

Public code repositoryOpening soon. It will hold the page builder, the importers, the licence gate, the conformance tests and the release notes, under an open licence. The link appears here and in every footer when it opens.

Link coming

05API

The public cut

Contract nexus.grix.public/v1: anonymous, read-only, public-classification responses with attribution, freshness, strong ETags and CDN caching. Implemented and not yet deployed; institutional access with service levels is agreed separately.

Indlela yokusebenza Path Returns
GET /api/v1/public/grix/layers Layer catalogue with licence and attribution rows
GET /api/v1/public/grix/layers/{id}/features Features of an admitted live layer
GET /api/v1/public/grix/attribution?layers= Compact and full credits
GET /api/v1/public/grix/risk-products Spatial risk products with withheld accounting
GET /api/v1/public/grix/risk-products/tiles/{metric}/{z}/{x}/{y}.mvt Vector tiles at ISO3, ADM1, ADM2 and H3
GET /api/v1/public/grix/profiles/COUNTRY/{iso3} Public country profile cut, licence-filtered
# a country profile
curl -s https://{grix-host}/API/v1/public/grix/profiles/COUNTRY/KEN | jq ‘.indicators, .withheld’
06Request path

What happens to one API request

A public request passes origin, licence and attribution checks in milliseconds; institutional access runs through scope, contract and sandbox before production keys.

on: GET /profiles/COUNTRY/{iso3}

One API request

In progressTriggered by Your application6 jobs

Graph
01Edge
02Edge
03Umgaqo-nkqubo
04Read
05Respond
06Respond

100%
Timeline
Job0 h1 hTarget
RequestYour applicationinstant
Origin and rate limitPublic cut APIinstant
Licence filterLicence registerinstant
Governed readPostgreSQL ledgerinstant
AttributionAttribution serviceinstant
ResponsePublic cut APIinstant

End to end on the longest path: about 1 h of proposed target service levels. Gates wait for the people named; bars with a fading end have no fixed length.

Steps
  1. Request

    Edge · Your application · instant
    GET with Accept: application/json
    Public cut API
  2. Origin and rate limit

    Edge · Public cut API · < 5 ms
    Admitted origins · Per-IP limit
    Public cut API
  3. Licence filter

    Policy · Licence register · < 5 ms
    Deny by default · Withheld values counted
    Licence register
  4. Governed read

    Read · PostgreSQL ledger · < 50 ms
    Persisted public cut
    PostgreSQL ledger (row-level security)
  5. Attribution

    Respond · Attribution service · < 5 ms
    Credits per admitted source
    Attribution service
  6. Response

    Respond · Public cut API · < 100 ms
    Strong ETag, CDN cache · Supported claim level INTEGRATED
    Public cut API
Artefacts
Artefact Job Who Stage
X-Nexus-Withheld headers Licence filter Licence register Umgaqo-nkqubo
JSON response Response Public cut API Respond
DoneIn progressWaiting for approvalQueuedYou are here
What happens to a single public request, from the edge to an attributed, licence-filtered response. The canvas shows where a request stands at the marked job; it is illustrative, not the status of a real request. Durations are proposed target service levels. Select a job for its steps, the people who act, the technology it runs on and what it produces.

on: access requested

Request API access

Waiting for approvalTriggered by Developer6 jobs1 approval gate1 matrix job

Graph
01Request
02Request
03Agree
04Provision
05Provision
06Use

100%
Timeline
Job0 d5 d10 dTarget
Access requestedYouinstant
Use reviewedSecretariat3 d
AgreementGCRI Canada10 d
Account and keysFoundry1 d
Sandbox callsYouinstant
Production useYouongoing

End to end on the longest path: about 15.7 d of proposed target service levels, before the jobs that run with no fixed end. Gates wait for the people named; bars with a fading end have no fixed length.

Steps
  1. Access requested

    Request · You · instant
    Use case and volume
    NXS-GRX (canonical data, provenance and risk) gateway
  2. Use reviewed

    Request · Secretariat · 3 days
    Usage terms checked · No natural-person use
    Licence register
  3. Agreement approval

    Agree · GCRI Canada · 10 days
    Service levels · Terms signed
    PostgreSQL ledger (row-level security)
  4. Account and keys

    Provision · Foundry · 1 day
    Tenant created · Keys issued · Rate plan set
    FoundryPostgreSQL ledger (row-level security)
  5. Sandbox calls

    Provision · You · self-serve
    Keys tested · SDMX keys and tiles
    Public cut APIVector tiles
  6. Production use matrix · endpoints

    Use · You · ongoing
    Profiles, products, tiles · Attribution rendered
    Public cut APIVector tilesAttribution service
Artefacts
Artefact Job Who Stage
Request record Access requested You Request
Use note Use reviewed Secretariat Request
Agreement Agreement GCRI Canada Agree
Credentials (delivered privately) Account and keys Foundry Provision
First response Sandbox calls You Provision
Usage metering Production use You Use
DoneIn progressWaiting for approvalQueuedApproval gateMatrix jobYou are here
Institutional access to the NXS-GRX API with service levels, contracted with GCRI Canada. The canvas shows where a request stands at the marked job; it is illustrative, not the status of a real request. Durations are proposed target service levels. Select a job for its steps, the people who act, the technology it runs on and what it produces.
07Keys

Identifiers and keys

Indicator
nis:IND.MAC.output.gdp.usd@1.0.0
Domain index
nis:IDX.FIS.debt.fiscal_risk@1.0.0
Observation
{id}:{REF_AREA}:{TIME_PERIOD}:{FREQ}[:{SCENARIO}:{HORIZON}]
Iphepha
GRX-PRF-KEN · GRX-IDX-FIS · GRX-SER-GS-01
Artefact
NS-1 UNI in the GRX scope, assigned on release
08Tiles

Vector tiles

Resolution follows zoom (country, ADM1, ADM2, then H3); features whose inputs are withheld are dropped and counted in response headers.

https://{grix-host}/API/v1/public/grix/risk-products/tiles/{metric}/{z}/{x}/{y}.mvt
09WordPress

Blocks and hydration

Pages carry the Foundry plugin blocks around complete static fallbacks: nexus-foundry/indicator for country values and nexus-foundry/map for released layers. With the plugin, values and maps fill in place; without it, the static page stands. A page can also hydrate from the public cut when risksindex.com is admitted (data-grx-api on the embed root).

10Amaphepha

Machine-readable pages

Every page embeds JSON-LD (Dataset, TechArticle or CollectionPage), a stable page ID and canonical URL; the page manifest lists every page with its ID, title, parent and description.

11States

States and errors

Imeko Meaning
PUBLISHED Released in an edition with interval, class and sources
NO_DATA No admitted input; not a zero
INSUFFICIENT_EVIDENCE Coverage below the method minimum; value withheld
WITHHELD An input’s licence or the public-safe screen does not admit public display; counted
DEGRADED Published with a stated quality limitation
424 PUBLIC_SOURCE_LICENCE_NOT_ADMITTED A layer’s source licence does not admit public display
404 PUBLIC_CUT_NOT_AVAILABLE No public projection for that geography yet
503 Authoritative store unavailable; nothing is served from memory

Form

Contribute data, code, design or research

Structured intake for datasets, methods, code, designs, research and corrections, the way Nexus Reports expects them: deposit on Zenodo first, then send the DOI here.

  1. 01Fill inFields marked (required) are needed; everything else helps the review.
  2. 02ReferenceYou get a reference on screen; the record is kept in this site’s WordPress database.
  3. 03ReviewThe outcome is recorded in public. Contact details stay on this site and are never published or shared.
Form · grx-contribute

This form opens here once it is switched on. Until then, send it through the Nexus Reports gateway, with your deposit on Zenodo.

Contribute through the open routes

Deposit on Zenodo, submit through the Nexus Reports gateway, and follow the review in public.