sync_info - Monero

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

This method returns synchronization status for the node, including peers it is syncing from and per-peer progress. Useful for diagnosing sync stalls.

Parameters

None

Request Example

curl --location --request POST 'https://go.getblock.io/<ACCESS-TOKEN>/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "sync_info",
    "params": {},
    "id": "getblock.io"
}'

import requests
import json

url = "https://go.getblock.io/<ACCESS-TOKEN>/"

payload = json.dumps({
    "jsonrpc": "2.0",
    "method": "sync_info",
    "params": {},
    "id": "getblock.io"
})

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers, data=payload)
print(response.text)

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let payload = json!({
        "jsonrpc": "2.0",
        "method": "sync_info",
        "params": {},
        "id": "getblock.io"
});

    let response = client
        .post("https://go.getblock.io/<ACCESS-TOKEN>/")
        .header("Content-Type", "application/json")
        .json(&payload)
        .send()
        .await?;

    let result: serde_json::Value = response.json().await?;
    println!("{:#?}", result);

    Ok(())
}

Response Example

{
    "id": "getblock.io",
    "jsonrpc": "2.0",
    "result": {
        "credits": 0,
        "height": 3194582,
        "next_needed_pruning_seed": 0,
        "overview": "[]",
        "peers": [
            {
                "info": {
                    "address": "192.0.2.1:18080",
                    "current_download": 0,
                    "current_upload": 0,
                    "height": 3194582,
                    "incoming": false,
                    "ip": 16777343,
                    "live_time": 12345,
                    "peer_id": "abcdef0123456789",
                    "port": "18080",
                    "pruning_seed": 0,
                    "recv_count": 1000,
                    "recv_idle_time": 0,
                    "send_count": 1000,
                    "send_idle_time": 0,
                    "state": "normal",
                    "support_flags": 1
                }
            }
        ],
        "status": "OK",
        "target_height": 0,
        "top_hash": "",
        "untrusted": false
    }
}

Response Parameters

Field

Type

Description

result.height

unsigned int

Current node height

result.target_height

unsigned int

Target sync height (0 when fully synced)

result.peers

array

List of peers and their connection state

result.peers[].info.address

string

Peer address

result.peers[].info.height

unsigned int

Peer's reported height

result.peers[].info.state

string

Connection state with this peer

Use Cases

Diagnosing sync issues
Per-peer download/upload monitoring
Detecting eclipse-attack scenarios in self-hosted setups

Error Handling

Status Code

Error Message

Cause

404

Not Found

Missing or invalid <ACCESS-TOKEN>

429

Too Many Requests

Rate limit exceeded for your plan

SDK Integration

import monerojs from 'monero-javascript';

const daemon = await monerojs.connectToDaemonRpc('https://go.getblock.io/<ACCESS-TOKEN>/');

// Most methods are exposed directly on the daemon client. For raw access:
const result = await daemon.getDaemonConnection().sendJsonRequest('sync_info', {});
console.log(result);

from monero.backends.jsonrpc import JSONRPCDaemon
from monero.daemon import Daemon

backend = JSONRPCDaemon(host='go.getblock.io', port=443, path='/<ACCESS-TOKEN>/', protocol='https')
daemon = Daemon(backend)

# For methods covered by the typed API, use the daemon attribute directly.
# For raw RPC access:
result = backend.raw_request('sync_info', {})
print(result)

Previoussubmit_block - Monero NextMoonbeam (GLMR)

Last updated 12 days ago

Was this helpful?