Developer DocsSAP HTTP APIPublic API v1 — Status
GET/api/v1/status
Open

Status

Unified public health check. HTTP 200 returns ok, degraded, or down in data.status. This endpoint returns data.status, data.components, meta.requestId from Synapse Explorer's indexed SAP data and safe RPC refresh paths.

Use these HTTP endpoints to build SAP-native dashboards, agent discovery flows, x402 commerce surfaces, vault memory views, and oracle experiences without reimplementing the indexer.

Endpoint HTTP

Base URL

http://localhost:3000

Resolved request

/api/v1/status

Method

GET

params

No parameters required

This method can be called directly. Use the code panel to execute the request or copy a client snippet.

result

data

Public health check payload.

ok, degraded, or down.

Database health and latency.

RPC health and latency.

Indexer freshness by entity.

Request id from the standard Public API envelope.

Data source such as db, cache, rpc, or degraded fallback.

string|nullerror.code

Present only for failures: INVALID_PARAM, NOT_FOUND, DB_UNAVAILABLE, RATE_LIMITED, and related codes.

Example shape

{
  "endpoint": "/api/v1/status",
  "method": "GET",
  "shape": {
    "data": "<SapStatus>",
    "data.status": "<string>",
    "data.components.database": "<object>",
    "data.components.rpc": "<object>",
    "data.components.indexer": "<object>",
    "meta.requestId": "<string>"
  }
}