Skip to main content

Retrieve Related Effects

GET 

/liquidity_pools/:liquidity_pool_id/effects

This endpoint represents effects referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new effects referencing this liquidity pool 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

    liquidity_pool_id anyrequired

    A unique identifier for this liquidity pool.

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

    _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

    operation

    object

    href linkrequired
    templated boolean

    succeeds

    object

    href linkrequired
    templated boolean

    precedes

    object

    href linkrequired
    templated boolean
    id id (string)
    paging_token paging_token (string)
    account address (string)

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

    type string

    Possible values: [Account Created, Account Removed, Account Credited, Account Debited, Account Thresholds Updated, Account Home Domain Updated, Account Flags Updated, Account Inflation Destination Updated, Signer Created, Signer Removed, Signer Updated, Trustline Created, Trustline Removed, Trustline Updated, Trustline Authorized, Trustline Deauthorized, Offer Created, Offer Removed, Offer Updated, Trade, Data Created, Data Removed, Data Updated, Claimable Balance Created, Claimable Balance Claimant Created, Claimable Balance Claimed, Account Sponsorship Created, Account Sponsorship Updated, Account Sponsorship Removed, Trustline Sponsorship Created, Trustline Sponsorship Updated, Trustline Sponsorship Removed, Account Data Sponsorship Created, Account Data Sponsorship Updated, Account Data Sponsorship Removed, Claimable Balance Sponsorship Created, Claimable Balance Sponsorship Updated, Claimable Balance Sponsorship Removed, Account Signer Sponsorship Created, Account Signer Sponsorship Updated, Account Signer Sponsorship Removed, Liquidity Pool Created, Liquidity Pool Removed, Liquidity Pool Revoked, Liquidity Pool Deposited, Liquidity Pool Withdraw, Liquidity Pool Trade, Sequence Bumped]

    type_i number
    created_at string
  • ]

Loading...