List All Claimable Balances REST API Endpoint
Query Parameters
sponsor
string
Account ID of the sponsor
asset
string
An asset type associated with the accounts
claimant
string
Account ID of the destination address
cursor
string
A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record
order
string
The order of the returned data. The possible value includes ascending and descending order
limit
integer
The maximum number of records returned
Returns
_links
object
Links related to the claimable balance
self
object
Link to the claimable balance itself
href
string
The URL of the claimable balance
templated
boolean
A boolean value that indicates whether the link is templated or not
transactions
object
Link to the transactions related to the claimable balance
href
string
The URL template for transactions related to the claimable balance
templated
boolean
A boolean value that indicates whether the link is templated or not
operations
object
Link to the operations related to the claimable balance
href
string
The URL template for operations related to the claimable balance
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 claimable balance ID
paging_token
string
The paging token for the offer record, aiding in navigation
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
last_modified_ledger
string
Ledger sequence number of the last modification
last_modified_time
string
Timestamp of the last modification
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
1curl -L -X GET 'https://docs-demo.stellar-mainnet.quiknode.pro/claimable_balances' \2-H 'Accept: application/json'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free