# Lumeus

> Stellar Activity API, Assets API, webhooks and RPC documentation.

- [Lumeus docs](https://docs.lumeus.dev/index.md): Stellar Mainnet and Testnet. Activity, assets, webhooks and RPC.
- [Quickstart](https://docs.lumeus.dev/quickstart.md): Sign up, get a Testnet key and make your first Activity, Assets and RPC calls.
- [Authentication](https://docs.lumeus.dev/guides/authentication.md): API keys, networks, key rotation and read-only keys.
- [Browser keys](https://docs.lumeus.dev/guides/browser-keys.md): Publishable keys for calling Activity, Assets and RPC from web pages.
- [Plans and billing](https://docs.lumeus.dev/guides/billing.md): Plans, prices, the plan catalog, upgrades, overage and when a request is charged.
- [Usage and limits](https://docs.lumeus.dev/guides/limits.md): Plan limits, page sizes, credits per route and how to check usage.
- [Activity API](https://docs.lumeus.dev/activity/overview.md): Query decoded Stellar activity by account, asset, contract or transaction.
- [Account history](https://docs.lumeus.dev/activity/history.md): Copy an account's complete history, then keep it current.
- [Pagination](https://docs.lumeus.dev/activity/pagination.md): Cursors, snapshots and completion markers.
- [Events](https://docs.lumeus.dev/activity/events.md): Event fields, IDs, amount precision and supported operations.
- [Token classification](https://docs.lumeus.dev/activity/tokens.md): Which contract events become token_transfer records and which stay contract_event.
- [Contract events by address](https://docs.lumeus.dev/activity/contract-events.md): Find Soroban contract events whose topics name an account or contract.
- [Assets API](https://docs.lumeus.dev/assets-api/overview.md): Balances per address, ranked token holders and a token registry, read from Stellar ledger state.
- [Holdings](https://docs.lumeus.dev/assets-api/holdings.md): Every balance an address holds, with spendable amounts and the account's XLM reserve.
- [Token holders](https://docs.lumeus.dev/assets-api/holders.md): Ranked holders of a token, and one holder's balance and rank.
- [Token registry](https://docs.lumeus.dev/assets-api/registry.md): Search tokens and read one token's identity, metadata, supply and flags.
- [Accuracy and completeness](https://docs.lumeus.dev/assets-api/accuracy.md): How each balance is determined, and how to tell when a holdings answer is complete.
- [Claims, offers, allowances](https://docs.lumeus.dev/assets-api/account-state.md): Claimable balances, open DEX offers and token allowances of an address.
- [Historical snapshots](https://docs.lumeus.dev/assets-api/snapshots.md): Holdings and holders at a past ledger, from recent history or a snapshot job.
- [Your first webhook](https://docs.lumeus.dev/webhooks/quickstart.md): Run a receiver, expose it with a tunnel, subscribe to a Testnet account and see a verified event.
- [Webhooks overview](https://docs.lumeus.dev/webhooks/overview.md): Signed HTTPS pushes of decoded Stellar events, balance changes and test events.
- [Receive and verify](https://docs.lumeus.dev/webhooks/receive.md): Headers, signature checks, deduplication, retries and timeouts for webhook receivers.
- [Balance events](https://docs.lumeus.dev/webhooks/balance-events.md): Receive the new balance of a holder after every ledger that changes it.
- [Manage subscriptions](https://docs.lumeus.dev/webhooks/lifecycle.md): List, pause, resume, update, rotate the signing key of and delete webhook subscriptions.
- [Coverage and recovery](https://docs.lumeus.dev/webhooks/recovery.md): Find ledgers and deliveries an endpoint missed, then fill them from the Activity API.
- [Lumeus RPC](https://docs.lumeus.dev/rpc/overview.md): Standard Stellar JSON-RPC with an API key, metering and recent history.
- [Methods](https://docs.lumeus.dev/rpc/methods.md): The 12 supported methods, their parameters, limits and credits.
- [Stellar SDKs](https://docs.lumeus.dev/rpc/sdks.md): Use Lumeus RPC from the JavaScript, Python and Go Stellar SDKs.
- [Submit transactions](https://docs.lumeus.dev/rpc/transactions.md): A complete Testnet payment, from a new keypair to a confirmed result.
- [Errors and retries](https://docs.lumeus.dev/guides/errors.md): Error bodies, HTTP statuses, machine-readable codes and retry rules.
- [Rate limits](https://docs.lumeus.dev/guides/rate-limits.md): Request buckets per plan, RateLimit headers and Retry-After rules.
- [Health checks](https://docs.lumeus.dev/guides/readiness.md): Check service liveness and whether chain data is current.
- [Idempotency and recovery](https://docs.lumeus.dev/guides/idempotency.md): What Idempotency-Key does on each product, and how to recover a pending or lost result.
- [Recipes](https://docs.lumeus.dev/recipes/index.md): End-to-end tasks with Lumeus, each runnable in curl, JavaScript and Python.
- [Last payments of an account](https://docs.lumeus.dev/recipes/last-payments.md): List the 10 most recent payments an account sent or received, newest first.
- [Wallet portfolio](https://docs.lumeus.dev/recipes/wallet-portfolio.md): List every asset a wallet holds, with balances and what it can spend.
- [Top holders of a token](https://docs.lumeus.dev/recipes/top-holders.md): Rank the largest holders of an asset and their share of supply.
- [Sync history to a database](https://docs.lumeus.dev/recipes/sync-account.md): Copy an account's full history into your database, then keep it current. Safe to stop and resume.
- [Follow a contract's events](https://docs.lumeus.dev/recipes/watch-contract.md): Read a Soroban contract's events from a ledger onward, keep following new ones, and filter them by an address in a topic.
- [Airdrop holder snapshot](https://docs.lumeus.dev/recipes/airdrop-snapshot.md): List every holder of a token at a past ledger and compute each one's share for an airdrop.
- [Page through RPC events](https://docs.lumeus.dev/recipes/rpc-events.md): Read a contract's recent events with getEvents, page with the cursor, and keep up with new ledgers.
- [Alert on balance changes](https://docs.lumeus.dev/recipes/balance-alerts.md): Get a signed webhook with the new balance whenever a wallet's balance changes, and alert below a threshold.
- [Read account activity](https://docs.lumeus.dev/reference/activity/queries/read-account-activity.md): Returns the token movements (transfer, mint, burn, clawback) and fees in which an address takes part, newest first, over its full history. No ledger range is needed.
- [Read contract events naming an address](https://docs.lumeus.dev/reference/activity/queries/read-contract-events-naming-an-address.md): Returns the custom contract events (kind contract_event) whose topic 1, 2 or 3 is this address, newest first, from the contract-event topic index. It complements `GET /accounts/{id}/activity`, which returns the address's token movements and fees but not these events.
- [Read asset activity](https://docs.lumeus.dev/reference/activity/queries/read-asset-activity.md): Returns the token movements of one asset, newest first. Send `since_ledger` or a `cursor`.
- [Read contract activity](https://docs.lumeus.dev/reference/activity/queries/read-contract-activity.md): Returns the activity of one contract, newest first: the token movements it makes and the contract events it emits. Send `since_ledger` (the deployment ledger works) or a `cursor`.
- [Read transaction activity](https://docs.lumeus.dev/reference/activity/queries/read-transaction-activity.md): Returns the decoded events of one transaction in execution order (ascending). No ledger range is needed.
- [Read the activity feed](https://docs.lumeus.dev/reference/activity/queries/read-the-activity-feed.md): Returns the decoded activity of the whole network, newest first. Send `since_ledger` or a `cursor`. This is decoded activity, not a complete Horizon operations API.
- [Get transaction header](https://docs.lumeus.dev/reference/activity/queries/get-transaction-header.md): Returns the indexed header of one transaction: ledger, close time, success, fee charged, operation count and memo. For the envelope, result or meta XDR call RPC `getTransaction` (RPC keeps about 7 days); the decoded events are at `GET /transactions/{hash}/activity`.
- [Get Activity operation status](https://docs.lumeus.dev/reference/activity/results/get-activity-operation-status.md): Returns the state of a prepaid (funded) operation: the 202 answer a prepaid account gets for a long request. It does not run the request again or charge for it. Other accounts never receive an operation ID, so for them this route answers 404. Limited to 30 requests per minute per organization. [Idem…
- [Get Activity operation result](https://docs.lumeus.dev/reference/activity/results/get-activity-operation-result.md): Returns the saved response of a settled prepaid operation. Results are kept 24 hours, and each can be transferred three times in total, including the original response. While the operation is pending the answer is 202 with Retry-After 5; after expiry it is 410. [Idempotency and recovery](/guides/ide…
- [Check Activity liveness](https://docs.lumeus.dev/reference/activity/health/check-activity-liveness.md): Returns 200 while the Activity process is serving and its database answers. No authentication. It does not say whether the indexed data is current; use `GET /readyz` for that.
- [Check Activity readiness](https://docs.lumeus.dev/reference/activity/health/check-activity-readiness.md): Returns `{"ready":true}` when Activity is current with the network tip, else 503 with `{"ready":false}` and Retry-After 5. No authentication. The answer is cached for five seconds. It is not an uptime guarantee.
- [List holdings of an address](https://docs.lumeus.dev/reference/assets/holdings/list-holdings-of-an-address.md): Every balance the address holds: XLM, trustlines (including zero balances with include=zero), liquidity pool shares, and SAC and custom-token balances held in contract storage, live or archived. Sorted by asset. Each record says how it was determined (source, verified); the completeness block says w…
- [List claimable balances of an address](https://docs.lumeus.dev/reference/assets/account-state/list-claimable-balances-of-an-address.md): Claimable balances the address can claim (role=claimant, default) or sponsors (role=sponsor). claimable_now is evaluated at read_view.as_of_closed_at. Credit class assets-account: 1 × ceil(rows/100), at least one credit per started 64 KiB. Publishable keys allowed.
- [List open offers of an address](https://docs.lumeus.dev/reference/assets/account-state/list-open-offers-of-an-address.md): Open DEX offers where the address is the seller. Credit class assets-account: 1 × ceil(rows/100), at least one credit per started 64 KiB. Publishable keys allowed.
- [List token allowances of an address](https://docs.lumeus.dev/reference/assets/account-state/list-token-allowances-of-an-address.md): Live allowances the address granted (role=owner, default) or received (role=spender). Allowances are temporary entries: an absent or expired allowance is 0, and expired ones appear only with include=expired. Credit class assets-account: 1 × ceil(rows/100), at least one credit per started 64 KiB. Pub…
- [Search the token registry](https://docs.lumeus.dev/reference/assets/tokens/search-the-token-registry.md): Tokens known on this network, sorted by holder_count descending. Identity is the asset ID: tokens are never merged by symbol. Credit class assets-registry: 1 × ceil(rows/100), at least one credit per started 64 KiB. Publishable keys allowed.
- [Get a token registry record](https://docs.lumeus.dev/reference/assets/tokens/get-a-token-registry-record.md): Identity, SAC mapping, metadata (name, symbol, decimals, home_domain, stellar.toml), flags, holder_count, supply and supply_source. Credit class assets-registry: 1 × ceil(rows/100), at least one credit per started 64 KiB. Publishable keys allowed.
- [List ranked holders of a token](https://docs.lumeus.dev/reference/assets/tokens/list-ranked-holders-of-a-token.md): Holders ranked by balance descending, then holder ascending. For a classic asset this is one merged list of trustline and SAC contract holders. Zero balances only with include=zero. Deep pages are cursor-only. With as_of_ledger the holders are read at a past ledger from the balance history (credit c…
- [Get one holder and its rank](https://docs.lumeus.dev/reference/assets/tokens/get-one-holder-and-its-rank.md): One holder's balance and rank. The rank is exact when holder_count is at most 100,000; above that it comes from a periodic refresh and rank_as_of says which ledger. Credit class assets-holder: 2 × ceil(rows/100), at least one credit per started 64 KiB. While a large asset's rank is first computed th…
- [Start a snapshot job](https://docs.lumeus.dev/reference/assets/snapshots/start-a-snapshot-job.md): Starts a job that computes an address's holdings or an asset's holders at any past ledger from 63 on, including before bootstrap_ledger, from a history-archive checkpoint plus at most 63 replayed ledgers. Use it when an as_of_ledger read answers 409. The job runs in the background: poll `GET /snapsh…
- [Get a snapshot job](https://docs.lumeus.dev/reference/assets/snapshots/get-a-snapshot-job.md): Returns a snapshot job: its status and, once completed, its result as a flat list of balances at the requested ledger. Jobs belong to the organization that started them. Not charged.
- [Check Assets liveness](https://docs.lumeus.dev/reference/assets/health/check-assets-liveness.md): Returns 200 while the Assets process is serving and its database answers. No authentication. It does not say whether the indexed data is current; use `GET /readyz` for that.
- [Check Assets readiness](https://docs.lumeus.dev/reference/assets/health/check-assets-readiness.md): Returns `{"ready":true}` while the state index is within 60 ledgers of the network tip, else 503 with `{"ready":false}` and Retry-After 5 (also while it is still bootstrapping). Data routes answer 503 with Retry-After in that state. No authentication.
- [Create a subscription](https://docs.lumeus.dev/reference/webhooks/subscriptions/create-a-subscription.md): Creates a webhook endpoint that receives a signed POST for every event its filters match, and returns it with its `hmac_secret`. Save the secret: only this response shows it, and you need it to verify signatures. The endpoint is active at once and receives events from the ledger after `activation_ch…
- [List subscriptions](https://docs.lumeus.dev/reference/webhooks/subscriptions/list-subscriptions.md): Returns the organization's webhook endpoints on this network, newest first. Deleted endpoints are left out unless include_deleted=true.
- [Get a subscription](https://docs.lumeus.dev/reference/webhooks/subscriptions/get-a-subscription.md): Returns one endpoint with its filters, state and checkpoints. The ETag header carries its version: send it as If-Match on every change. Free endpoints include today's free_quota; paid endpoints include paid (plan, endpoint limit and credits per delivery). A deleted endpoint still answers 200 with ef…
- [Update a subscription](https://docs.lumeus.dev/reference/webhooks/subscriptions/update-a-subscription.md): Changes an endpoint's name, target URL or filters, or pauses (state paused) or resumes (state active) it. Any other state answers 400 with the message `state must be active or paused; to delete an endpoint use DELETE /v1/subscriptions/{id}`. Send the current ETag as If-Match. Events matched while th…
- [Delete a subscription](https://docs.lumeus.dev/reference/webhooks/subscriptions/delete-a-subscription.md): Deletes an endpoint: deliveries stop and its signing secret and test history are deleted. Send the current ETag as If-Match. A request already in flight may still finish; inspect in_flight_attempts. Resending the same Idempotency-Key returns the first result.
- [Get coverage gaps](https://docs.lumeus.dev/reference/webhooks/deliveries/get-coverage-gaps.md): Returns the ledger ranges whose matching events were not delivered to this endpoint, with the reason for each gap (for example paused_by_user or free_quota_exhausted), and the ledger before which you read history from the Activity API instead.
- [List recent deliveries](https://docs.lumeus.dev/reference/webhooks/deliveries/list-recent-deliveries.md): Returns the endpoint's deliveries, newest first: status, attempts, response code, last error and credits. Payloads and signing secrets are never returned.
- [Send a test event](https://docs.lumeus.dev/reference/webhooks/deliveries/send-a-test-event.md): Sends one signed synthetic webhook.test event to an active or paused endpoint and returns the outcome. The body has test: true and the signed context has lane test. Tests never enter delivery history, billing or replay. Limited to 12 tests per organization per hour. Deleting the endpoint deletes its…
- [Get a test delivery](https://docs.lumeus.dev/reference/webhooks/deliveries/get-a-test-delivery.md): Returns the outcome of one test delivery. A started test older than 15 seconds is reported as uncertain; to send again, use a new Idempotency-Key.
- [Quote a redelivery](https://docs.lumeus.dev/reference/webhooks/replay/quote-a-redelivery.md): Prices a redelivery of past deliveries (by delivery ID) whose payloads are still retained. A quote reserves nothing; start the work with the returned quote_sha256. Use the endpoint's current version (If-Match) and generation. Expired payloads and unsupported ranges are refused. Free Testnet endpoint…
- [Start a redelivery](https://docs.lumeus.dev/reference/webhooks/replay/start-a-redelivery.md): Starts the redelivery priced by a quote and returns its job. Replays use their own delivery lane, so live deliveries continue. Free Testnet endpoints answer 403 "free Testnet webhooks do not support replay"; paid plan endpoints answer 403 "replays are not yet available for paid webhook endpoints".
- [Quote a source replay](https://docs.lumeus.dev/reference/webhooks/replay/quote-a-source-replay.md): Prices a replay of up to 64 consecutive ledgers read again from the RPC history. A quote reserves nothing; start the work with the returned quote_sha256. Use the endpoint's current version (If-Match) and generation. Expired payloads and unsupported ranges are refused. Free Testnet endpoints answer 4…
- [Start a source replay](https://docs.lumeus.dev/reference/webhooks/replay/start-a-source-replay.md): Starts the source replay priced by a quote and returns its job. Replays use their own delivery lane, so live deliveries continue. A source replay reads only the RPC history (about 7 days), not the full Activity index. Free Testnet endpoints answer 403 "free Testnet webhooks do not support replay"; p…
- [Get replay progress](https://docs.lumeus.dev/reference/webhooks/replay/get-replay-progress.md): Returns a redelivery or source replay job with its pending, delivered, dead and in-flight counts.
- [Cancel a replay](https://docs.lumeus.dev/reference/webhooks/replay/cancel-a-replay.md): Cancels the pending deliveries of a replay job. A request already in flight cannot be recalled; inspect in_flight. Repeating the call is safe.
- [Rotate the signing key](https://docs.lumeus.dev/reference/webhooks/signing-keys/rotate-the-signing-key.md): Creates a new whsec_ signing secret and returns it once. For 24 hours both keys sign: X-Webhook-Signature uses the old key and X-Webhook-Next-Signature the new one, so you can deploy the new secret without dropping deliveries. A second rotation during the overlap returns 409.
- [Revoke the previous signing key](https://docs.lumeus.dev/reference/webhooks/signing-keys/revoke-the-previous-signing-key.md): Ends the 24-hour overlap of a rotation early, so only the new key signs. Deploy the new secret to your receiver first.
- [Create a webhook key](https://docs.lumeus.dev/reference/webhooks/webhook-keys/create-a-webhook-key.md): Creates a whk_ key that manages webhook endpoints on this network. The plaintext secret is returned once. An organization holds at most 20 active (unrevoked, unexpired) webhook keys per network; creating another returns 409.
- [List webhook keys](https://docs.lumeus.dev/reference/webhooks/webhook-keys/list-webhook-keys.md): Returns the webhook keys of the organization on this network, with prefixes and metadata only; secrets are never returned again.
- [Revoke a webhook key](https://docs.lumeus.dev/reference/webhooks/webhook-keys/revoke-a-webhook-key.md): Revokes a webhook key at once. A revoked or unknown key answers 404; an ID that is not a UUID answers 400 "key id must be a UUID".
- [Check Webhooks liveness](https://docs.lumeus.dev/reference/webhooks/health/check-webhooks-liveness.md): Returns 200 while the Webhooks process is serving and its database answers. No authentication. It does not say whether the indexed data is current; use `GET /readyz` for that.
- [Check Webhooks readiness](https://docs.lumeus.dev/reference/webhooks/health/check-webhooks-readiness.md): Returns `{"ready":true}` when Webhooks is current with the network tip, else 503 with `{"ready":false}` and Retry-After 5. No authentication. The answer is cached for five seconds. It is not an uptime guarantee.
- [Call Stellar RPC](https://docs.lumeus.dev/reference/rpc/json-rpc/call-stellar-rpc.md): The generic JSON-RPC endpoint: every Stellar RPC method is a `POST /` with a JSON-RPC 2.0 body, one call or a batch of up to 20. Each method has its own page with its parameters, result fields, credits and a real response, and its own Try it: [getHealth](/api/rpc/getHealth), [getNetwork](/api/rpc/ge…
- [Get RPC operation status](https://docs.lumeus.dev/reference/rpc/results/get-rpc-operation-status.md): Returns the state of a prepaid (funded) operation: the 202 answer a prepaid account gets for a long request. It does not run the request again or charge for it. Other accounts never receive an operation ID, so for them this route answers 404. Limited to 30 requests per minute per organization. [Idem…
- [Get RPC operation result](https://docs.lumeus.dev/reference/rpc/results/get-rpc-operation-result.md): Returns the saved response of a settled prepaid operation. Results are kept 24 hours, and each can be transferred three times in total, including the original response. While the operation is pending the answer is 202 with Retry-After 5; after expiry it is 410. [Idempotency and recovery](/guides/ide…
- [getHealth](https://docs.lumeus.dev/api/rpc/getHealth.md): Check the node status and which ledgers you can read.
- [getNetwork](https://docs.lumeus.dev/api/rpc/getNetwork.md): Get the network passphrase and protocol version.
- [getVersionInfo](https://docs.lumeus.dev/api/rpc/getVersionInfo.md): Get the stellar-rpc and Stellar Core versions.
- [getLatestLedger](https://docs.lumeus.dev/api/rpc/getLatestLedger.md): Get the latest closed ledger, with its header and metadata XDR.
- [getFeeStats](https://docs.lumeus.dev/api/rpc/getFeeStats.md): Get recent inclusion fee percentiles.
- [getLedgers](https://docs.lumeus.dev/api/rpc/getLedgers.md): Read ledgers with their header and metadata XDR.
- [getLedgerEntries](https://docs.lumeus.dev/api/rpc/getLedgerEntries.md): Read the current value of ledger entries by key.
- [getTransaction](https://docs.lumeus.dev/api/rpc/getTransaction.md): Get one transaction by hash.
- [getTransactions](https://docs.lumeus.dev/api/rpc/getTransactions.md): Read transactions in ledger order.
- [getEvents](https://docs.lumeus.dev/api/rpc/getEvents.md): Read contract and system events, filtered by contract and topic.
- [simulateTransaction](https://docs.lumeus.dev/api/rpc/simulateTransaction.md): Run a Soroban transaction without submitting it.
- [sendTransaction](https://docs.lumeus.dev/api/rpc/sendTransaction.md): Submit a signed transaction.
- [Check RPC liveness](https://docs.lumeus.dev/reference/rpc/health/check-rpc-liveness.md): Returns 200 while the RPC process is serving and its database answers. No authentication. It does not say whether the indexed data is current; use `GET /readyz` for that.
- [Check RPC readiness](https://docs.lumeus.dev/reference/rpc/health/check-rpc-readiness.md): Returns `{"ready":true}` when RPC is current with the network tip, else 503 with `{"ready":false}` and Retry-After 5. No authentication. The answer is cached for five seconds. It is not an uptime guarantee.
- [Get your workspace](https://docs.lumeus.dev/reference/account/workspace/get-your-workspace.md): Returns the workspace (organization) the key or session belongs to: its name and plan, the current billing period and its Mainnet credit usage, today's free Testnet requests (`testnet`), and the API base URLs. A verified dashboard session creates its workspace on first use. Served by the Activity ho…
- [Rename your workspace](https://docs.lumeus.dev/reference/account/workspace/rename-your-workspace.md): Renames the workspace. The name is 1 to 100 characters. Served by the Activity host for all products. Read-only and publishable keys get 403.
- [Issue the starter Testnet key](https://docs.lumeus.dev/reference/account/api-keys/issue-the-starter-testnet-key.md): Issues one Testnet key per workspace and returns its api_key once (201). Later calls return 200 with issued false and no key, so a client can call it safely on every first visit. Served by the Activity host for all products. Read-only and publishable keys get 403.
- [Create an API key](https://docs.lumeus.dev/reference/account/api-keys/create-an-api-key.md): Creates a lum_ key in your workspace. The key works on the Activity API, the Assets API and RPC of its network. The plaintext api_key is returned once: store it in a secret manager. allowed_origins is required for, and the policy fields are accepted only with, access publishable. Served by the Activ…
- [List API keys](https://docs.lumeus.dev/reference/account/api-keys/list-api-keys.md): Returns every key of the workspace, including revoked and expired ones, with prefixes and metadata only; plaintext keys are never returned again. Served by the Activity host for all products. Read-only and publishable keys get 403.
- [Update an API key](https://docs.lumeus.dev/reference/account/api-keys/update-an-api-key.md): Renames a key and, for a publishable key, replaces its allowed origins and limits. Omitted fields are unchanged; policy fields on a full or read key return 400. Served by the Activity host for all products. Read-only and publishable keys get 403.
- [Rotate an API key](https://docs.lumeus.dev/reference/account/api-keys/rotate-an-api-key.md): Creates a replacement key with the same name, network and access and returns its api_key once. The old key keeps working until previous.expires_at, then stops. A key can be rotated once; a revoked, expired or already rotating key returns 409. Served by the Activity host for all products. Read-only a…
- [Revoke an API key](https://docs.lumeus.dev/reference/account/api-keys/revoke-an-api-key.md): Revokes a key at once. The host that revoked it refuses the key immediately, and every Activity, Assets and RPC host within 2 seconds (authentication is cached for at most 2 seconds). Revoking the old key of a rotation ends its overlap window early. An unknown or malformed ID answers 404. Served by…
- [Get usage](https://docs.lumeus.dev/reference/account/usage/get-usage.md): Returns the Mainnet credits used in the current billing period with the plan allowance and hard cap, the requests on both networks, and the `testnet` block: today's free Testnet requests against the daily cap. Served by the Activity host for all products. Read-only and publishable keys get 403.
- [List API key requests](https://docs.lumeus.dev/reference/account/usage/list-api-key-requests.md): Returns the requests made with this workspace's API keys during the last 24 hours, newest first: route template or JSON-RPC method, status, duration and request ID. Query strings, bodies and addresses are never stored. Signed-in dashboard calls are not included. Recording is best effort and can drop…
- [Break down usage](https://docs.lumeus.dev/reference/account/usage/break-down-usage.md): Returns the current period's credits and requests split by network, by API key, by endpoint and by route or RPC method. Served by the Activity host for all products. Read-only and publishable keys get 403.
- [Get usage over time](https://docs.lumeus.dev/reference/account/usage/get-usage-over-time.md): Returns credits and requests per day or per hour, for charts. Served by the Activity host for all products. Read-only and publishable keys get 403.
- [Get the plan catalog](https://docs.lumeus.dev/reference/account/billing/get-the-plan-catalog.md): Returns the current public plan catalog: prices, included (Mainnet) credits, the daily free Testnet request cap, rate limits, page sizes, RPC method credits, webhook endpoint caps and the credit weight of every route class. No authentication. catalog_state is self_serve when plans with subscribable…
- [Get payment status](https://docs.lumeus.dev/reference/account/billing/get-payment-status.md): Returns the payment state of the workspace as the billing system sees it. A Checkout redirect alone does not prove payment: read this route or `GET /v1/me` for the applied plan. Served by the Activity host for all products. Read-only and publishable keys get 403.
- [Start a plan subscription](https://docs.lumeus.dev/reference/account/billing/start-a-plan-subscription.md): Returns a Stripe Checkout URL that subscribes the workspace to Starter, Growth or Scale. One paid subscription per workspace: a new checkout expires the previous unpaid session, so only the newest one can be paid. USD only. The plan changes when Stripe reports the subscription active, not on the red…
- [Change the subscription plan](https://docs.lumeus.dev/reference/account/billing/change-the-subscription-plan.md): Moves the current subscription to another self-serve plan (upgrade or downgrade). Prorations are invoiced at once; an upgrade whose proration payment fails is not applied. 409 when the workspace has no subscription. Served by the Activity host for all products. Read-only and publishable keys get 403…
- [Open the billing portal](https://docs.lumeus.dev/reference/account/billing/open-the-billing-portal.md): Returns a Stripe billing portal URL where the workspace owner manages the subscription, payment method and invoices. Requires a workspace that has a Stripe customer. Served by the Activity host for all products. Read-only and publishable keys get 403.
- [Prepare a prepaid purchase](https://docs.lumeus.dev/reference/account/billing/prepare-a-prepaid-purchase.md): Prepares a purchase of a prepaid offer selected for your workspace by Lumeus. Plans are bought with `POST /billing/checkout` instead. Keep one Idempotency-Key per purchase across retries. Never treat the browser redirect as proof of payment. Served by the Activity host for all products. Read-only an…
- [Get a purchase](https://docs.lumeus.dev/reference/account/billing/get-a-purchase.md): Returns a purchase prepared with `POST /billing/purchases`, to recover its checkout_url or state. Served by the Activity host for all products. Read-only and publishable keys get 403.
- [Retired top-up route](https://docs.lumeus.dev/reference/account/retired/retired-top-up-route.md): Retired. Every authenticated call answers 409 and creates no sale. Buy a plan with `POST /billing/checkout`.
- [Lumeus for agents](https://docs.lumeus.dev/agents/overview.md): Give your coding agent the Lumeus skill, the docs and a Testnet key.

## OpenAPI Specs

- [activity](/api-reference/activity.json)
- [assets](/api-reference/assets.json)
- [rpc](/api-reference/rpc.json)
- [getEvents](/api-reference/rpc/getEvents.json)
- [getFeeStats](/api-reference/rpc/getFeeStats.json)
- [getHealth](/api-reference/rpc/getHealth.json)
- [getLatestLedger](/api-reference/rpc/getLatestLedger.json)
- [getLedgerEntries](/api-reference/rpc/getLedgerEntries.json)
- [getLedgers](/api-reference/rpc/getLedgers.json)
- [getNetwork](/api-reference/rpc/getNetwork.json)
- [getTransaction](/api-reference/rpc/getTransaction.json)
- [getTransactions](/api-reference/rpc/getTransactions.json)
- [getVersionInfo](/api-reference/rpc/getVersionInfo.json)
- [sendTransaction](/api-reference/rpc/sendTransaction.json)
- [simulateTransaction](/api-reference/rpc/simulateTransaction.json)
- [webhooks](/api-reference/webhooks.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.