Retrieve Related 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.

This method will use 20 Compute Units.

Reference: Here

PreviousRetrieve a Liquidity Pool NextRetrieve Related Trades

Last updated 9 months ago

Was this helpful?

Retrieve Related Effects

get

Path parameters

liquidity_pool_idanyrequired

A unique identifier for this liquidity pool.

Query parameters

cursorintegeroptional

A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.

Example: 6606617478959105

orderstring · enumoptional

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.

Available options:

limitintegeroptional

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.

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>/liquidity_pools/{liquidity_pool_id}/effects'

200

{
  "_links": {
    "self": {
      "href": "https://horizon-testnet.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=&order=asc"
    },
    "next": {
      "href": "https://horizon-testnet.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=120192370561220608&order=asc"
    },
    "prev": {
      "href": "https://horizon-testnet.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=120192344791343104&order=desc"
    }
  },
  "_embedded": {
    "records": [
      {
        "_links": {
          "operation": {
            "href": "https://horizon-testnet.stellar.org/operations/3849085266190337"
          },
          "succeeds": {
            "href": "https://horizon-testnet.stellar.org/effects?order=desc&cursor=3849085266190337-1"
          },
          "precedes": {
            "href": "https://horizon-testnet.stellar.org/effects?order=asc&cursor=3849085266190337-1"
          }
        },
        "id": "0000000012884905986-0000000001",
        "paging_token": "12884905986-2",
        "account": "GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7",
        "type": "liquidity_pool_deposited",
        "type_i": 81,
        "created_at": "2021-11-18T03:15:54Z",
        "liquidity_pool": {
          "id": "67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9",
          "fee_bp": 30,
          "type": "constant_product",
          "total_trustlines": "300",
          "total_shares": "5000",
          "reserves": [
            {
              "amount": "1000.0000005",
              "asset": "EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"
            },
            {
              "amount": "2000.0000000",
              "asset": "PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"
            }
          ]
        },
        "reserves_deposited": [
          {
            "asset": "EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S",
            "amount": "2378.0000005"
          },
          {
            "asset": "PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP",
            "amount": "983.0000005"
          }
        ],
        "shares_received": "1000"
      },
      {
        "id": "0000000012884905986-0000000002",
        "paging_token": "12884905986-2",
        "account": "GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7",
        "type": "liquidity_pool_withdrew",
        "type_i": 82,
        "created_at": "2021-11-18T03:15:54Z",
        "liquidity_pool": {
          "id": "67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9",
          "fee_bp": 30,
          "type": "constant_product",
          "total_trustlines": "299",
          "total_shares": "4000",
          "reserves": [
            {
              "amount": "7.0000005",
              "asset": "EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"
            },
            {
              "amount": "1.0000000",
              "asset": "PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"
            }
          ]
        },
        "reserves_received": [
          {
            "asset": "EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S",
            "amount": "2478.0000005"
          },
          {
            "asset": "PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP",
            "amount": "993.0000005"
          }
        ],
        "shares_redeemed": "1000"
      },
      {
        "id": "0000000012884905986-0000000003",
        "paging_token": "12884905986-2",
        "account": "GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7",
        "type": "liquidity_pool_trade",
        "type_i": 83,
        "created_at": "2021-11-18T03:15:54Z",
        "liquidity_pool": {
          "id": "67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9",
          "fee_bp": 30,
          "type": "constant_product",
          "total_trustlines": "300",
          "total_shares": "5000",
          "reserves": [
            {
              "amount": "1000.0000005",
              "asset": "EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"
            },
            {
              "amount": "2000.0000000",
              "asset": "PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"
            }
          ]
        },
        "sold": {
          "asset": "PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP",
          "amount": "983.0000005"
        },
        "bought": {
          "asset": "EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S",
          "amount": "2378.0000005"
        }
      },
      {
        "id": "0000000012884905986-0000000004",
        "paging_token": "12884905986-2",
        "account": "GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7",
        "type": "liquidity_pool_created",
        "type_i": 84,
        "created_at": "2021-11-18T03:15:54Z",
        "liquidity_pool": {
          "id": "67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9",
          "fee_bp": 30,
          "type": "constant_product",
          "total_trustlines": "1",
          "total_shares": "0",
          "reserves": [
            {
              "amount": "0",
              "asset": "EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"
            },
            {
              "amount": "0",
              "asset": "PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"
            }
          ]
        }
      },
      {
        "id": "0000000012884905986-0000000005",
        "paging_token": "12884905986-2",
        "account": "GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7",
        "type": "liquidity_pool_removed",
        "type_i": 85,
        "created_at": "2021-11-18T03:15:54Z",
        "liquidity_pool_id": "67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9"
      },
      {
        "id": "0000000012884905986-0000000006",
        "paging_token": "12884905986-2",
        "account": "GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7",
        "type": "liquidity_pool_revoked",
        "type_i": 86,
        "created_at": "2021-11-18T03:15:54Z",
        "liquidity_pool": {
          "id": "67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9",
          "fee_bp": 30,
          "type": "constant_product",
          "total_trustlines": "299",
          "total_shares": "4000",
          "reserves": [
            {
              "amount": "7.0000005",
              "asset": "EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"
            },
            {
              "amount": "1.0000000",
              "asset": "PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"
            }
          ]
        },
        "reserves_revoked": [
          {
            "asset": "EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S",
            "amount": "2478.0000005",
            "claimable_balance_id": "idcbd1234"
          },
          {
            "asset": "PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP",
            "amount": "993.0000005",
            "claimable_balance_id": "cbid1235"
          }
        ],
        "shares_revoked": "1000"
      },
      {
        "id": "0000000012884905986-0000000007",
        "paging_token": "157639717969326081-1",
        "account": "GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG",
        "type": "trustline_created",
        "type_i": 20,
        "created_at": "2021-08-04T20:01:24Z",
        "asset_type": "liquidity_pool_shares",
        "liquidity_pool_id": "67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9",
        "limit": "1000"
      },
      {
        "id": "0000000012884905986-0000000008",
        "paging_token": "157639717969326081-1",
        "account": "GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG",
        "type": "trustline_updated",
        "type_i": 22,
        "created_at": "2021-08-04T20:01:24Z",
        "asset_type": "liquidity_pool_shares",
        "liquidity_pool_id": "67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9",
        "limit": "2000"
      },
      {
        "id": "0000000012884905986-0000000009",
        "paging_token": "157639717969326081-1",
        "account": "GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG",
        "type": "trustline_removed",
        "type_i": 21,
        "created_at": "2021-08-04T20:01:24Z",
        "asset_type": "liquidity_pool_shares",
        "liquidity_pool_id": "67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9",
        "limit": "0.0000000"
      }
    ]
  }
}

Success