Skip to main content
Lumeus RPC supports the 12 Stellar RPC methods below, all through POST /. Results match Stellar RPC; this page lists what Lumeus adds: required parameters, limits and credits.

Supported methods

Mainnet getLedgers pages are small because one Mainnet ledger with metadata is about 1 to 2.3 MB.

Parameters

  • Send params as a named JSON object, or leave it out. Positional arrays get 400 with code -32602.
  • A parameter set to null is treated as not sent, so SDKs that send null for unset options work.
  • Unknown methods get -32601, and unknown parameters get -32602.
  • getLedgerEntries.keys takes base64 LedgerKey XDR, not an address. Build keys with your SDK, as in build a LedgerKey.
  • xdrFormat is "base64" (default) or "json", on the methods that support it.

Build a LedgerKey

getLedgerEntries reads current entries by key. These examples build the key of an account and of a contract’s instance, then read both: Set these once in your terminal. The sample values are real Testnet data, so the read examples return real results.
For a contract’s storage entry, put the storage key’s ScVal in key and pick persistent or temporary durability. JavaScript’s server.getAccount and server.getContractData build common keys for you.

Pagination

getEvents, getTransactions and getLedgers page the same way:
  1. First page: send startLedger. It must be inside the retained window (getHealth returns oldestLedger).
  2. Next pages: send pagination.cursor from the previous result, and no startLedger. For getEvents, repeat the same filters.
  3. pagination.limit sets the page size, within the limits above.
Response
A startLedger outside the retained window returns HTTP 200 with a node error (-32600). The wording differs by method, for example getEvents answers “startLedger must be within the ledger range: 5244415 - 5332491”, so do not match on it. For older history, use the Activity API.

getEvents filter limits

"**" is allowed only as the last segment. Breaking a rule returns 400 with -32602.

Credits

Testnet calls are free: they cost 0 credits, and each call (each batch child) counts toward your daily Testnet cap of 10,000 requests. On Mainnet, a call costs its method credits from the table above plus one credit per started 64 KiB of response. For example:
  • A getHealth call (under 1 KiB) costs 1 + 1 = 2 credits.
  • A 200 KiB getLedgers page costs 2 + 4 = 6 credits.
  • A batch costs the sum of its children’s method credits plus one credit per started 64 KiB of the whole batch response.
Gateway errors (4xx and 5xx) are not charged. A simulation that returns result.error did run and costs its 5 credits. The live table is rpc_method_credits in GET https://api.lumeus.dev/v1/plans, and Mainnet credits come from your workspace’s monthly balance; see billing.

Size and time limits

See RPC errors for every code and rate limits for requests per minute.