Try the REST API
Choose an endpoint, adjust its parameters, and send a request. Start with Read explorer status to check the service and its data mode.
Requests go directly from your browser to this address.
Service
Search
Blocks
Transactions
Validators
Assets
Accounts
Migrations
Routes
Response
Send a request to see the response.
HTTP status, response body, and timing appear here.Response schema
Schema references resolve in the OpenAPI definition.
{
"200": {
"description": "Live relay response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusResponse"
}
}
}
},
"400": {
"description": "Invalid query or identifier.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Record or resource unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"405": {
"description": "Only read requests are supported.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Read budget exhausted. Respect Retry-After.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Relay unavailable, network mismatch or request timeout.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Connect an API
Section titled “Connect an API”Hosted docs use the configured public explorer API. When running these docs on localhost, the default is the local explorer API; start that service before sending a request. Use local selects it explicitly. The explorer reads the live public lab devnet. Responses report meta.mode: "live" and meta.source: "node". It reflects one relay’s view, not a source of truth for exchanges or custody. The network has no value and may be reset. The sample badge appears only when a selected API explicitly reports mode: "demo".
To query your own service, change API base URL. Choose Custom GET request for a path from that service’s API reference. The server must allow this documentation site’s origin through CORS.
Heartwood Core serves the reference’s block, node, peer, transaction and wallet routes under /api. The public lab devnet’s reference API node answers read-only requests at http://2.31.30.179:6003/api, for example /api/blocks/last. It allows about 100 requests per minute for each address and uses plain HTTP, so call it with cURL or from your own backend: a browser page served over HTTPS, including this playground, cannot call it. Your own relay serves the same routes on its local API port; see Run a devnet node.