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}

1 回の 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.