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.