Skip to content

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 पद्धति पथ पहुँच What it returns
Public cut GET /api/v1/public/grix/layers खोलें Layer catalogue with licence and attribution
Public cut GET /api/v1/public/grix/layers/{id}/features खोलें Features of an admitted live layer
Public cut GET /api/v1/public/grix/attribution?layers= खोलें Attribution lines for the layers on a map
प्लेटफ़ॉर्म GET /v1/public/catalogue खोलें Everything the index publishes, with identifiers
प्लेटफ़ॉर्म GET /v1/public/countries खोलें The 195 countries and their sites
प्लेटफ़ॉर्म GET /v1/public/indices खोलें The twenty domain indices and their structure
प्लेटफ़ॉर्म GET /v1/public/indicators खोलें Indicator definitions and sources
प्लेटफ़ॉर्म GET /v1/public/series खोलें Global, regional and thematic series
प्लेटफ़ॉर्म GET /v1/public/standards खोलें The Nexus Standards the index implements
प्लेटफ़ॉर्म GET /v1/public/journeys खोलें Guided journeys by audience
प्लेटफ़ॉर्म GET /v1/public/uni/{uni} खोलें Resolve any NS-1 identifier to its record
इंजन POST /v1/engines/tail संकेत-सूची Exceedance curves, average annual loss and layer splits on your numbers
इंजन POST /v1/engines/composite संकेत-सूची Composite index construction with intervals
इंजन POST /v1/engines/cascade संकेत-सूची Cascades across coupled systems
इंजन POST /v1/engines/pathways संकेत-सूची Scenario pathways
इंजन POST /v1/engines/verify संकेत-सूची Forecast and trigger verification
डेटा GET /v1/export/indicators.csv संकेत-सूची Indicator export with source and licence on every row
खाता GET /v1/me खाता Your plan and entitlements
खाता GET POST /v1/me/api-keys खाता Create, list and revoke API keys
खाता GET POST /v1/me/watchlists खाता Watchlists of countries and indices
Auth POST /api/v1/oauth/token · /introspect · /revoke खाता OAuth 2.0 with S256 PKCE through the Foundry
स्वास्थ्य GET /v1/health खोलें Service state
02कंसोल

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.

खाता

One Foundry account

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

कुंजियाँ

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.

इंजन

Run engines

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

03योगदान करें

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.

डेटा

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.

कोड

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.

शोध

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.

पद्धति पथ 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}

एक API अनुरोध

In progressTriggered by Your application6 jobs

ग्राफ़
01Edge
02Edge
03नीति
04पढ़ें
05Respond
06Respond

100%
समयरेखा
Job0 h1 hTarget
RequestYour applicationinstant
Origin and rate limitPublic cut APIinstant
Licence filterLicence registerinstant
Governed readPostgreSQL ledgerinstant
AttributionAttribution serviceinstant
प्रतिक्रियासार्वजनिक कट APIतत्काल

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.

चरण
  1. Request

    Edge · Your application · instant
    GET with Accept: application/json
    सार्वजनिक कट API
  2. Origin and rate limit

    Edge · Public cut API · < 5 ms
    Admitted origins · Per-IP limit
    सार्वजनिक कट API
  3. Licence filter

    Policy · Licence register · < 5 ms
    Deny by default · Withheld values counted
    लाइसेंस रजिस्टर
  4. Governed read

    Read · PostgreSQL ledger · < 50 ms
    Persisted public cut
    PostgreSQL खाता-बही (पंक्ति-स्तरीय सुरक्षा)
  5. श्रेय

    Respond · Attribution service · < 5 ms
    Credits per admitted source
    Attribution service
  6. प्रतिक्रिया

    Respond · Public cut API · < 100 ms
    Strong ETag, CDN cache · Supported claim level INTEGRATED
    सार्वजनिक कट API
परिणाम
कृति कार्य कौन चरण
X-Nexus-Withheld headers Licence filter लाइसेंस रजिस्टर नीति
JSON response प्रतिक्रिया सार्वजनिक कट API Respond
पूर्णप्रगति मेंअनुमोदन की प्रतीक्षा मेंकतार मेंआप यहाँ हैं
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

API पहुँच का अनुरोध करें

Waiting for approvalTriggered by Developer6 jobs1 approval gate1 matrix job

ग्राफ़
01Request
02Request
03Agree
04Provision
05Provision
06उपयोग करें

100%
समयरेखा
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.

चरण
  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
    लाइसेंस रजिस्टर
  3. Agreement approval

    Agree · GCRI Canada · 10 days
    Service levels · Terms signed
    PostgreSQL खाता-बही (पंक्ति-स्तरीय सुरक्षा)
  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वेक्टर टाइलें
  6. Production use matrix · endpoints

    Use · You · ongoing
    Profiles, products, tiles · Attribution rendered
    Public cut APIVector tilesAttribution service
परिणाम
कृति कार्य कौन चरण
अनुरोध अभिलेख Access requested आप Request
Use note Use reviewed सचिवालय Request
Agreement Agreement GCRI Canada Agree
Credentials (delivered privately) Account and keys Foundry Provision
First response Sandbox calls आप Provision
Usage metering Production use आप उपयोग करें
पूर्णप्रगति मेंअनुमोदन की प्रतीक्षा मेंकतार मेंअनुमोदन गेटमैट्रिक्स कार्यआप यहाँ हैं
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.
07कुंजियाँ

Identifiers and keys

संकेतक
nis:IND.MAC.output.gdp.usd@1.0.0
Domain index
nis:IDX.FIS.debt.fiscal_risk@1.0.0
अवलोकन
{id}:{REF_AREA}:{TIME_PERIOD}:{FREQ}[:{SCENARIO}:{HORIZON}]
पृष्ठ
GRX-PRF-KEN · GRX-IDX-FIS · GRX-SER-GS-01
कृति
NS-1 UNI in the GRX scope, assigned on release
08टाइलें

वेक्टर टाइलें

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

10पृष्ठ

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.

11स्थितियाँ

States and errors

स्थिति अर्थ
PUBLISHED अंतराल, वर्ग और स्रोतों सहित संस्करण में जारी
NO_DATA कोई स्वीकृत इनपुट नहीं; शून्य नहीं
INSUFFICIENT_EVIDENCE कवरेज विधि की न्यूनतम सीमा से नीचे; मान रोका गया
WITHHELD किसी इनपुट का लाइसेंस या सार्वजनिक-सुरक्षा जाँच सार्वजनिक प्रदर्शन की अनुमति नहीं देती; गणना में शामिल
DEGRADED बताई गई गुणवत्ता सीमा के साथ प्रकाशित
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

फ़ॉर्म

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. 01भरें(आवश्यक) चिह्नित फ़ील्ड भरना ज़रूरी है; बाकी सब समीक्षा में मदद करता है।
  2. 02संदर्भआपको स्क्रीन पर एक संदर्भ संख्या मिलती है; रिकॉर्ड इस साइट के WordPress डेटाबेस में रखा जाता है।
  3. 03समीक्षापरिणाम सार्वजनिक रूप से दर्ज किया जाता है। संपर्क विवरण इसी साइट पर रहते हैं और कभी प्रकाशित या साझा नहीं किए जाते।
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.