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

01واجهات API

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.

المجموعة المنهجية المسار الوصول 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 المفتاح مسارات السيناريوهات
المحركات 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.

التصميم

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
الاستجابةواجهة برمجة المقطع العامفوري

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
    واجهة برمجة المقطع العام
  2. Origin and rate limit

    Edge · Public cut API · < 5 ms
    Admitted origins · Per-IP limit
    واجهة برمجة المقطع العام
  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
    واجهة برمجة المقطع العام
المخرجات
السجل الناتج المهمة من المرحلة
X-Nexus-Withheld headers Licence filter سجل التراخيص السياسات
JSON response الاستجابة واجهة برمجة المقطع العام 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
    ⁨Foundry⁩سجل PostgreSQL (أمان على مستوى الصفوف)
  5. Sandbox calls

    Provision · You · self-serve
    Keys tested · SDMX keys and tiles
    واجهة برمجة المقطع العامالبلاطات المتجهية
  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.

11States

States and errors

الحالة Meaning
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.