starknet_syncing

Returns an object about the sync status, or false if the node is not synching

Parameters

This method does not accept parameters.

Request

{
  "jsonrpc": "2.0",
  "method": "starknet_syncing",
  "params": [],
  "id": 1
}

Returns

The status of the node, if it is currently synchronizing state. FALSE otherwise

Sync status object or false if not syncing

Examples

cURL

curl -X POST https://api-starknet-mainnet.n.dwellir.com/YOUR_API_KEY \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "method": "starknet_syncing",
    "params": [],
    "id": 1
  }'

JavaScript

import { RpcProvider } from 'starknet';

const provider = new RpcProvider({
  nodeUrl: 'https://api-starknet-mainnet.n.dwellir.com/YOUR_API_KEY',
});

const payload = {
  method: 'starknet_syncing',
  params: []
};

const result = await provider.fetchEndpoint(payload.method, payload.params);
console.log(result);