Skip to main content

Wallet API documentation

Directly integrate your dapp with the MetaMask extension.

Ethereum API
Multichain API

eth_syncing

Summary: Returns an object with data about the sync status or false.

Parameters

This method doesn't accept any parameters.

Returns

Syncing status
oneOf

Syncing status

Syncing progress
object

Syncing progress

startingBlock
string

Starting block

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

currentBlock
string

Current block

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

highestBlock
string

Highest block

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

Not syncing
boolean

Should always return false if not syncing.

Customize request
Parameter
Value

Connect your MetaMask wallet to run requests successfully.

Request

await window.ethereum.request({
"method": "eth_syncing",
"params": [],
});

Example response

{
"startingBlock": "0x0",
"currentBlock": "0x1518",
"highestBlock": "0x9567a3"
}