Retrieve Related Operations
This endpoint represents successful operations referencing a given claimable balance and 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. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.
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 and is pulled from the paging_token value of a record.
- order string
Possible values: [
asc
,desc
]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.
- limit integer
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_failed boolean
Possible values: [
true
,false
]Set to true to include failed operations in results. Options include true and false.
- join
Set to transactions to include the transactions which created each of the operations in the response.
- 200
Success
- application/json
- Schema
- Example (from schema)
- CBRetrieveRelatedOperations
Schema
_links object
self object
href linktemplated booleannext object
href linktemplated booleanprev object
href linktemplated boolean
{
"_links": {
"self": {
"href": "string",
"templated": true
},
"next": {
"href": "string",
"templated": true
},
"prev": {
"href": "string",
"templated": true
},
"transaction": {
"href": "string",
"templated": true
},
"effects": {
"href": "string",
"templated": true
},
"succeeds": {
"href": "string",
"templated": true
},
"precedes": {
"href": "string",
"templated": true
}
},
"id": "string",
"paging_token": "string",
"transaction_successful": true,
"source_account": "string",
"type": "create_account",
"type_i": 0,
"created_at": "string",
"transaction_hash": "string",
"starting_balance": "string",
"funder": "string",
"account": "string"
}
{
"_links": {
"self": {
"href": "https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=&limit=3&order=asc"
},
"next": {
"href": "https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=140648659841806337&limit=3&order=asc"
},
"prev": {
"href": "https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=140648659841806337&limit=3&order=desc"
}
},
"_embedded": {
"records": [
{
"_links": {
"self": {
"href": "https://horizon.stellar.org/operations/140648659841806337"
},
"transaction": {
"href": "https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8"
},
"effects": {
"href": "https://horizon.stellar.org/operations/140648659841806337/effects"
},
"succeeds": {
"href": "https://horizon.stellar.org/effects?order=desc&cursor=140648659841806337"
},
"precedes": {
"href": "https://horizon.stellar.org/effects?order=asc&cursor=140648659841806337"
}
},
"id": "140648659841806337",
"paging_token": "140648659841806337",
"transaction_successful": true,
"source_account": "GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF",
"type": "create_claimable_balance",
"type_i": 14,
"created_at": "2020-11-23T16:02:38Z",
"transaction_hash": "fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8",
"sponsor": "GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF",
"asset": "BODHI:GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF",
"amount": "0.1000000",
"claimants": [
{
"destination": "GBEUDKANIFPTFHPWJ5T3R6RIO36RQBFGHYPAQ6STH7KMNDHAT36LHOLD",
"predicate": {
"unconditional": true
}
}
]
}
]
}
}