Skip to main content

Retrieve an Account's Effects

GET 
/accounts/:account_id/effects

This endpoint returns the effects of a specific account and can be used in streaming mode. Streaming mode allows you to listen for new effects for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.

Request​

Path Parameters

    account_id stringrequired

    This account’s public key encoded in a base32 string representation.

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.

Responses​

Success

Schema

    oneOf

    _links

    object

    self

    object

    required

    href linkrequired
    templated boolean

    transaction

    object

    required

    href linkrequired
    templated boolean

    effects

    object

    required

    href linkrequired
    templated boolean

    succeeds

    object

    required

    href linkrequired
    templated boolean

    precedes

    object

    required

    href linkrequired
    templated boolean
    id id (string)required
    paging_token stringrequired
    transaction_successful booleanrequired
    source_account address (string)required

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

    type stringrequired
    type_i numberrequired
    created_at stringrequired
    transaction_hash stringrequired
    starting_balance stringrequired
    funder address (string)required

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

    account address (string)required

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

    _links

    object

    self

    object

    href linkrequired
    templated boolean

    next

    object

    href linkrequired
    templated boolean

    prev

    object

    href linkrequired
    templated boolean
Loading...
Last updated on by Elliot Voris