Skip to main content

List all Accounts

GET 
/accounts

This endpoint lists accounts by one of four filters : signer, asset, liquidity pool or sponsor.

Request​

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.

    signer string

    Account ID of the signer. Every account in the response will have the given account ID as a signer.

    liqudity_pool any

    With this parameter, the results will include only accounts which have trustlines to the specified liquidity pool.

    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​

Returns accounts based on provided filter: signer , asset, sponser or liquidity pool

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 [
    • _links object
    self objectrequired
    href linkrequired
    templated boolean
    transactions objectrequired
    href linkrequired
    templated boolean
    operations objectrequired
    href linkrequired
    templated boolean
    payments objectrequired
    href linkrequired
    templated boolean
    effects objectrequired
    href linkrequired
    templated boolean
    offers objectrequired
    href linkrequired
    templated boolean
    trades objectrequired
    href linkrequired
    templated boolean
    data objectrequired
    href linkrequired
    templated boolean
    id id (string)required
    account_id address (string)required

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

    sequence sequence (string)required

    Possible values: Value must match regular expression [0-9]+

    sequence_ledger uint32
    sequence_time string
    subentry_count int32required
    inflation_destination address (string)

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

    home_domain string
    last_modified_ledger uint32required
    last_modified_time stringrequired
    thresholds objectrequired
    low_threshold integer
    med_threshold integer
    high_threshold integer
    flags objectrequired
    auth_required boolean
    auth_revocable boolean
    auth_immutable boolean
    auth_clawback_enabled boolean
    balances object[]required
  • Array [
    • anyOf
    balance currency (string)required

    Possible values: Value must match regular expression [0-9]+\.[0-9]{7}

    liquidity_pool_id string
    limit currency (string)required

    Possible values: Value must match regular expression [0-9]+\.[0-9]{7}

    buying_liabilites currency (string)required

    Possible values: Value must match regular expression [0-9]+\.[0-9]{7}

    selling_liabilites currency (string)required

    Possible values: Value must match regular expression [0-9]+\.[0-9]{7}

    sponser string
    last_modified_ledger uint32required
    is_authorized booleanrequired
    is_authorized_to_maintain_liabilites booleanrequired
    is_clawback_enabled booleanrequired
    asset_type stringrequired

    Possible values: [native]

  • ]
    • signers object[]required
  • Array [
    • key address (string)required

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

    weight int32required
    type stringrequired

    Possible values: [ed25519_public_key, sha256_hash, preauth_tx]

    sponser address (string)

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

  • ]
    • data objectrequired
    num_sponsoring integerrequired
    num_sponsered integerrequired
    sponser address (string)

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

    paging_token stringrequired
  • ]
Loading...
Last updated on by Jane Wang