Skip to main content

Retrieve Related Transactions {Claimable Balance} REST API Endpoint

Retrieves transactions related to a specific claimable balance in the network

Updated on
Nov 26, 2024
Please note that this method 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.

Path Parameters

claimable_balance_id
string
REQUIRED

A unique identifier for this claimable balance

Query Parameters

cursor
integer

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

order
string

The designation of the order of the records. It can be ascending or descending. By default it is set to ascending

limit
integer

The maximum number of records returned

include_failed
boolean

If true, it includes failed operations in results

Returns

_links
object

The link object which provides links to various related resources

self
object

The self link object which contains the following field:

href
string

A link that points to the current page of liquidity_pools

templated
boolean

A boolean value that indicates whether the link is templated or not

next
object

The next link object which contains the following field:

href
string

A link to the next page of claimable balance, allowing for pagination

templated
boolean

A boolean value that indicates whether the link is templated or not

prev
object

The prev link object which contains the following field:

href
string

A link to the previous page of claimable balance, enabling navigation backward

templated
boolean

A boolean value that indicates whether the link is templated or not

_embedded
object

Embedded object which contains the following fields:

records
array

An array of claimable balance records, each representing a specific transaction

memo
string

A message associated with the transaction

_links
object

An object with the following fields:

self
object

The self link object which contains the following fields:

href
string

The URL of the retrieved transaction

templated
boolean

If set to true indicates that this URL is a template and can be expanded by replacing the placeholders with actual values

account
object

The account link object which contains the following fields:

href
string

The URL of the retrieved account

templated
boolean

If set to true indicates that this URL is a template and can be expanded by replacing the placeholders with actual values

ledger
object

The ledger link object which contains the following fields:

href
string

The URL of the retrieved ledger

templated
boolean

If set to true indicates that this URL is a template and can be expanded by replacing the placeholders with actual values

operations
object

The operations link object which contains the following fields:

href
string

The URL of the retrieved operations

templated
boolean

If set to true indicates that this URL is a template and can be expanded by replacing the placeholders with actual values

effects
object

The effects link object which contains the following fields:

href
string

The URL of the retrieved effects

templated
boolean

If set to true indicates that this URL is a template and can be expanded by replacing the placeholders with actual values

precedes
object

The precedes link object which contains the following fields:

href
string

The URL of the retrieved precedes

templated
boolean

If set to true indicates that this URL is a template and can be expanded by replacing the placeholders with actual values

succeeds
object

The succeeds link object which contains the following fields:

href
string

The URL of the retrieved succeeds

templated
boolean

If set to true indicates that this URL is a template and can be expanded by replacing the placeholders with actual values

transaction
object

The transaction link object which contains the following fields:

href
string

The URL of the retrieved transaction

templated
boolean

If set to true indicates that this URL is a template and can be expanded by replacing the placeholders with actual values

id
string

The unique identifier for the transaction record

paging_token
string

The paging token for the transaction record

successful
boolean

A boolean indicating whether the transaction was successful

hash
string

The hash of the transaction

ledger
integer

The sequence number of the ledger in which the transaction was included

created_at
string

The timestamp indicating when the transaction was created

source_account
string

The source account that initiated the transaction. Value must match regular expression G[A-Z0-9]{55}

account_muxed
string

The muxed account associated with the transaction

account_muxed_id
string

The muxed account ID

source_account_sequence
string

The sequence number of the source account

fee_account
string

The account that paid the transaction fee

fee_account_muxed
string

The muxed account that paid the fee

fee_account_muxed_id
string

The ID of the muxed fee account

fee_charged
string

The fee charged for the transaction

max_fee
string

The maximum fee allowed for the transaction

operation_count
integer

The number of operations in the transaction

envelope_xdr
string

The envelope XDR of the transaction

result_xdr
string

The result XDR of the transaction

result_meta_xdr
string

The result meta XDR of the transaction

fee_meta_xdr
string

The fee meta XDR of the transaction

memo_type
string

The type of memo used in the transaction

signatures
string

The signatures associated with the transaction

valid_after
string

The timestamp indicating when the transaction is valid after

valid_before
string

The timestamp indicating when the transaction is valid before

preconditions
object

The preconditions for the transaction

timebounds
object

The timebound constraints for the transaction

min_time
string

The minimum timebound

max_time
string

The maximum timebound

ledgerbounds
object

The ledgerbound constraints for the transaction

min_time
string

The minimum ledgerbound

max_time
string

The maximum timebound

min_account_sequence
string

The minimum account sequence for the transaction

min_account_sequence_age
string

The minimum account sequence age for the transaction

min_account_sequence_ledger_gap
integer

The minimum account sequence ledger gap

extra_signers
string

The extra signers for the transaction

fee_bump_transaction
object

The fee bump transaction associated with the transaction

hash
string

The hash of the fee bump transaction

signatures
string

The signatures associated with the fee bump transaction

inner_transaction
object

The inner transaction associated with the transaction

hash
string

The hash of the inner transaction

signatures
string

The signatures associated with the inner transaction

max_fee
string

The maximum fee for the inner transaction

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free