sidechain_getStatus - Midnight

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

This method returns the sidechain's operational status, including the current epoch, slot, and Cardano main chain sync status.

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": "sidechain_getStatus",
    "params": [],
    "id": "getblock.io"
}'

import requests
import json

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

payload = json.dumps({
    "jsonrpc": "2.0",
    "method": "sidechain_getStatus",
    "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": "sidechain_getStatus",
        "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

{
    "jsonrpc": "2.0",
    "id": "getblock.io",
    "result": {
        "sidechain": {
            "epoch": 42,
            "slot": 12345,
            "nextEpochTimestamp": 1737900000
        },
        "mainchain": {
            "epoch": 100,
            "slot": 67890,
            "nextEpochTimestamp": 1737900000
        }
    }
}

Response Parameters

Field

Type

Description

result.sidechain.epoch

integer

Current Midnight epoch

result.sidechain.slot

integer

Current Midnight slot within the epoch

result.sidechain.nextEpochTimestamp

integer

Unix timestamp at which the next sidechain epoch begins

result.mainchain.epoch

integer

Current Cardano (mainchain) epoch

result.mainchain.slot

integer

Current Cardano slot within the epoch

Use Cases

Dashboards correlating Midnight and Cardano epoch/slot progression
Scheduling tasks aligned with epoch boundaries
Validator and infrastructure monitoring

Error Handling

Status Code

Error Message

Cause

403

Forbidden

Missing or invalid <ACCESS-TOKEN>

-32602

Invalid params

Request parameters are missing or malformed

429

Too Many Requests

Rate limit exceeded for your plan

SDK Integration

import { ApiPromise, WsProvider } from '@polkadot/api';

const wsProvider = new WsProvider('wss://go.getblock.io/<ACCESS-TOKEN>/');
const api = await ApiPromise.create({ provider: wsProvider });

// Call via the typed API:
const result = await api.rpc.sidechain.getStatus();
console.log(result.toJSON());

// Or call the raw JSON-RPC method:
const raw = await api.rpc.rpc.methods();
// const raw = await (api as any)._rpcCore.provider.send('sidechain_getStatus', []);

from substrateinterface import SubstrateInterface

substrate = SubstrateInterface(url='wss://go.getblock.io/<ACCESS-TOKEN>/')

# Generic RPC call:
result = substrate.rpc_request('sidechain_getStatus', [])
print(result)

Previousstate_getStorageHash - Midnight Nextstate_getkeyspagedat - Midnight

Last updated 17 days ago

Was this helpful?