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 승인된 입력 없음. 0이 아님
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.