Skip to main content

List All Claimable Balances

This endpoint lists all available claimable balances.

Query Parameters
  • sponser string

    Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.

  • asset any

    An issued asset represented as “Code:IssuerAccountID”. Every account in the response will have a trustline for the given asset.

  • claimant any

    Account ID of the destination address. Only include claimable balances which can be claimed by the given account ID.

  • 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.

Responses

Success


Schema
  • _links object
  • self object
  • href link required
  • templated boolean
  • next object
  • href link required
  • templated boolean
  • prev object
  • href link required
  • templated boolean
  • _embedded object
  • records object[]
  • Array [
  • _links object
  • self object required
  • href link required
  • templated boolean
  • operations object required
  • href link required
  • templated boolean
  • transactions object required
  • href link required
  • templated boolean
  • id id required
  • paging_token string required
  • asset string required
  • amount string required
  • sponsor string
  • last_modified_ledger string required
  • last_modified_time string required
  • claimants object[]
  • Array [
  • destination address

    Possible values: Value must match regular expression G[A-Z0-9]{55}

  • predicate object
  • and object[]
  • Array [
  • or object[]
  • Array [
  • relBefore string
  • absBefore string
  • absBeforeEpoch string
  • ]
  • not object
  • unconditional boolean
  • relBefore string
  • absBefore string
  • absBeforeEpoch string
  • ]
  • ]
  • flags integer
  • ]
Loading...