for developers · api
PeppolStatus API documentation & developer resources.
PeppolStatus exposes everything it measures through a public, read‑only REST API at api.peppolstatus.com. No authentication is required to start — the specification, interactive reference, and guides are all linked below.
The API
The PeppolStatus API
The base URL is https://api.peppolstatus.com. Every
endpoint is public and read‑only —
no authentication is required. An optional API key
(pps_live_… / pps_test_…) is issued
instantly with a free account at
app.peppolstatus.com/sign-up
and managed at
app.peppolstatus.com/keys;
today keys add attribution only.
Requests are limited to 60 requests per 60 seconds
per client, reported on every response via RateLimit-*
headers. Only GET, HEAD, and
OPTIONS are allowed. CORS is open
(Access-Control-Allow-Origin: *), so you can call the API
directly from a browser. List endpoints use cursor pagination —
{ items, next_cursor } — and participant IDs use
the canonical scheme::value form, e.g.
0208::0762747721.
# Network-wide rollup
curl https://api.peppolstatus.com/v1/network
# Newest Belgian participants, 5 per page
curl "https://api.peppolstatus.com/v1/participants?country=BE&limit=5"
# One participant's current state (scheme::value)
curl "https://api.peppolstatus.com/v1/participants/0208::0762747721"Documentation & specs
PeppolStatus developer resources
- API reference (Scalar, interactive) Browse and try every endpoint in an interactive reference. https://api.peppolstatus.com/docs
- OpenAPI 3.1 specification Machine-readable spec for code generation and tooling. https://api.peppolstatus.com/openapi.json
- API quickstart (Markdown) Base URL, endpoint families, conventions, and curl examples. https://peppolstatus.com/api.md
- Authentication guide (auth.md) How auth works: none required, optional API keys, no OAuth. https://peppolstatus.com/auth.md
- llms.txt A structured index of these resources for LLMs and agents. https://peppolstatus.com/llms.txt
- API catalog (RFC 9727) Machine-discoverable catalog of the API and its spec. https://peppolstatus.com/.well-known/api-catalog
- Agent skill (SKILL.md) A drop-in skill describing how to use the PeppolStatus API. https://peppolstatus.com/.well-known/agent-skills/peppolstatus-api/SKILL.md
- Health endpoint Liveness check returning
{"status":"ok"}. https://api.peppolstatus.com/health
Endpoint families
What you can query
Everything lives under /v1. All responses are JSON;
errors use RFC 9457 application/problem+json.
- network
- At-a-glance rollup: host verdict counts, open incidents, anomalies in the last 24h.
- hosts
- Monitored SMP/AP hosts: current verdict, latency, 24h uptime, per-host incidents and uptime aggregates.
- incidents
- Global incident feed, open and closed, newest-first.
- participants (+events/history)
- Peppol participants: filterable list, current state, change events, temporal history.
- stats/participants
- Global facet counts (country, scheme, SMP, AP, registered share) plus an estimated total.
- providers
- OpenPeppol member registry and curated provider detail.
- aps (+churn)
- Access-point directory with rosters; churn — joiners, movers in/out, leavers — per AP.
- seats
- Certificate seats — the machine identity of a provider.
- events
- Global typed change-event feed (registrations, migrations, cert rotations) with embedded anomalies.
- anomalies
- Deterministic detector anomalies, graded notice or warning.
- sml
- SML/SMK zone canary status and DNAME cutover state.
For agents & LLMs
Built to be read by machines
Every HTML page on peppolstatus.com also serves a
Markdown variant — request it with
Accept: text/markdown. All HTML responses carry RFC 8288
Link headers pointing at the API catalog and the OpenAPI
specification, so agents can discover the machine interface from any
page.
Support
Questions about the API
Email hello@peppolstatus.com. PeppolStatus is built by the engineers at e‑invoice.be.