Skip to content

Il 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

01API

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 Metodo Percorso Accesso What it returns
Public cut GET /api/v1/public/grix/layers Aperto Layer catalogue with licence and attribution
Public cut GET /api/v1/public/grix/layers/{id}/features Aperto Features of an admitted live layer
Public cut GET /api/v1/public/grix/attribution?layers= Aperto Attribution lines for the layers on a map
Piattaforma GET /v1/public/catalogue Aperto Everything the index publishes, with identifiers
Piattaforma GET /v1/public/countries Aperto The 195 countries and their sites
Piattaforma GET /v1/public/indices Aperto The twenty domain indices and their structure
Piattaforma GET /v1/public/indicators Aperto Indicator definitions and sources
Piattaforma GET /v1/public/series Aperto Global, regional and thematic series
Piattaforma GET /v1/public/standards Aperto The Nexus Standards the index implements
Piattaforma GET /v1/public/journeys Aperto Guided journeys by audience
Piattaforma GET /v1/public/uni/{uni} Aperto Resolve any NS-1 identifier to its record
Motori POST /v1/engines/tail Legenda Exceedance curves, average annual loss and layer splits on your numbers
Motori POST /v1/engines/composite Legenda Composite index construction with intervals
Motori POST /v1/engines/cascade Legenda Cascades across coupled systems
Motori POST /v1/engines/pathways Legenda Scenario pathways
Motori POST /v1/engines/verify Legenda Forecast and trigger verification
Dati GET /v1/export/indicators.csv Legenda 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
Salute GET /v1/health Aperto 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.

Chiavi

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.

Motori

Run engines

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

03Contribuisci

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.

Dati

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.

Codice

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.

Ricerca

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.

Metodo Percorso 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}

Una richiesta API

In progressTriggered by Your application6 jobs

Grafo
01Edge
02Edge
03Politica
04Leggi
05Respond
06Respond

100%
Cronologia
Job0 h1 hTarget
RequestYour applicationinstant
Origin and rate limitPublic cut APIinstant
Licence filterLicence registerinstant
Governed readPostgreSQL ledgerinstant
AttributionAttribution serviceinstant
RispostaAPI del taglio pubblicoimmediato

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.

Passaggi
  1. Request

    Edge · Your application · instant
    GET with Accept: application/json
    API del taglio pubblico
  2. Origin and rate limit

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

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

    Read · PostgreSQL ledger · < 50 ms
    Persisted public cut
    Registro PostgreSQL (sicurezza a livello di riga)
  5. Attribuzione

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

    Respond · Public cut API · < 100 ms
    Strong ETag, CDN cache · Supported claim level INTEGRATED
    API del taglio pubblico
Artefatti
Artefatto Attività Chi Fase
X-Nexus-Withheld headers Licence filter Registro delle licenze Politica
JSON response Risposta API del taglio pubblico Respond
CompletatoIn corsoIn attesa di approvazioneIn codaSei qui
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

Richiedi l'accesso all'API

Waiting for approvalTriggered by Developer6 jobs1 approval gate1 matrix job

Grafo
01Request
02Request
03Agree
04Provision
05Provision
06Utilizzare

100%
Cronologia
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.

Passaggi
  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
    Registro delle licenze
  3. Agreement approval

    Agree · GCRI Canada · 10 days
    Service levels · Terms signed
    Registro PostgreSQL (sicurezza a livello di riga)
  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
    API del taglio pubblicoTile vettoriali
  6. Production use matrix · endpoints

    Use · You · ongoing
    Profiles, products, tiles · Attribution rendered
    Public cut APIVector tilesAttribution service
Artefatti
Artefatto Attività Chi Fase
Scheda della richiesta Access requested Tu Request
Use note Use reviewed Segreteria Request
Agreement Agreement GCRI Canada Agree
Credentials (delivered privately) Account and keys Foundry Provision
First response Sandbox calls Tu Provision
Usage metering Production use Tu Utilizzare
CompletatoIn corsoIn attesa di approvazioneIn codaGate di approvazioneAttività MatrixSei qui
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.
07Chiavi

Identifiers and keys

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

Tile vettoriali

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).

10Pagine

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.

11Stati

States and errors

Stato Significato
PUBLISHED Pubblicato in un’edizione con intervallo, classe e fonti
NO_DATA Nessun input ammesso; non è uno zero
INSUFFICIENT_EVIDENCE Copertura sotto il minimo del metodo; valore trattenuto
WITHHELD La licenza di un dato di input o il filtro di sicurezza pubblica non ne consente la visualizzazione pubblica; conteggiato
DEGRADED Pubblicato con una limitazione di qualità dichiarata
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

Modulo

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. 01CompilaI campi contrassegnati (obbligatorio) sono necessari; tutto il resto aiuta la valutazione.
  2. 02RiferimentoRicevi un riferimento sullo schermo; la registrazione è conservata nel database WordPress di questo sito.
  3. 03ValutazioneL'esito è registrato pubblicamente. I recapiti restano su questo sito e non vengono mai pubblicati né condivisi.
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.