Skip to main content

Retrieve Related Operations {Claimable Balance} REST API Endpoint

Retrieve operations related to a specific claimable balance on 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 operations 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

join
string

It includes the transactions which created each of the operations in the response

Returns

_links
object

The links related to the account data

self
object

The self-reference link

href
string

The URL for self-reference

templated
boolean

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

next
object

The link to the next set of data

href
string

The URL for next set of data

templated
boolean

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

prev
object

The link to the previous set of data

href
string

The URL for previous set of data

templated
boolean

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

_embedded
object

An object with the following values:

records
array

An array of account records

_links
object

The links related to the account record

self
object

The self-reference link

href
string

The URL for self-reference

templated
boolean

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

transactions
object

Link to transactions related to the account

href
string

The URL for transactions related to the account

templated
boolean

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

operations
object

Link to operations related to the account

href
string

The URL for operations related to the account

templated
boolean

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

id
string

The operation ID

paging_token
string

The paging token for the offer record, aiding in navigation

transaction_successful
string

A boolean value that indicates whether the transaction is successful or not

source_account
string

The source account that initiated the operation

type
string

The type of operation

type_i
integer

The numeric code representing the operation type

created_at
string

The timestamp indicating when the operation was created

transaction_hash
string

The hash of the transaction containing the operation

asset
string

The type of asset in the claimable balance

amount
string

The amount of the asset that can be claimed

sponsor
string

The account id of the sponsor who is paying the reserves for this claimable balance

claimants
array

The list of claimants for the claimable balance

destination
string

The account ID who can claim the balance

predicate
object

The condition which must be satisfied so destination can claim the balance

and
array

Array of AND conditions

abs_before
string

Absolute time before which the claimant can claim

abs_before_epoch
string

Epoch time before which the claimant can claim

not
object

Negation of a condition

abs_before
string

Absolute time before which the claimant cannot claim

abs_before_epoch
string

Epoch time before which the claimant cannot claim

unconditional
boolean

Unconditional claim

flags
object

The flags related to the claimable balance

clawback_enabled
boolean

Clawback enabled flag

paging_token
string

Paging token of the claimable balance

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