Skip to main content

eth_syncing

Method​

  • JSON-RPC method name: eth_syncing
  • JSON-RPC version: 2.0

Parameters​

This method does not accept any parameters.

Result​

  • Name: Syncing status
  • Type: oneOf

Result schema​

{
  "title": "Syncing status",
  "oneOf": [
    {
      "title": "Syncing progress",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "startingBlock": {
          "title": "Starting block",
          "type": "string",
          "pattern": "^0x([1-9a-f]+[0-9a-f]*|0)$"
        },
        "currentBlock": {
          "title": "Current block",
          "type": "string",
          "pattern": "^0x([1-9a-f]+[0-9a-f]*|0)$"
        },
        "highestBlock": {
          "title": "Highest block",
          "type": "string",
          "pattern": "^0x([1-9a-f]+[0-9a-f]*|0)$"
        }
      }
    },
    {
      "title": "Not syncing",
      "description": "Should always return false if not syncing.",
      "type": "boolean"
    }
  ]
}

Errors​

This method may return JSON-RPC standard errors (e.g. -32600, -32601, -32602, -32603) as well as application-specific errors.

TODO: Document method-specific error codes and conditions.

Named Parameters
{
  "jsonrpc": "2.0",
  "method": "eth_syncing",
  "params": {},
  "id": 1
}
Successful Response
{
  "jsonrpc": "2.0",
  "result": "example",
  "id": 1
}