Skip to content

⁨The 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.

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
Engines POST /v1/engines/tail راهنما Exceedance curves, average annual loss and layer splits on your numbers
Engines POST /v1/engines/composite راهنما Composite index construction with intervals
Engines POST /v1/engines/cascade راهنما Cascades across coupled systems
Engines POST /v1/engines/pathways راهنما Scenario pathways
Engines 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.

Keys

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.

Engines

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
    ⁨Foundry⁩دفتر PostgreSQL (امنیت سطح ردیف)
  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.
07Keys

Identifiers and keys

نشانگر
nis:IND.MAC.output.gdp.usd@1.0.0
Domain index
nis:IDX.FIS.debt.fiscal_risk@1.0.0
Observation
{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
08Tiles

کاشی‌های برداری

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.