Skip to content
IceRootDocs
1 min read

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.

Explorer API · sample dataOpenAPI JSON

Requests go directly from your browser to this address.

GET

Read explorer status

/api/v1/status

Returns fixture range, round and collection counts. readOnly is true and chainConnected is false. updatedAt is null; the API supplies no chain freshness timestamp. Query parameters are ignored.

Request URLhttps://explorer-api-production-d9b8.up.railway.app/api/v1/status
cURL command
curl --request GET \
  --header 'Accept: application/json' \
  'https://explorer-api-production-d9b8.up.railway.app/api/v1/status'

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": "Successful response containing bundled demo data.",
    "headers": {
      "Cache-Control": {
        "schema": {
          "type": "string",
          "const": "no-store"
        },
        "description": "Responses are not cached."
      },
      "X-Content-Type-Options": {
        "schema": {
          "type": "string",
          "const": "nosniff"
        }
      }
    },
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/StatusResponse"
        },
        "example": {
          "data": {
            "chainConnected": false,
            "counts": {
              "accounts": 71,
              "assets": 5,
              "blocks": 15,
              "migrations": 6,
              "routes": 3,
              "transactions": 16,
              "validators": 62
            },
            "firstHeight": 20406,
            "latestHeight": 20420,
            "readOnly": true,
            "round": 386
          },
          "meta": {
            "mode": "demo",
            "source": "bundled-fixtures",
            "updatedAt": null
          }
        }
      }
    }
  },
  "408": {
    "description": "Request timed out after 10 seconds. This middleware response is not guaranteed to have a JSON body."
  }
}

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 currently returns sample ledger data and identifies every response as 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’s node REST server is not available in the current Core release. The custom option is ready for your node when its endpoint is available.