Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <key>. Testnet: lum_test_…; Mainnet: lum_live_…. A key works only on its own network, so pick the server that matches it (the other network answers 401). Publishable lum_pub_… keys call the GET data routes only, from an allowed browser origin. Webhook keys (whk_…) are not accepted here.

Headers

Idempotency-Key
string

Optional; reads do not need it. When sent it must be 8 to 128 printable ASCII characters (0x21-0x7E: no spaces or control characters) in one header, otherwise 400. Prepaid accounts use it to recover a read without paying again; for every other account a valid key is accepted and has no effect.

Required string length: 8 - 128
Pattern: ^[\x21-\x7E]{8,128}$

Path Parameters

id
string
required

Stellar address: a G account, M muxed account, C contract, B claimable balance or L liquidity pool StrKey. It must be checksum-valid.

Required string length: 56 - 69
Example:

"GAIH3ULLFQ4DGSECF2AR555KZ4KNDGEKN4AFI4SU2M7B43MGK3QJZNSR"

Query Parameters

name
string

Exact event name: the payload type (the first topic symbol).

Required string length: 1 - 64
contract
string

Only events emitted by this C contract address.

Pattern: ^C[A-Z2-7]{55}$
Example:

"CDLZFC3SYJYDZT7K67VZ75HPJVIEUVNIXF47ZG2FB2RMQQVU2HHGCYSC"

position
integer

Only events with the address at this topic position (1, 2 or 3).

Required range: 1 <= x <= 3
Example:

2

order
enum<string>

Sort by ledger: desc (newest first) or asc. The route description gives the default.

Available options:
asc,
desc
Example:

"desc"

limit
integer
default:10

Records per page. Larger values are clamped to max_page_size from GET /v1/plans (200), or account_max_page_size (1000) on account activity and both topic routes; the page reports the effective value as limit.

Required range: x >= 1
Example:

10

cursor
string

Resume after this paging_token. Prefer following _links.next.href, which carries the cursor and the snapshot for you.

since_ledger
integer

First ledger of the range, inclusive. Without until_ledger the range runs to the published tip (read_view.snapshot_ledger). A value past the tip returns an empty, complete page whose scanned_through_ledger is the tip.

Required range: x >= 0
Example:

5300000

until_ledger
integer

End of the range, exclusive. Requires since_ledger and must be greater than it. There is no maximum range width.

Required range: x >= 1
generation
string

Index generation from read_view.generation. Send it together with snapshot_ledger to keep a walk on one snapshot; server links already include both.

snapshot_ledger
integer

Read at this published snapshot (read_view.snapshot_ledger of an earlier page). Requires generation. Below read_view.first_ledger it answers 400; above the published tip, 503 index_not_ready.

Required range: 1 <= x <= 2147483647

Response

A page of contract events read from one published snapshot.

read_view
object
required
range_complete
boolean
required

True when no matching record remains after this page in the requested range (until_ledger, else the snapshot). An exactly full final page is already complete. Follow _links.next only while this is false.

limit
integer
required

Effective page size after clamping to the plan maximum: max_page_size, or account_max_page_size for account activity.

_embedded
object
required
scanned_through_ledger
integer

Last ledger of the range whose matching records this walk has delivered. On every complete page, in both orders, it is the last ledger of the effective range: until_ledger - 1, or snapshot_ledger when until_ledger is absent or later; for a descending walk that holds only if the walk started at the top of its range. On an ascending page stopped early by the scan budget it is the last fully scanned ledger. When since_ledger is beyond snapshot_ledger (past the published tip) the page is empty and complete, has no next link, and reports snapshot_ledger, in both orders, so a sync loop can checkpoint it. Absent on other incomplete pages and on an empty range that ends before first_ledger.