Base URL
By default, the API server runs on:--api-port flag when starting the node.
Authentication
The SSV Node API does not require authentication. The API is intended to be accessed locally or within a trusted network environment. Security Note: Do not expose the API to the public internet without proper network security measures.API Endpoints
The API is organized into three main groups:Node Endpoints
GET /v1/node/health- Health check and connectivity statusGET /v1/node/identity- Node identity and network informationGET /v1/node/peers- Connected peers informationGET /v1/node/topics- P2P topics and subscriptions
Validator Endpoints
GET /v1/validators- List validators managed by the node
Exporter Endpoints
The exporter API provides detailed duty execution traces for debugging and monitoring:GET/POST /v1/exporter/decideds- Retrieve decided duty participantsGET/POST /v1/exporter/traces/validator- Validator duty traces (requires full exporter)GET/POST /v1/exporter/traces/committee- Committee duty traces (requires full exporter)
Full exporter endpoints require starting the node with the
--exporter flag enabled.Request Format
Most endpoints support query parameters for filtering. The exporter endpoints additionally support POST requests with JSON bodies for complex queries.Query Parameters
JSON Body (Exporter endpoints)
Response Format
All successful responses return JSON with200 OK status. Error responses follow a standard format:
Error Codes
| Status Code | Description |
|---|---|
200 | Success |
400 | Bad Request - Invalid parameters |
404 | Not Found - Resource doesn’t exist |
429 | Too Many Requests - Rate limit exceeded |
500 | Internal Server Error |
Rate Limiting
The API implements throttling based on CPU cores:429 Too Many Requests responses.
Response Headers
All responses include:X-SSV-Node-Version- The running SSV node versionContent-Type: application/json
Timeouts
- Read timeout: 12 seconds
- Write timeout: 12 seconds
- Read header timeout: 10 seconds
Next Steps
Node Endpoints
Monitor node health and connectivity
Validator Endpoints
Query validator information
Exporter API
Access duty execution traces
