⚠️

This documentation is for versions 0.1 – 0.6. You may want to view the latest version.

Status

To check the indexing status of your app, use the /status endpoint or the _meta field in the GraphQL API.

Usage

Use the indexing status to quickly confirm that Ponder is working as expected. You can also poll the status to confirm that a specific block number has been ingested by Ponder before refetching a query client-side (for example, in a form submit handler).

HTTP

Request
curl http://localhost:42069/status
Response
{
  "mainnet": {
    "ready": true,
    "block": {
      "number": 20293450,
      "timestamp": 1720823759
    }
  },
  "base": {
    "ready": true,
    "block": {
      "number": 17017206,
      "timestamp": 1720823759
    }
  }
}

GraphQL

Query
query {
  _meta {
    status
  }
}
Result
{
  "_meta": {
    "status": {
      "mainnet": {
        "ready": true,
        "block": {
          "number": 20293464,
          "timestamp": 1720823939
        }
      },
      "base": {
        "ready": false,
        "block": null
      }
    }
  }
}

API

The response object contains a property for each network in your app with the following fields.

fieldtypedescription
readybooleantrue if historical indexing is complete.
block{ number: number; timestamp: number; } | nullThe most recently indexed block, or null if historical indexing is not complete.
MetricsTelemetry