Skip to content

Please submit any typos you come across to GitHub issues.


Retrieve related Transactions

This endpoint represents successful transactions referencing a given claimable balance and can be used in streaming mode.

Streaming mode allows you to listen for new transactions referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.

GET/claimable_balances/:claimable_balance_id/transactions?cursor={paging_token}&order={asc,desc}&limit={1-200}&include_failed{true,false}
  • ARGUMENTREQUIRED

    DESCRIPTION

  • claimable_balance_idrequired

    This claimable balance’s id encoded in a hex string representation.

  • cursoroptional

    A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.

  • orderoptional

    A designation of the order in which records should appear. Options include asc(ascending) or desc (descending). If this argument isn’t set, it defaults to asc.

  • limitoptional

    The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.

  • include_failedoptional

    Set to true to include failed transactions in results. If this argument isn’t set, it defaults to false.