ledger - XRPL

Example code for the ledger JSON RPC method. Complete guide to using ledger JSON-RPC in the GetBlock Web3 documentation.

The method retrieves information about the public ledger.

Parameters

Parameter	Type	Required	Description
ledger_hash	string	No	Ledger hash
ledger_index	string/number	No	Ledger index or shortcut
full	boolean	No	Include full ledger
accounts	boolean	No	Include accounts
transactions	boolean	No	Include transactions
expand	boolean	No	Expand transaction details
owner_funds	boolean	No	Include owner_funds
binary	boolean	No	Return binary format
queue	boolean	No	Include queued transactions

Request Example

cURL

curl --location --request POST 'https://xrp.getblock.io/mainnet/' \
--header 'x-api-key: YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "ledger",
    "params": [{
        "ledger_index": "validated",
        "transactions": true
    }],
    "id": "getblock.io"
}'

JavaScript (Axios)

Python

Rust

Response Example

{
    "result": {
        "ledger": {
            "account_hash": "834D8EAB83C4C4BA14454766F8608B1E325609750007CD2FFB607A713AF757AA",
            "close_flags": 0,
            "close_time": 823542290,
            "close_time_human": "2026-Feb-04 17:44:50.000000000 UTC",
            "close_time_iso": "2026-02-04T17:44:50Z",
            "close_time_resolution": 10,
            "closed": true,
            "ledger_hash": "DD8041D63ECABA98A225F5321A08633AB8F1DBFD257EC9430C4D94C62FF9337B",
            "ledger_index": "102024817",
            "parent_close_time": 823542282,
            "parent_hash": "9E9BB4B99342C5FA67FD7A6353693C28B2D0A8BBE8117BA892FA74D194BB07A8",
            "total_coins": "99985715933381560",
            "transaction_hash": "E492A3FDF0DF6C4A6053C0B14DE2FA2E4B96A5C20B02AA1EF3C4FB55AB8AA97F",
            "transactions": [
                "006FA228078A25D9F57F72C32BDB34255222AF36C258C9BDC109F939E9FBF1D3",
                "034E2607D60E42BE0BCE1640EB091A3F51CFB63A1AD3B8CC1DCE5438DA3D2795",
                "05C272A08813EBE3F3A7F9AE9455B0522F33326A3B6E7F9A568C7FE849175FEB",
                "092A6422472E308D4D3704B46A01F557715DE5C1915C3C882D5C7C6BE14E9835",
                "0A1ACD29ACA079D03F3E973F792617E9E141A86A25984257E7D09A1AFC779D96",
                "0A729DF5E811DA2E95EF2872F0C45A2324D3AE71E3521990C4DA298E530CD361",
                "0DA1804789BCD091C5831A15F04BF83CD255C71DEA896606685263D9D84FCCAB",
                "0F8949E32E16366EC91F47586AD41D05668CE773AFAEFF4EEEB316B215766D30",
                "1269F552199A10F8036A46F127F37DE068E4EAEFA138390741F6361E03849811",
                "13004A523B647F89C7776163757C19017D3CFDB7BB98E720AAC982F821EAE476",
                "1A46168DA1A7E1BF5FE0F53E1AE5E027A887FCFD5130C0DE05C0FE8A833C93C1",
                "1BF55D0528BCE87B28B1AE44159B9084B425E40C09467B3B8A5055D644357943",
                "1C4CCF1F3097BE1DC52336005AB000610005643165EB9A3AD5D6FF9E7020F8D8",
                "2086675FF732C0CE1363E271BF0769DCD9A8D30B10BC1B7142362F6E188B625F",
                "235A70239339E7626F1BFBA47D69DB10F8FAAE62522141569CBA79CABFB6A82E",
                "23A33C312DF224746F52BA2592F74054ED58189ED618219955DD4B128E976C97",
                "24451CB1F6CD49AF067BFAAC23E35B3CC4A13D2322890CA09D1B4E0D9DF0C6B7",
                "28E960395FE39AD9364B36FF11F0F1A345560C34B4DB29A6733B9069D96D32E7",
                "2FB777B455CE81C4175A8E5AC888831B6433693C932C84C7447E4CFA51B8DD8C",
                "3486BA7EF3B143CE552E6839ABAA0C5E52B5CFA4EF87DEE5E09E741B0ABECC19",
                "39EA17F92DA700CCE55F542EF715C4410AC4AF481E8F6EDF0C2B30866012A3A8",
                "3A92D61E67780A5679707810426C2B27D4018509DBCD0E04B99E05876EB76C50",
                "3B29B2A33D19411B3F5217AC219FEC7C4B25E17C3586E5932259100B04106971",
                "3D4AAF5789BA5D99F4364E119002BE44F64CE91022D23D6AFAE33051293FBD87",
                "3F4D55E628F75B976CC1BFF2380E0DEE8C51E86BD3A6BAF59C8EEFB6904B216C",
                "42BAC105FD6998CC7FE293BB1761775B0245EDAA9BA31C6BA3D7B4AE1F239885",
                "456602676B4289B74E05ADB0F5045A27D3A36CFB199876CED2457C50338BC5DC",
                "47FE04EA9F645979C86E1C39B04096844A03FDA09265A196C5F9BCF9677E236A",
                "4A265D7BCE206B8868448A171894BAF078B931128CF24E604482C7E87E7F0FB6",
                "4BF5724CC904007399A8D694D462DAAEE1532B4AC3E778738D28ECCC94A7E4EF",
                "4DF7143E41BC8588ACBAFD2D3A02E9DF1D96F0924AE4124AA97464B731F04AD7",
                "4EB5A74ACCED79D8DA20D004D2F5001E7AB7D8AC6CD8B54587F501C4FB06DB50",
                "4F6441D977B5AB55A80DA48B19DD9F22BDE09EBE0AA1875EC255BED380215606",
                "510B0528010B16A3065BB62FE866154BFD5A19302AF4D80E481F0AC59D77B889",
                "51C4F5CC6FC5449C4F5B77DEC1F436E3124DE166A1F203A766A4DEB3B29974FE",
                "5459C6DD374DD9C6275D982C16A093178B33DF09297DEAC3D3093822C6A1AF6E",
                "5501A57D81BD334DEF5AB7324C416FF9ED0ACF03C57110DC1788CF63EEBBA161",
                "55E34DA662C54E3C703394A615A29F22267B0DCB61D3FFEE5276379EA41B9756",
                "61B6C38F9451ACB514D3D795738136574A2B6805CB0730D57054EEBA97241981",
                "62EEC45B614AD7D919E4127C5B1B5AB490880B0E5EE12FCA39AC7E886E94D588",
                "65218C8E648AA09E23CBC5A08132AA1A256F38E4179BA296D07D554FA4CE22EA",
                "6567FEA2AF76580DA9C82DD49A2512934923594A1F7B4689AE8631C69DC65CE8",
                "66A82B6C082A1BFA397FDDE5B6D0D8E8891A7F559B67E881B0B064A3D5D1EB54",
                "67442F19517DCDB07D327F011D2F486B6335B7FFCD94F9CE49A72F297222B2CF",
                "6A6F95A30027884F2DC267357E66A9FEC75078F0497000EE7168E5559386F0D7",
                "6AD1252E4A8030442FBE1B1D56A5B0A44434045067F8E7710F699294EC1E88FD",
                "6DCCE86CFF84154845F514B5AB013B9641885126FE29C7B3A19C77789FABF04C",
                "6E5591227FE733ACB4B7B2C7CE8B9A2B921F2247058E089B59CE3AC3187DD19D",
                "6F6343E8C5675C0A85709E6AACF55AE4FE107E61BD6AE0D562A6FD66ACCAF9E1",
                "700AF1FDA34E996E189065358909DE42CAD6FB09017B08A64C6A7C523D671347",
                "701067301E43667780434D1B52D4D07F39ECD9E8FAD9AB0F54FFF74FDECE8981",
                "7049CD0AE2CBFD20956A47E0FD059ED557B0E29A3677ADC6308CC09D1AA8D4DC",
                "70D33C4EDF659FAC5625A1DC9A18A052187064EA4C8E700F4F80CAF8013DD761",
                "72B2837A4A93C6D7B18311B85C01F11343ABAF2D0330699239537FE5427802FC",
                "72FA915C1449F99A6F483A0C798809B8EC18DB08969AB297983650702F1D0C70",
                "735904A022F0A3CAFDE1A9A8E40CE01B553CA07A8F88EAD16B0EE8C0204A09FF",
                "76879D66F4ED0CC96829816A8B18738BB536A66024D166BCBACF0BA804C1717D",
                "79A08911A0E845333B354A3D36A7ED09AE7D050DB436C06C9F264F9A395AAB7A",
                "79FA56B30123281D8180627D17EF161B1FCFB182B75D2E4DE7A0EBC6BE3371D8",
                "7C668AD48FB368DB92242BE748E8EA06011823988CE3B972BC7196886E0F600A",
                "7D2C63980DB02E6AA3FA474FABC2389FE96284AB9840A920442BB6298421EE91",
                "7D9C314A0541EB5974DA6068AC2E882F2C99452B022E9FB33F85D9257C28F8D7",
                "7F08F17BDB21C8CE11D1FE809E91ED10C4C3FFB64B9977D460C30C96FBDF7ACB",
                "837DE833A2FD44FD6448E43429309A008F6D134869CE6E587E719609F1FFA8C4",
                "837FDD6A98A7E9D6AF0597D312281CEE08394630790170C5F99276D223D2D9F6",
                "855010A959E74C6A5FEC48CED6E6F46378397AF60FC02AC710B462B106B383AE",
                "8672443AD456E58811864153E7C819F08ED325EDA2F77C99A1F59BE543C75139",
                "86B54CE342704CA8676C84D2F67E7023F0D0CE32AE5487EB2B45E63EE3904093",
                "890CD4A781A263A8B8711E9B6279F67A1EB575082FC801A471139C8A28261313",
                "8BA86E40EF52ADEAF2E545403380C6248A86CBACBAAB79692C5C05C2B7C6C277",
                "8CEB9CF1D793E197EAA692BA5EABDCD9DDCDFC2752AF14CE4763EA1E8DA48943",
                "8CEC0ABBDEA691F509AFC51CAFB8E9D7F59547566A957FAFE5470EED0288C8B4",
                "8D6C43E63F8C6FA80A1FC576B2F4F251E77DFBFCB2C9BD7560E0A93CA4BE5ECC",
                "8E89E35CEDA3721614B3CE809F5FC5CFCDD056BF015698A0944788C9ABD576C5",
                "9030DEC438AB9E8385CDA06225EA674A0BBF5B58DD0FA05F36EE1DDCD10C121A",
                "91CC48085D66DD08208DC6AE1D3D0C3D03DD1513E44AF57D6D6CCFC9B3B429A5",
                "9A9636EF4B31B355542E5EDA79C512CAEFA695131D4406A97C343509905CA0C7",
                "9E0D3D19666A70ADEFC5660209D7E53B1B0DA04ED353E0C4F33235BB494C2623",
                "A357F6FEF60B0D5B1B868B5A48CA57E51D1443B2BF5E1B2EC10D2F22B6AF6B38",
                "A35B95F29C9E7569E534739DBD237D4CF80E005461F7BC841F7AB475347B1FAD",
                "A386926149BCC57C318EF01B3C2B9ED0DCA270CDF5D3994F3381979096F2A17E",
                "A94A879B67A13DE0BD89346F99F7C186D715B54B7A77C9B525CC5632C1599C5C",
                "AA97C89849F0CD56C4511E8CE373BA5923D5D9B79C14C7BF76C2B629C298D817",
                "ABF32087B7C2A45A0A8F1A5F63285B4F99383D42218C226946B9172B12E63B68",
                "AC968565C33327C443003829C7732CD454DB083897DFD803946FDE8B46FCDC36",
                "AF9884DA45F884B3D5E2AB3ECF0A545DDDC07638C2DBB1574053D98126CE3C66",
                "B0B1F0F405E6728F7CA86B8EE0EB5CC5CBD89FF81AD78FCE641FE5937606B252",
                "B12CE2A5AA65D12A95DFE6D586009D7A53AA52DA5FCC2FBFE404225C74BA5D74",
                "B2C34CC831CAAB30084973ECA45BCC554881482CC6EC0CD4DB4F6FE8C79C935D",
                "B3279B744DCF16A93B483355151BEB29A01B24CBE0A1ACCB529047E2926FC030",
                "B39F090FE7B1769FE21F013A28CECAFAF7CBC7BB9239C73F5923CDA9FEC7042A",
                "B43BAEE0AD298B43DD6686B1288A8582AF4518F2383FE8366D54EF4C5329D974",
                "B5CEBBAE83DBFB62522EC799BBF5F3B7CED8576685D131E49A717BC6B47A6EEB",
                "B6A0DC45D099C354BBCD36007B7A2B235D86F339BFD2880E6AD8F6FBEF051E6E",
                "B801D43D2488DCAB5AB08A69B3E291848F0387284A122080E85F8EEEAD5BA62E",
                "B8B1EDE25BD515C9E3803CB7F14AE8D59105E56DBDA0CB975BBA5BD7D126A3D8",
                "BADB7EBBCC6A1E169EA1727CAAC8DB8D2BE660B21CEF6BB282EFA2941D1A9779",
                "BB1F74E2C6F33E75A183F3FDF8507FFF1DA5669AF229A3E534B0BD79BE041EA0",
                "BF2A801D80489622F4DEAFBF074408809417D72962F0B090C4635CD85F07A376",
                "C2E704BF203E1AF721FC46DA71F3D173C3D3DDFA783EF9C663AF952CEB821143",
                "C52007351EF3AF67617C015A4EA402E5D8900531F5D4FE23ED2FC281842B638F",
                "C74DA855288369ACA435B4114F3427180150E1A4FBDAF23D51795F756E74CEE4",
                "CA79FAB2938D8246A78A2A4264864443D80730174009EBBC9E4C0A7708E1D780",
                "CF0C1F8F309DB3ED4746294CF67291EFEC617B23055922F7D24AAE023664C51C",
                "CFE67591B7DEF13B5DCE8A9CEBFE1B04DAB12216AC885D55A91E0092F8D83F12",
                "D0F26B9B9ED63A6A3D6AB97E120707BC9BBC9ED8BC16138C07B8B19E65CC478C",
                "D38750A91C5F28BAEBCA5A768861201D1993DA17C724CF9E653771960E68007E",
                "DA3FBEFD38A1648EF94B3CE1D4E85047EAA41DD1172846D41B8F7954C1F16EC7",
                "DA8A8B7AE5B86C9CD52C60D3F44456B815A1D7913F54A36F3E191D8AB540F364",
                "DC6679D188BE5D72AA1F34F83CC0FB5A737FBB13EEAD7579ECAE20EE4CD683FB",
                "DCCC24A9EB28C5C7CDD4A9D7A279FEA1246D9943FA852FE42EF21CA5E042F51B",
                "DD8409A8D48814AA4D17C8F5BDB2E1B64BA46F5AD2477B23802AE1CB572C6F84",
                "E0E89B867B511C122D08280A34F21DB1A43F1F6D91F8A0DB6B3D813819E0667D",
                "E0F81F1F8863C1D3B2A452E1E190CC9D03A23247EF23639909CFF10F732A3117",
                "E1C3296E642ED1DA525C6FF580EF42FD9204DAC44C24A5CD61FB7B48ADA544FD",
                "E6DF126B390B924400F05AAF2D5677F293F2DBFAEB0AD00331F4E4663D08EB4A",
                "E91E649598B74CD13FAC8D0CB65405A401B0EAFEC228B023DB00239AC9D5652B",
                "E96361DE940468FA51CFD55E3C32ED81F494D68C6BCB2D632AF02FA14B877495",
                "E9F2F57CF27CED1AEF8485083C551378B6FAF523F26F9F37AD46581DD76588F1",
                "EB3B98A47B135EB20C7919FFD3EBBD989E7FC00AB50FEF45006195351101D98D",
                "EB49EED0C02AEC91B185B32E5A1AF017DFE1B12361FDE2A04D652B303CE74AFD",
                "EE351BFB8A7E03374421617C32072F560BA92B5442F691B3711F737D417E9C14",
                "EE74805932311564BC1F29EBBD10D5046E767B8D9A2689527F6400F3E8C4CB62",
                "EEB83D75B05761C094E78A277B33F46A7127CAE28A8F88F3B3C0724E38A2B7E7",
                "F16A1008A0CEDDA05D1A3D6B5471174E2C9FCD838606E749E45863A336AD6193",
                "F3CBDC01CC2E29E2979BD4173E0D1F888A80756A13E8068B3A07253F32A97B5D",
                "F63C62E4CC5C7133A160FBF29004D2C2C7DCFB0A72F98D50F1A9616B11B75F92",
                "F7C797387402C4EC03B6AE9F9D7E03D4C81DF7F06D38BEF77CF6E182CE148278",
                "FE5BE6CFE02769DFF9D4E82E533F7E91BFFDBDD73E632E9A3CC3C189BEDBD533"
            ]
        },
        "ledger_hash": "DD8041D63ECABA98A225F5321A08633AB8F1DBFD257EC9430C4D94C62FF9337B",
        "ledger_index": 102024817,
        "status": "success",
        "validated": true
    }
}

Response Parameters

Parameter	Type	Description
ledger_hash	string	Ledger identifier
ledger_index	number	Ledger sequence
close_time	number	Close time
total_coins	string	Total XRP

Use Cases

• Get ledger information

• Retrieve transactions in ledger

• Monitor ledger state

Error Handling

Error Code	Description
lgrNotFound	Ledger not found
invalidParams	Invalid parameters

SDK Integration

xrpl.js

xrpl.js

const xrpl = require('xrpl');

async function getLedger() {
    const client = new xrpl.Client('wss://xrplcluster.com');
    await client.connect();
    
    const response = await client.request({
        command: 'ledger',
        ledger_index: 'validated'
    });
    
    console.log('Ledger:', response.result.ledger_index);
    await client.disconnect();
}

getLedger();

xrpl-py (Python)