For the complete documentation index, see llms.txt. This page is also available as Markdown.

eth_syncing - Scroll

Example code for the eth_syncing JSON-RPC method. Complete guide on how to use eth_syncing JSON-RPC in GetBlock Web3 documentation.

This method returns an object describing sync progress while the node is catching up, or false once it is fully synced. It is used to confirm an endpoint is at the chain tip before relying on its data.

Parameters

This method does not require any parameters. Send the request with an empty params array.

Request

curl --location --request POST 'https://shared.eu-central-1.getblock.io/<ACCESS-TOKEN>/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "eth_syncing",
    "params": [],
    "id": "getblock.io"
}'
example.js
const axios = require('axios');

const response = await axios.post('https://shared.eu-central-1.getblock.io/<ACCESS-TOKEN>/', {
    jsonrpc: '2.0',
    method: 'eth_syncing',
    params: [],
    id: 'getblock.io'
}, {
    headers: { 'Content-Type': 'application/json' }
});

console.log(response.data.result);
example.py
import requests

response = requests.post(
    'https://shared.eu-central-1.getblock.io/<ACCESS-TOKEN>/',
    headers={'Content-Type': 'application/json'},
    json={
        'jsonrpc': '2.0',
        'method': 'eth_syncing',
        'params': [],
        'id': 'getblock.io'
    }
)

print(response.json())

Response

{
    "jsonrpc": "2.0",
    "id": "getblock.io",
    "result": false
}

Response Parameters

Parameter
Type
Description

jsonrpc

string

JSON-RPC protocol version ("2.0")

id

string

Request identifier matching the request

result

boolean | object

false when synced, or an object with startingBlock, currentBlock, and highestBlock

Use Cases

  • Readiness Gates: Hold traffic until an endpoint reports it is fully synced

  • Data Trust: Avoid serving stale reads from a node that is still catching up

  • Monitoring: Alert when a node falls behind and re-enters syncing state

  • Failover Logic: Route away from nodes reporting an incomplete sync

Error Handling

Error Code
Message
Description

-32603

Internal error

The node failed to report sync status

-32601

Method not found

The eth module is disabled on the client build

Web3 Integration

Last updated

Was this helpful?