Skip to main content

Retrieve Related Transactions

GET 

/claimable_balances/:claimable_balance_id/transactions

This endpoint represents successful transactions referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.

Request

Path Parameters

    claimable_balance_id stringrequired

    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.

Responses

Success

Schema

    _links

    object

    self

    object

    href linkrequired
    templated boolean

    next

    object

    href linkrequired
    templated boolean

    prev

    object

    href linkrequired
    templated boolean

    _embedded

    object

    records

    object[]

  • Array [

  • memo string

    _links

    object

    self

    object

    required

    href linkrequired
    templated boolean

    account

    object

    required

    href linkrequired
    templated boolean

    ledger

    object

    required

    href linkrequired
    templated boolean

    operations

    object

    required

    href linkrequired
    templated boolean

    effects

    object

    required

    href linkrequired
    templated boolean

    precedes

    object

    required

    href linkrequired
    templated boolean

    succeeds

    object

    required

    href linkrequired
    templated boolean

    transaction

    object

    required

    href linkrequired
    templated boolean
    id id (string)required
    paging_token stringrequired
    successful booleanrequired
    hash stringrequired
    ledger int32required
    created_at stringrequired
    source_account address (string)required

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

    account_muxed string
    account_muxed_id string
    source_account_sequence stringrequired
    fee_account address (string)required

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

    fee_account_muxed address (string)

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

    fee_account_muxed_id string
    fee_charged stringrequired
    max_fee stringrequired
    operation_count int32required
    envelope_xdr stringrequired
    result_xdr stringrequired
    result_meta_xdr stringrequired
    fee_meta_xdr string
    memo_type stringrequired
    signatures string[]required

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

    preconditions

    object

    timebounds

    object

    min_time string
    max_time string

    ledgerbounds

    object

    min_ledger string
    max_ledger string
    min_account_sequence string
    min_account_sequence_age string
    min_account_sequence_ledger_gap uint32
    extra_signers string[]

    fee_bump_transaction

    object

    hash hash (string)
    signatures string[]

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

    inner_transaction

    object

    hash hash (string)
    signatures string[]

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

    max_fee string
  • ]

Loading...