Retrieve a Claimable Balance

The single claimable balance endpoint provides information on a claimable balance.

This method will use 20 Compute Units.

---

Reference: Here

Retrieve a Claimable Balance

The single claimable balance endpoint provides information on a claimable balance.

GEThttps://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>/claimable_balances/{claimable_balance_id}

Path parameters

claimable_balance_id*string

A unique identifier for this claimable balance.

Response

200

Success

Body

application/json

_linksobject

id*id (string)

asset*string

amount*string

sponsorstring

last_modified_ledger*string

last_modified_time*string

claimantsarray of object

flagsinteger

paging_token*string

Request

JavaScriptCurlPython

const response = await fetch('https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>/claimable_balances/{claimable_balance_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "_links": {
    "self": {
      "href": "text",
      "templated": false
    },
    "operations": {
      "href": "text",
      "templated": false
    },
    "transactions": {
      "href": "text",
      "templated": false
    }
  },
  "id": "text",
  "asset": "text",
  "amount": "text",
  "sponsor": "text",
  "last_modified_ledger": "text",
  "last_modified_time": "text",
  "claimants": [
    {
      "destination": "text",
      "predicate": {
        "and": [
          {
            "or": [
              {
                "relBefore": "text",
                "absBefore": "text",
                "absBeforeEpoch": "text"
              }
            ],
            "not": {
              "unconditional": false,
              "relBefore": "text",
              "absBefore": "text",
              "absBeforeEpoch": "text"
            }
          }
        ]
      }
    }
  ],
  "flags": 0,
  "paging_token": "text"
}