From 9e7b6b3b8de2ae21a114359178e6e8e524806665 Mon Sep 17 00:00:00 2001 From: Aditya Vyas Date: Fri, 13 Dec 2024 15:25:20 +0530 Subject: [PATCH] Add getLedgers documentation (#1128) Add getLedgers documentation --- .../rpc/api-reference/methods/getLedgers.mdx | 11 ++ .../GetLedgersPairs.json | 13 ++ openrpc/src/stellar-rpc/examples/Ledgers.json | 38 +++++ .../src/stellar-rpc/methods/getLedgers.json | 46 ++++++ openrpc/src/stellar-rpc/schemas/Ledgers.json | 29 ++++ .../src/stellar-rpc/schemas/Pagination.json | 2 +- static/stellar-rpc.openrpc.json | 147 +++++++++++++++++- 7 files changed, 284 insertions(+), 2 deletions(-) create mode 100644 docs/data/rpc/api-reference/methods/getLedgers.mdx create mode 100644 openrpc/src/stellar-rpc/examplePairingObjects/GetLedgersPairs.json create mode 100644 openrpc/src/stellar-rpc/examples/Ledgers.json create mode 100644 openrpc/src/stellar-rpc/methods/getLedgers.json create mode 100644 openrpc/src/stellar-rpc/schemas/Ledgers.json diff --git a/docs/data/rpc/api-reference/methods/getLedgers.mdx b/docs/data/rpc/api-reference/methods/getLedgers.mdx new file mode 100644 index 000000000..b85f52f6f --- /dev/null +++ b/docs/data/rpc/api-reference/methods/getLedgers.mdx @@ -0,0 +1,11 @@ +--- +hide_title: true +description: Returns list of ledgers +--- + +import { RpcMethod } from "@site/src/components/RpcMethod"; +import rpcSpec from "@site/static/stellar-rpc.openrpc.json"; + + meth.name === "getLedgers")[0]} +/> diff --git a/openrpc/src/stellar-rpc/examplePairingObjects/GetLedgersPairs.json b/openrpc/src/stellar-rpc/examplePairingObjects/GetLedgersPairs.json new file mode 100644 index 000000000..3c767cf60 --- /dev/null +++ b/openrpc/src/stellar-rpc/examplePairingObjects/GetLedgersPairs.json @@ -0,0 +1,13 @@ +{ + "SuccessfulGetLedgersRequest": { + "name": "Successful getLedgers Request", + "description": "Query a list of ledgers starting from the given startLedger.", + "params": [ + { "$ref": "#/components/examples/GetLedgersStartLedger" }, + { "$ref": "#/components/examples/GetLedgersPagination" } + ], + "result": { + "$ref": "#/components/examples/GetLedgersResult" + } + } +} diff --git a/openrpc/src/stellar-rpc/examples/Ledgers.json b/openrpc/src/stellar-rpc/examples/Ledgers.json new file mode 100644 index 000000000..6625ba2a4 --- /dev/null +++ b/openrpc/src/stellar-rpc/examples/Ledgers.json @@ -0,0 +1,38 @@ +{ + "GetLedgersStartLedger": { + "name": "startLedger", + "value": 36233 + }, + "GetLedgersPagination": { + "name": "pagination", + "value": { + "limit": 2 + } + }, + "GetLedgersResult": { + "name": "getLedgersResult", + "value": { + "ledgers": [ + { + "hash": "434de11b427aa4b6f8cda259ac2111a6aa148d2ab6b4c7affe864e94a9f4bd80", + "sequence": 36233, + "ledgerCloseTime": "1734032457", + "headerXdr": "Q03hG0J6pLb4zaJZrCERpqoUjSq2tMev/oZOlKn0vYAAAAAWY6AkQmSfV+Rrnpq308LrTR1IZq7dUQr4HkNPlpDpw4/4WH/HGddpIrl1KZiCUKzFOi9sqkX+b56aTGNqhTRHtwAAAABnWzxJAAAAAAAAAAEAAAAAqCTNGLyddQZNKZpbW6ykO8OqLzJpOBU9jC+btctt8DMAAABAjksBzacOp2IR06utjCmZ0QR6kgidREHCceghZapmZdNrS1uBiBG8Zz5Eh7uxMga5IAHPVbkSgFgXzjwRk4i2At8/YZgEqS/bQFcZLcQ910jqd4rcUrxJjOgFJMAUuBEZkxHVMCvc1iIZj7nTD2d91KT24H9FpOIGJLSiTuwys+0AAI2JDeC2s6dkAAAAAAAIewDXaQAAAAAAAAAAAAAB3wAAAGQATEtAAAAAyESlcNBlpidDCvLHH8Nu1MWDHWwUXTfbvGKqvbvlzzrb2GJe+2UfU8rr8mWrJXRTcQhl5UYgKhOQUOWP1nWgbp4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=", + "metadataXdr": "AAAAAQAAAABDTeEbQnqktvjNolmsIRGmqhSNKra0x6/+hk6UqfS9gAAAABZjoCRCZJ9X5GuemrfTwutNHUhmrt1RCvgeQ0+WkOnDj/hYf8cZ12kiuXUpmIJQrMU6L2yqRf5vnppMY2qFNEe3AAAAAGdbPEkAAAAAAAAAAQAAAACoJM0YvJ11Bk0pmltbrKQ7w6ovMmk4FT2ML5u1y23wMwAAAECOSwHNpw6nYhHTq62MKZnRBHqSCJ1EQcJx6CFlqmZl02tLW4GIEbxnPkSHu7EyBrkgAc9VuRKAWBfOPBGTiLYC3z9hmASpL9tAVxktxD3XSOp3itxSvEmM6AUkwBS4ERmTEdUwK9zWIhmPudMPZ33UpPbgf0Wk4gYktKJO7DKz7QAAjYkN4Lazp2QAAAAAAAh7ANdpAAAAAAAAAAAAAAHfAAAAZABMS0AAAADIRKVw0GWmJ0MK8scfw27UxYMdbBRdN9u8Yqq9u+XPOtvYYl77ZR9TyuvyZasldFNxCGXlRiAqE5BQ5Y/WdaBungAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAFjoCRCZJ9X5GuemrfTwutNHUhmrt1RCvgeQ0+WkOnDjwAAAAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADVBewAAAAAAAAAAA==" + }, + { + "hash": "201f38ca43cfad09d00287ee70d77edc8c88a61e018683fd466e71688222a217", + "sequence": 36234, + "ledgerCloseTime": "1734032462", + "headerXdr": "IB84ykPPrQnQAofucNd+3IyIph4BhoP9Rm5xaIIiohcAAAAWQ03hG0J6pLb4zaJZrCERpqoUjSq2tMev/oZOlKn0vYB8UE9ZJ4uLDnIu/g7+08D/eYnJjrJD07fGpWaVoLi29wAAAABnWzxOAAAAAAAAAAEAAAAAtV0Qsrt9KE7VwDpHpeG1kMkPV4NVRxzEUHu+ggTSPIsAAABAN6Cc3KxXPM2WmFDtY/yPZM0aha2yhnHFBDaliMqO6BzVQMb9Zlq5DoGrLr/xoFOp8YJ3RjLedF8w/KfN3ogPBuzRjPABveSt1CvvmDdnwUpSXyUsjdjECdbpjuKxaZZR+NeVPfeYT06qs2v4JwBff4WWpIGwEXPcxq3tZKuekH8AAI2KDeC2s6dkAAAAAAAIewDaiQAAAAAAAAAAAAAB3wAAAGQATEtAAAAAyESlcNBlpidDCvLHH8Nu1MWDHWwUXTfbvGKqvbvlzzrb2GJe+2UfU8rr8mWrJXRTcQhl5UYgKhOQUOWP1nWgbp4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=", + "metadataXdr": "AAAAAQAAAAAgHzjKQ8+tCdACh+5w137cjIimHgGGg/1GbnFogiKiFwAAABZDTeEbQnqktvjNolmsIRGmqhSNKra0x6/+hk6UqfS9gHxQT1kni4sOci7+Dv7TwP95icmOskPTt8alZpWguLb3AAAAAGdbPE4AAAAAAAAAAQAAAAC1XRCyu30oTtXAOkel4bWQyQ9Xg1VHHMRQe76CBNI8iwAAAEA3oJzcrFc8zZaYUO1j/I9kzRqFrbKGccUENqWIyo7oHNVAxv1mWrkOgasuv/GgU6nxgndGMt50XzD8p83eiA8G7NGM8AG95K3UK++YN2fBSlJfJSyN2MQJ1umO4rFpllH415U995hPTqqza/gnAF9/hZakgbARc9zGre1kq56QfwAAjYoN4Lazp2QAAAAAAAh7ANqJAAAAAAAAAAAAAAHfAAAAZABMS0AAAADIRKVw0GWmJ0MK8scfw27UxYMdbBRdN9u8Yqq9u+XPOtvYYl77ZR9TyuvyZasldFNxCGXlRiAqE5BQ5Y/WdaBungAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAFDTeEbQnqktvjNolmsIRGmqhSNKra0x6/+hk6UqfS9gAAAAAIAAAAAAAAAAQAAAAAAAAABAAAAAAAAAGQAAAAEAAAAAgAAAAA1F1Ya+0O+eQhWGWasX1tP8XnT8KbByGO5FML7jU5klgAehIAAACHEAAAXJAAAAAEAAAAAAAAAAAAAAABnWzyHAAAAAQAAAAhwc3BiOjc3NAAAAAIAAAABAAAAAIqW61Q3kZPdQ6gTYFSQ20kTCiKkY6KcEWxC1eCkhkzFAAAAAQAAAADjfej7Kt6ZZTe3zxwql+kdH4kwVHjgkfOYEaeLqGoIRgAAAAJBVFVBSAAAAAAAAAAAAAAAZ8rWY3iaDnWNtfpvLpNaCEbKdDjrd2gQODOuKpmj1vMAAAAABo53gAAAAAEAAAAAipbrVDeRk91DqBNgVJDbSRMKIqRjopwRbELV4KSGTMUAAAABAAAAAON96Psq3pllN7fPHCqX6R0fiTBUeOCR85gRp4uoaghGAAAAAkFUVVNEAAAAAAAAAAAAAABnytZjeJoOdY21+m8uk1oIRsp0OOt3aBA4M64qmaPW8wAAAAAAOHUgAAAAAAAAAAKNTmSWAAAAQA8LFEGM2p68s9GHmYgL2JnpbAVCKHeOxtG/HkcxqacuNQqISa3Iq9piWDeY2ZRwLvRb5w3QU34rY0jVzALXNQekhkzFAAAAQGg6RE0OGGeH7F4ufEGlDq4vNvSrP+OsCEVA5HarIQmWECDYhw4gJttA7J3XqC7KFony4S1HxRyJVPj82+VErgcAAAACAAAAAI8ylQbZjflZClH425dyBEYnAc8VJv4R020WOQKf612dAB6EgAAAIksAABn5AAAAAQAAAAAAAAAAAAAAAGdbPIkAAAABAAAACXBzcGI6NTgxNgAAAAAAAAIAAAABAAAAALyBL9daiYtaADzcZA8i3U28u/d5KV2Cu3cJTM1hY1NAAAAAAQAAAAAoQ0HJTIQcw+IUqbqLK9ekDhTGjbbaKXXzFPSAIirHIAAAAAJBVFNCUElVU0QAAAAAAAAAvIEv11qJi1oAPNxkDyLdTby793kpXYK7dwlMzWFjU0AAAAAAAvfjQAAAAAEAAAAAvIEv11qJi1oAPNxkDyLdTby793kpXYK7dwlMzWFjU0AAAAABAAAAAFh1GtTOa90yTcX7I+Q6WWd9N1ZBXtyHPDTZaib7m3SbAAAAAkFUU0JQSVVTRAAAAAAAAAC8gS/XWomLWgA83GQPIt1NvLv3eSldgrt3CUzNYWNTQAAAAAAAAw1AAAAAAAAAAAKf612dAAAAQNSwd8tthlQCQ1doozKPn4Qgtv+kIuCrdwHGChRG4dR+wjQuDwcuyBVXFJzZrVThq9cu/arC/KzAimTxlZ8SXgxhY1NAAAAAQF4liVjujCjZjgin8A8S0eg9R15lgQbAbjpr6NgNiLfXb6hWH7yq+zvWTnyEP/+/Do2VlXHH3VS7dImzcK2BawEAAAACAAAAAEBQYAimx5waQHaAptKgy2a/IAHMSe96ETt5wiMOSpKXAB6EgAAAIdQAABcgAAAAAQAAAAAAAAAAAAAAAGdbPIcAAAABAAAACHBzcGI6NDc5AAAAAgAAAAEAAAAAipbrVDeRk91DqBNgVJDbSRMKIqRjopwRbELV4KSGTMUAAAABAAAAAON96Psq3pllN7fPHCqX6R0fiTBUeOCR85gRp4uoaghGAAAAAkFUVUFIAAAAAAAAAAAAAABnytZjeJoOdY21+m8uk1oIRsp0OOt3aBA4M64qmaPW8wAAAAAGjneAAAAAAQAAAACKlutUN5GT3UOoE2BUkNtJEwoipGOinBFsQtXgpIZMxQAAAAEAAAAA433o+yremWU3t88cKpfpHR+JMFR44JHzmBGni6hqCEYAAAACQVRVU0QAAAAAAAAAAAAAAGfK1mN4mg51jbX6by6TWghGynQ463doEDgzriqZo9bzAAAAAAA4dSAAAAAAAAAAAg5KkpcAAABAEkPvoJlXL/V+TiEP8eiBhIg7SqIN3Tg7GWHVrNPWdi+iPdWLiXtYdfeylyBiDS84qWyNeSk7oQs35lXIN6nxCKSGTMUAAABA5JlXPTUOGN9PIaM/2CzCQ5uv39K6rHCmnmaUDXWiibbsPSpVwQPoCSFjcfH/Gu9vzKdPM1Ia2/OEr14WSDBNDAAAAAIAAAAAF4G//fAShUcDgR3xGIa+nyNyQErjHHAiPpPDSm1Q8mgAHoSAAAAh1QAAFx8AAAABAAAAAAAAAAAAAAAAZ1s8iAAAAAEAAAAIcHNwYjo2NTcAAAACAAAAAQAAAACKlutUN5GT3UOoE2BUkNtJEwoipGOinBFsQtXgpIZMxQAAAAEAAAAA433o+yremWU3t88cKpfpHR+JMFR44JHzmBGni6hqCEYAAAACQVRVU0QAAAAAAAAAAAAAAGfK1mN4mg51jbX6by6TWghGynQ463doEDgzriqZo9bzAAAAAAA4dSAAAAABAAAAAIqW61Q3kZPdQ6gTYFSQ20kTCiKkY6KcEWxC1eCkhkzFAAAAAQAAAADjfej7Kt6ZZTe3zxwql+kdH4kwVHjgkfOYEaeLqGoIRgAAAAJBVFVBSAAAAAAAAAAAAAAAZ8rWY3iaDnWNtfpvLpNaCEbKdDjrd2gQODOuKpmj1vMAAAAABo53gAAAAAAAAAACbVDyaAAAAEB2pWOQ6oNzzFMA0ejSrpJr+Ltj7tTAz5p3j0DWktnsdi2hWMTwMZMSl+PTJrisS80wOhG3Kqe8dnNaIP6QJ9gHpIZMxQAAAEC8fqM6Vf/ZlzfecYiMsiFsk5T4xb9/Yg2Lpu9Kjo/aCvoxnTM9npu1S+NQONm+DVO/E+QCR+FoThukfzo7vSMFAAAAAAAAAAAAAAAETK9HXjqvIoZ83nB+r4yyVcLFoSyJQHGFzTddGlKGQC0AAAAAAAAAyP////8AAAACAAAAAAAAAAH////7AAAAAAAAAAH////7AAAAAAAAAAIAAAADAACNhgAAAAAAAAAAF4G//fAShUcDgR3xGIa+nyNyQErjHHAiPpPDSm1Q8mgAAAAXSGYyRAAAIdUAABceAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2GAAAAAGdbPDoAAAAAAAAAAQAAjYoAAAAAAAAAABeBv/3wEoVHA4Ed8RiGvp8jckBK4xxwIj6Tw0ptUPJoAAAAF0hmMXwAACHVAAAXHgAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAAAAAAAAAAAAMAAAAAAACNhgAAAABnWzw6AAAAAAAAAAMAAAAAAAAAAgAAAAMAAI2KAAAAAAAAAAAXgb/98BKFRwOBHfEYhr6fI3JASuMccCI+k8NKbVDyaAAAABdIZjF8AAAh1QAAFx4AAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAIAAAAAAAAAAAAAAAAAAAADAAAAAAAAjYYAAAAAZ1s8OgAAAAAAAAABAACNigAAAAAAAAAAF4G//fAShUcDgR3xGIa+nyNyQErjHHAiPpPDSm1Q8mgAAAAXSGYxfAAAIdUAABcfAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2KAAAAAGdbPE4AAAAAAAAAAAAAAAAAAAAAlHPkmVMd4KxXSFzK1ZnlVOu6ZVnmeoceJG8N8mqptnsAAAAAAAAAyP////8AAAACAAAAAAAAAAH////7AAAAAAAAAAH////7AAAAAAAAAAIAAAADAACNhgAAAAAAAAAAQFBgCKbHnBpAdoCm0qDLZr8gAcxJ73oRO3nCIw5KkpcAAAAXSGYx4AAAIdQAABcfAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2GAAAAAGdbPDoAAAAAAAAAAQAAjYoAAAAAAAAAAEBQYAimx5waQHaAptKgy2a/IAHMSe96ETt5wiMOSpKXAAAAF0hmMRgAACHUAAAXHwAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAAAAAAAAAAAAMAAAAAAACNhgAAAABnWzw6AAAAAAAAAAMAAAAAAAAAAgAAAAMAAI2KAAAAAAAAAABAUGAIpsecGkB2gKbSoMtmvyABzEnvehE7ecIjDkqSlwAAABdIZjEYAAAh1AAAFx8AAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAIAAAAAAAAAAAAAAAAAAAADAAAAAAAAjYYAAAAAZ1s8OgAAAAAAAAABAACNigAAAAAAAAAAQFBgCKbHnBpAdoCm0qDLZr8gAcxJ73oRO3nCIw5KkpcAAAAXSGYxGAAAIdQAABcgAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2KAAAAAGdbPE4AAAAAAAAAAAAAAAAAAAAAYSf/ygwR8YuXauwz38GEKXDIyITlfP88Z2wGEAWJqSgAAAAAAAAAyP////8AAAACAAAAAAAAAAEAAAAAAAAAAAAAAAH////6AAAAAAAAAAIAAAADAACNgAAAAAAAAAAAjzKVBtmN+VkKUfjbl3IERicBzxUm/hHTbRY5Ap/rXZ0AAAAXSGKhYAAAIksAABn4AAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2AAAAAAGdbPBwAAAAAAAAAAQAAjYoAAAAAAAAAAI8ylQbZjflZClH425dyBEYnAc8VJv4R020WOQKf612dAAAAF0hioJgAACJLAAAZ+AAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAAAAAAAAAAAAMAAAAAAACNgAAAAABnWzwcAAAAAAAAAAMAAAAAAAAAAgAAAAMAAI2KAAAAAAAAAACPMpUG2Y35WQpR+NuXcgRGJwHPFSb+EdNtFjkCn+tdnQAAABdIYqCYAAAiSwAAGfgAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAIAAAAAAAAAAAAAAAAAAAADAAAAAAAAjYAAAAAAZ1s8HAAAAAAAAAABAACNigAAAAAAAAAAjzKVBtmN+VkKUfjbl3IERicBzxUm/hHTbRY5Ap/rXZ0AAAAXSGKgmAAAIksAABn5AAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2KAAAAAGdbPE4AAAAAAAAAAAAAAAAAAAAAcERufoNgDSa7wFkwjPY0LJia0337ZTeNzXHyuOhXwIoAAAAAAAAAyP////8AAAACAAAAAAAAAAH////7AAAAAAAAAAH////7AAAAAAAAAAIAAAADAACNiAAAAAAAAAAANRdWGvtDvnkIVhlmrF9bT/F50/CmwchjuRTC+41OZJYAAAAXSGYyqAAAIcQAABcjAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2IAAAAAGdbPEQAAAAAAAAAAQAAjYoAAAAAAAAAADUXVhr7Q755CFYZZqxfW0/xedPwpsHIY7kUwvuNTmSWAAAAF0hmMeAAACHEAAAXIwAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAAAAAAAAAAAAMAAAAAAACNiAAAAABnWzxEAAAAAAAAAAMAAAAAAAAAAgAAAAMAAI2KAAAAAAAAAAA1F1Ya+0O+eQhWGWasX1tP8XnT8KbByGO5FML7jU5klgAAABdIZjHgAAAhxAAAFyMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAIAAAAAAAAAAAAAAAAAAAADAAAAAAAAjYgAAAAAZ1s8RAAAAAAAAAABAACNigAAAAAAAAAANRdWGvtDvnkIVhlmrF9bT/F50/CmwchjuRTC+41OZJYAAAAXSGYx4AAAIcQAABckAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2KAAAAAGdbPE4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAANUF7AAAAAAAAAAA" + } + ], + "latestLedger": 36379, + "latestLedgerCloseTime": 1734033188, + "oldestLedger": 29312, + "oldestLedgerCloseTime": 1733997822, + "cursor": "36234" + } + } +} diff --git a/openrpc/src/stellar-rpc/methods/getLedgers.json b/openrpc/src/stellar-rpc/methods/getLedgers.json new file mode 100644 index 000000000..5fec2db48 --- /dev/null +++ b/openrpc/src/stellar-rpc/methods/getLedgers.json @@ -0,0 +1,46 @@ +{ + "name": "getLedgers", + "summary": "returns a list of ledgers with their details", + "description": "The `getLedgers` method returns a detailed list of ledgers starting from the user specified starting point that you can paginate as long as the pages fall within the history retention of their corresponding RPC provider.", + "externalDocs": { + "url": "https://developers.stellar.org/docs/data/rpc/api-reference/methods/getLedgers" + }, + "paramStructure": "by-name", + "params": [ + { + "$ref": "#/components/contentDescriptors/StartLedger" + }, + { + "$ref": "#/components/contentDescriptors/TransactionsPagination" + } + ], + "result": { + "name": "getLedgersResult", + "schema": { + "type": "object", + "properties": { + "ledgers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Ledgers" + } + }, + "latestLedger": { + "$ref": "#/components/schemas/LatestLedger" + }, + "latestLedgerCloseTimestamp": { + "$ref": "#/components/schemas/LatestLedgerCloseTime" + }, + "oldestLedger": { + "$ref": "#/components/schemas/OldestLedger" + }, + "oldestLedgerCloseTimestamp": { + "$ref": "#/components/schemas/OldestLedgerCloseTime" + } + } + } + }, + "examples": [ + { "$ref": "#/components/examplePairingObjects/SuccessfulGetLedgersRequest" } + ] +} diff --git a/openrpc/src/stellar-rpc/schemas/Ledgers.json b/openrpc/src/stellar-rpc/schemas/Ledgers.json new file mode 100644 index 000000000..36dae06a4 --- /dev/null +++ b/openrpc/src/stellar-rpc/schemas/Ledgers.json @@ -0,0 +1,29 @@ +{ + "Ledgers": { + "type": "object", + "properties": { + "hash": { + "type": "string", + "description": "The hash of the ledger header which was included in the chain" + }, + "sequence": { + "type": "number", + "description": "The sequence number of the ledger (sometimes called the 'block height').", + "$ref": "#/components/schemas/LedgerSequence" + }, + "ledgerCloseTime": { + "type": "string", + "description": "The timestamp at which the ledger was closed.", + "$ref": "#/components/schemas/LedgerCloseTime" + }, + "headerXdr": { + "type": "string", + "description": "A base64 encoded string of the raw `LedgerHeader` xdr struct for this ledger." + }, + "metadataXdr": { + "type": "string", + "description": "A base64 encoded string of the raw `LedgerCloseMeta` xdr struct for this ledger." + } + } + } +} diff --git a/openrpc/src/stellar-rpc/schemas/Pagination.json b/openrpc/src/stellar-rpc/schemas/Pagination.json index d1f5e2723..e4c452c2c 100644 --- a/openrpc/src/stellar-rpc/schemas/Pagination.json +++ b/openrpc/src/stellar-rpc/schemas/Pagination.json @@ -20,7 +20,7 @@ }, "limit": { "type": "number", - "description": "The maximum number of records returned. For getTransactions, this ranges from 1 to 200 and defaults to 50." + "description": "The maximum number of records returned by the endpoint." } }, "required": [] diff --git a/static/stellar-rpc.openrpc.json b/static/stellar-rpc.openrpc.json index 2040e93ee..5d56caf39 100644 --- a/static/stellar-rpc.openrpc.json +++ b/static/stellar-rpc.openrpc.json @@ -817,6 +817,151 @@ } ] }, + { + "name": "getLedgers", + "summary": "returns a list of ledgers with their details", + "description": "The `getLedgers` method returns a detailed list of ledgers starting from the user specified starting point that you can paginate as long as the pages fall within the history retention of their corresponding RPC provider.", + "externalDocs": { + "url": "https://developers.stellar.org/docs/data/rpc/api-reference/methods/getLedgers" + }, + "paramStructure": "by-name", + "params": [ + { + "name": "startLedger", + "summary": "ledger to begin searching from", + "description": "Ledger sequence number to start fetching responses from (inclusive). This method will return an error if `startLedger` is less than the oldest ledger stored in this node, or greater than the latest ledger seen by this node. If a cursor is included in the request, `startLedger` must be omitted.", + "required": true, + "schema": { + "title": "ledgerSequence", + "description": "Sequence number of the ledger.", + "type": "number" + } + }, + { + "name": "pagination", + "summary": "pagination options", + "description": "Pagination in RPC is similar to pagination in Horizon. See [Pagination](https://developers.stellar.org/docs/data/rpc/api-reference/pagination).", + "required": false, + "schema": { + "type": "object", + "required": [], + "properties": { + "cursor": { + "title": "cursor", + "type": "string", + "description": "A unique identifier (specifically, a [TOID](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0035.md#specification)) that points to a specific location in a collection of responses and is pulled from the `paging_token` value of a record. When a cursor is provided, RPC will _not_ include the element whose ID matches the cursor in the response: only elements which appear _after_ the cursor will be included." + }, + "limit": { + "type": "number", + "description": "The maximum number of records returned by the endpoint." + } + } + } + } + ], + "result": { + "name": "getLedgersResult", + "schema": { + "type": "object", + "properties": { + "ledgers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hash": { + "type": "string", + "description": "The hash of the ledger header which was included in the chain" + }, + "sequence": { + "title": "ledgerSequence", + "description": "The sequence number of the ledger (sometimes called the 'block height').", + "type": "number" + }, + "ledgerCloseTime": { + "title": "ledgerCloseTime", + "description": "The timestamp at which the ledger was closed.", + "type": "string" + }, + "headerXdr": { + "type": "string", + "description": "A base64 encoded string of the raw `LedgerHeader` xdr struct for this ledger." + }, + "metadataXdr": { + "type": "string", + "description": "A base64 encoded string of the raw `LedgerCloseMeta` xdr struct for this ledger." + } + } + } + }, + "latestLedger": { + "title": "latestLedger", + "description": "The sequence number of the latest ledger known to Stellar RPC at the time it handled the request.", + "type": "number" + }, + "latestLedgerCloseTimestamp": { + "title": "latestLedgerCloseTime", + "description": "The unix timestamp of the close time of the latest ledger known to Stellar RPC at the time it handled the request.", + "type": "string" + }, + "oldestLedger": { + "title": "oldestLedger", + "description": "The sequence number of the oldest ledger ingested by Stellar RPC at the time it handled the request.", + "type": "number" + }, + "oldestLedgerCloseTimestamp": { + "title": "oldestLedgerCloseTime", + "description": "The unix timestamp of the close time of the oldest ledger ingested by Stellar RPC at the time it handled the request.", + "type": "string" + } + } + } + }, + "examples": [ + { + "name": "Successful getLedgers Request", + "description": "Query a list of ledgers starting from the given startLedger.", + "params": [ + { + "name": "startLedger", + "value": 36233 + }, + { + "name": "pagination", + "value": { + "limit": 2 + } + } + ], + "result": { + "name": "getLedgersResult", + "value": { + "ledgers": [ + { + "hash": "434de11b427aa4b6f8cda259ac2111a6aa148d2ab6b4c7affe864e94a9f4bd80", + "sequence": 36233, + "ledgerCloseTime": "1734032457", + "headerXdr": "Q03hG0J6pLb4zaJZrCERpqoUjSq2tMev/oZOlKn0vYAAAAAWY6AkQmSfV+Rrnpq308LrTR1IZq7dUQr4HkNPlpDpw4/4WH/HGddpIrl1KZiCUKzFOi9sqkX+b56aTGNqhTRHtwAAAABnWzxJAAAAAAAAAAEAAAAAqCTNGLyddQZNKZpbW6ykO8OqLzJpOBU9jC+btctt8DMAAABAjksBzacOp2IR06utjCmZ0QR6kgidREHCceghZapmZdNrS1uBiBG8Zz5Eh7uxMga5IAHPVbkSgFgXzjwRk4i2At8/YZgEqS/bQFcZLcQ910jqd4rcUrxJjOgFJMAUuBEZkxHVMCvc1iIZj7nTD2d91KT24H9FpOIGJLSiTuwys+0AAI2JDeC2s6dkAAAAAAAIewDXaQAAAAAAAAAAAAAB3wAAAGQATEtAAAAAyESlcNBlpidDCvLHH8Nu1MWDHWwUXTfbvGKqvbvlzzrb2GJe+2UfU8rr8mWrJXRTcQhl5UYgKhOQUOWP1nWgbp4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=", + "metadataXdr": "AAAAAQAAAABDTeEbQnqktvjNolmsIRGmqhSNKra0x6/+hk6UqfS9gAAAABZjoCRCZJ9X5GuemrfTwutNHUhmrt1RCvgeQ0+WkOnDj/hYf8cZ12kiuXUpmIJQrMU6L2yqRf5vnppMY2qFNEe3AAAAAGdbPEkAAAAAAAAAAQAAAACoJM0YvJ11Bk0pmltbrKQ7w6ovMmk4FT2ML5u1y23wMwAAAECOSwHNpw6nYhHTq62MKZnRBHqSCJ1EQcJx6CFlqmZl02tLW4GIEbxnPkSHu7EyBrkgAc9VuRKAWBfOPBGTiLYC3z9hmASpL9tAVxktxD3XSOp3itxSvEmM6AUkwBS4ERmTEdUwK9zWIhmPudMPZ33UpPbgf0Wk4gYktKJO7DKz7QAAjYkN4Lazp2QAAAAAAAh7ANdpAAAAAAAAAAAAAAHfAAAAZABMS0AAAADIRKVw0GWmJ0MK8scfw27UxYMdbBRdN9u8Yqq9u+XPOtvYYl77ZR9TyuvyZasldFNxCGXlRiAqE5BQ5Y/WdaBungAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAFjoCRCZJ9X5GuemrfTwutNHUhmrt1RCvgeQ0+WkOnDjwAAAAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADVBewAAAAAAAAAAA==" + }, + { + "hash": "201f38ca43cfad09d00287ee70d77edc8c88a61e018683fd466e71688222a217", + "sequence": 36234, + "ledgerCloseTime": "1734032462", + "headerXdr": "IB84ykPPrQnQAofucNd+3IyIph4BhoP9Rm5xaIIiohcAAAAWQ03hG0J6pLb4zaJZrCERpqoUjSq2tMev/oZOlKn0vYB8UE9ZJ4uLDnIu/g7+08D/eYnJjrJD07fGpWaVoLi29wAAAABnWzxOAAAAAAAAAAEAAAAAtV0Qsrt9KE7VwDpHpeG1kMkPV4NVRxzEUHu+ggTSPIsAAABAN6Cc3KxXPM2WmFDtY/yPZM0aha2yhnHFBDaliMqO6BzVQMb9Zlq5DoGrLr/xoFOp8YJ3RjLedF8w/KfN3ogPBuzRjPABveSt1CvvmDdnwUpSXyUsjdjECdbpjuKxaZZR+NeVPfeYT06qs2v4JwBff4WWpIGwEXPcxq3tZKuekH8AAI2KDeC2s6dkAAAAAAAIewDaiQAAAAAAAAAAAAAB3wAAAGQATEtAAAAAyESlcNBlpidDCvLHH8Nu1MWDHWwUXTfbvGKqvbvlzzrb2GJe+2UfU8rr8mWrJXRTcQhl5UYgKhOQUOWP1nWgbp4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=", + "metadataXdr": "AAAAAQAAAAAgHzjKQ8+tCdACh+5w137cjIimHgGGg/1GbnFogiKiFwAAABZDTeEbQnqktvjNolmsIRGmqhSNKra0x6/+hk6UqfS9gHxQT1kni4sOci7+Dv7TwP95icmOskPTt8alZpWguLb3AAAAAGdbPE4AAAAAAAAAAQAAAAC1XRCyu30oTtXAOkel4bWQyQ9Xg1VHHMRQe76CBNI8iwAAAEA3oJzcrFc8zZaYUO1j/I9kzRqFrbKGccUENqWIyo7oHNVAxv1mWrkOgasuv/GgU6nxgndGMt50XzD8p83eiA8G7NGM8AG95K3UK++YN2fBSlJfJSyN2MQJ1umO4rFpllH415U995hPTqqza/gnAF9/hZakgbARc9zGre1kq56QfwAAjYoN4Lazp2QAAAAAAAh7ANqJAAAAAAAAAAAAAAHfAAAAZABMS0AAAADIRKVw0GWmJ0MK8scfw27UxYMdbBRdN9u8Yqq9u+XPOtvYYl77ZR9TyuvyZasldFNxCGXlRiAqE5BQ5Y/WdaBungAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAFDTeEbQnqktvjNolmsIRGmqhSNKra0x6/+hk6UqfS9gAAAAAIAAAAAAAAAAQAAAAAAAAABAAAAAAAAAGQAAAAEAAAAAgAAAAA1F1Ya+0O+eQhWGWasX1tP8XnT8KbByGO5FML7jU5klgAehIAAACHEAAAXJAAAAAEAAAAAAAAAAAAAAABnWzyHAAAAAQAAAAhwc3BiOjc3NAAAAAIAAAABAAAAAIqW61Q3kZPdQ6gTYFSQ20kTCiKkY6KcEWxC1eCkhkzFAAAAAQAAAADjfej7Kt6ZZTe3zxwql+kdH4kwVHjgkfOYEaeLqGoIRgAAAAJBVFVBSAAAAAAAAAAAAAAAZ8rWY3iaDnWNtfpvLpNaCEbKdDjrd2gQODOuKpmj1vMAAAAABo53gAAAAAEAAAAAipbrVDeRk91DqBNgVJDbSRMKIqRjopwRbELV4KSGTMUAAAABAAAAAON96Psq3pllN7fPHCqX6R0fiTBUeOCR85gRp4uoaghGAAAAAkFUVVNEAAAAAAAAAAAAAABnytZjeJoOdY21+m8uk1oIRsp0OOt3aBA4M64qmaPW8wAAAAAAOHUgAAAAAAAAAAKNTmSWAAAAQA8LFEGM2p68s9GHmYgL2JnpbAVCKHeOxtG/HkcxqacuNQqISa3Iq9piWDeY2ZRwLvRb5w3QU34rY0jVzALXNQekhkzFAAAAQGg6RE0OGGeH7F4ufEGlDq4vNvSrP+OsCEVA5HarIQmWECDYhw4gJttA7J3XqC7KFony4S1HxRyJVPj82+VErgcAAAACAAAAAI8ylQbZjflZClH425dyBEYnAc8VJv4R020WOQKf612dAB6EgAAAIksAABn5AAAAAQAAAAAAAAAAAAAAAGdbPIkAAAABAAAACXBzcGI6NTgxNgAAAAAAAAIAAAABAAAAALyBL9daiYtaADzcZA8i3U28u/d5KV2Cu3cJTM1hY1NAAAAAAQAAAAAoQ0HJTIQcw+IUqbqLK9ekDhTGjbbaKXXzFPSAIirHIAAAAAJBVFNCUElVU0QAAAAAAAAAvIEv11qJi1oAPNxkDyLdTby793kpXYK7dwlMzWFjU0AAAAAAAvfjQAAAAAEAAAAAvIEv11qJi1oAPNxkDyLdTby793kpXYK7dwlMzWFjU0AAAAABAAAAAFh1GtTOa90yTcX7I+Q6WWd9N1ZBXtyHPDTZaib7m3SbAAAAAkFUU0JQSVVTRAAAAAAAAAC8gS/XWomLWgA83GQPIt1NvLv3eSldgrt3CUzNYWNTQAAAAAAAAw1AAAAAAAAAAAKf612dAAAAQNSwd8tthlQCQ1doozKPn4Qgtv+kIuCrdwHGChRG4dR+wjQuDwcuyBVXFJzZrVThq9cu/arC/KzAimTxlZ8SXgxhY1NAAAAAQF4liVjujCjZjgin8A8S0eg9R15lgQbAbjpr6NgNiLfXb6hWH7yq+zvWTnyEP/+/Do2VlXHH3VS7dImzcK2BawEAAAACAAAAAEBQYAimx5waQHaAptKgy2a/IAHMSe96ETt5wiMOSpKXAB6EgAAAIdQAABcgAAAAAQAAAAAAAAAAAAAAAGdbPIcAAAABAAAACHBzcGI6NDc5AAAAAgAAAAEAAAAAipbrVDeRk91DqBNgVJDbSRMKIqRjopwRbELV4KSGTMUAAAABAAAAAON96Psq3pllN7fPHCqX6R0fiTBUeOCR85gRp4uoaghGAAAAAkFUVUFIAAAAAAAAAAAAAABnytZjeJoOdY21+m8uk1oIRsp0OOt3aBA4M64qmaPW8wAAAAAGjneAAAAAAQAAAACKlutUN5GT3UOoE2BUkNtJEwoipGOinBFsQtXgpIZMxQAAAAEAAAAA433o+yremWU3t88cKpfpHR+JMFR44JHzmBGni6hqCEYAAAACQVRVU0QAAAAAAAAAAAAAAGfK1mN4mg51jbX6by6TWghGynQ463doEDgzriqZo9bzAAAAAAA4dSAAAAAAAAAAAg5KkpcAAABAEkPvoJlXL/V+TiEP8eiBhIg7SqIN3Tg7GWHVrNPWdi+iPdWLiXtYdfeylyBiDS84qWyNeSk7oQs35lXIN6nxCKSGTMUAAABA5JlXPTUOGN9PIaM/2CzCQ5uv39K6rHCmnmaUDXWiibbsPSpVwQPoCSFjcfH/Gu9vzKdPM1Ia2/OEr14WSDBNDAAAAAIAAAAAF4G//fAShUcDgR3xGIa+nyNyQErjHHAiPpPDSm1Q8mgAHoSAAAAh1QAAFx8AAAABAAAAAAAAAAAAAAAAZ1s8iAAAAAEAAAAIcHNwYjo2NTcAAAACAAAAAQAAAACKlutUN5GT3UOoE2BUkNtJEwoipGOinBFsQtXgpIZMxQAAAAEAAAAA433o+yremWU3t88cKpfpHR+JMFR44JHzmBGni6hqCEYAAAACQVRVU0QAAAAAAAAAAAAAAGfK1mN4mg51jbX6by6TWghGynQ463doEDgzriqZo9bzAAAAAAA4dSAAAAABAAAAAIqW61Q3kZPdQ6gTYFSQ20kTCiKkY6KcEWxC1eCkhkzFAAAAAQAAAADjfej7Kt6ZZTe3zxwql+kdH4kwVHjgkfOYEaeLqGoIRgAAAAJBVFVBSAAAAAAAAAAAAAAAZ8rWY3iaDnWNtfpvLpNaCEbKdDjrd2gQODOuKpmj1vMAAAAABo53gAAAAAAAAAACbVDyaAAAAEB2pWOQ6oNzzFMA0ejSrpJr+Ltj7tTAz5p3j0DWktnsdi2hWMTwMZMSl+PTJrisS80wOhG3Kqe8dnNaIP6QJ9gHpIZMxQAAAEC8fqM6Vf/ZlzfecYiMsiFsk5T4xb9/Yg2Lpu9Kjo/aCvoxnTM9npu1S+NQONm+DVO/E+QCR+FoThukfzo7vSMFAAAAAAAAAAAAAAAETK9HXjqvIoZ83nB+r4yyVcLFoSyJQHGFzTddGlKGQC0AAAAAAAAAyP////8AAAACAAAAAAAAAAH////7AAAAAAAAAAH////7AAAAAAAAAAIAAAADAACNhgAAAAAAAAAAF4G//fAShUcDgR3xGIa+nyNyQErjHHAiPpPDSm1Q8mgAAAAXSGYyRAAAIdUAABceAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2GAAAAAGdbPDoAAAAAAAAAAQAAjYoAAAAAAAAAABeBv/3wEoVHA4Ed8RiGvp8jckBK4xxwIj6Tw0ptUPJoAAAAF0hmMXwAACHVAAAXHgAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAAAAAAAAAAAAMAAAAAAACNhgAAAABnWzw6AAAAAAAAAAMAAAAAAAAAAgAAAAMAAI2KAAAAAAAAAAAXgb/98BKFRwOBHfEYhr6fI3JASuMccCI+k8NKbVDyaAAAABdIZjF8AAAh1QAAFx4AAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAIAAAAAAAAAAAAAAAAAAAADAAAAAAAAjYYAAAAAZ1s8OgAAAAAAAAABAACNigAAAAAAAAAAF4G//fAShUcDgR3xGIa+nyNyQErjHHAiPpPDSm1Q8mgAAAAXSGYxfAAAIdUAABcfAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2KAAAAAGdbPE4AAAAAAAAAAAAAAAAAAAAAlHPkmVMd4KxXSFzK1ZnlVOu6ZVnmeoceJG8N8mqptnsAAAAAAAAAyP////8AAAACAAAAAAAAAAH////7AAAAAAAAAAH////7AAAAAAAAAAIAAAADAACNhgAAAAAAAAAAQFBgCKbHnBpAdoCm0qDLZr8gAcxJ73oRO3nCIw5KkpcAAAAXSGYx4AAAIdQAABcfAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2GAAAAAGdbPDoAAAAAAAAAAQAAjYoAAAAAAAAAAEBQYAimx5waQHaAptKgy2a/IAHMSe96ETt5wiMOSpKXAAAAF0hmMRgAACHUAAAXHwAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAAAAAAAAAAAAMAAAAAAACNhgAAAABnWzw6AAAAAAAAAAMAAAAAAAAAAgAAAAMAAI2KAAAAAAAAAABAUGAIpsecGkB2gKbSoMtmvyABzEnvehE7ecIjDkqSlwAAABdIZjEYAAAh1AAAFx8AAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAIAAAAAAAAAAAAAAAAAAAADAAAAAAAAjYYAAAAAZ1s8OgAAAAAAAAABAACNigAAAAAAAAAAQFBgCKbHnBpAdoCm0qDLZr8gAcxJ73oRO3nCIw5KkpcAAAAXSGYxGAAAIdQAABcgAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2KAAAAAGdbPE4AAAAAAAAAAAAAAAAAAAAAYSf/ygwR8YuXauwz38GEKXDIyITlfP88Z2wGEAWJqSgAAAAAAAAAyP////8AAAACAAAAAAAAAAEAAAAAAAAAAAAAAAH////6AAAAAAAAAAIAAAADAACNgAAAAAAAAAAAjzKVBtmN+VkKUfjbl3IERicBzxUm/hHTbRY5Ap/rXZ0AAAAXSGKhYAAAIksAABn4AAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2AAAAAAGdbPBwAAAAAAAAAAQAAjYoAAAAAAAAAAI8ylQbZjflZClH425dyBEYnAc8VJv4R020WOQKf612dAAAAF0hioJgAACJLAAAZ+AAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAAAAAAAAAAAAMAAAAAAACNgAAAAABnWzwcAAAAAAAAAAMAAAAAAAAAAgAAAAMAAI2KAAAAAAAAAACPMpUG2Y35WQpR+NuXcgRGJwHPFSb+EdNtFjkCn+tdnQAAABdIYqCYAAAiSwAAGfgAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAIAAAAAAAAAAAAAAAAAAAADAAAAAAAAjYAAAAAAZ1s8HAAAAAAAAAABAACNigAAAAAAAAAAjzKVBtmN+VkKUfjbl3IERicBzxUm/hHTbRY5Ap/rXZ0AAAAXSGKgmAAAIksAABn5AAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2KAAAAAGdbPE4AAAAAAAAAAAAAAAAAAAAAcERufoNgDSa7wFkwjPY0LJia0337ZTeNzXHyuOhXwIoAAAAAAAAAyP////8AAAACAAAAAAAAAAH////7AAAAAAAAAAH////7AAAAAAAAAAIAAAADAACNiAAAAAAAAAAANRdWGvtDvnkIVhlmrF9bT/F50/CmwchjuRTC+41OZJYAAAAXSGYyqAAAIcQAABcjAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2IAAAAAGdbPEQAAAAAAAAAAQAAjYoAAAAAAAAAADUXVhr7Q755CFYZZqxfW0/xedPwpsHIY7kUwvuNTmSWAAAAF0hmMeAAACHEAAAXIwAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAAAAAAAAAAAAMAAAAAAACNiAAAAABnWzxEAAAAAAAAAAMAAAAAAAAAAgAAAAMAAI2KAAAAAAAAAAA1F1Ya+0O+eQhWGWasX1tP8XnT8KbByGO5FML7jU5klgAAABdIZjHgAAAhxAAAFyMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAIAAAAAAAAAAAAAAAAAAAADAAAAAAAAjYgAAAAAZ1s8RAAAAAAAAAABAACNigAAAAAAAAAANRdWGvtDvnkIVhlmrF9bT/F50/CmwchjuRTC+41OZJYAAAAXSGYx4AAAIcQAABckAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAAAI2KAAAAAGdbPE4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAANUF7AAAAAAAAAAA" + } + ], + "latestLedger": 36379, + "latestLedgerCloseTime": 1734033188, + "oldestLedger": 29312, + "oldestLedgerCloseTime": 1733997822, + "cursor": "36234" + } + } + } + ] + }, { "name": "getNetwork", "summary": "returns network config", @@ -1096,7 +1241,7 @@ }, "limit": { "type": "number", - "description": "The maximum number of records returned. For getTransactions, this ranges from 1 to 200 and defaults to 50." + "description": "The maximum number of records returned by the endpoint." } } }