LP

Get an LP's positions on a chain

Returns the LP's position in every asset vault on one chain in one call, with the same figures as the single-vault read.

GET
/api/vaults/positions/{chainId}/{lp}

Authorization

ApiKeyAuth
X-API-Key<token>

Your API key. Authorizing a swap or opening a market takes a key issued to your integration, and the shared key the docs fill in reads and quotes only.

In: header

Path Parameters

chainId*integer

The chain's numeric id, for example 8453 for Base or 1151111081099710 for Solana. GET /api/vaults/chains lists them.

lp*string

The liquidity provider's wallet: a 0x address, or a base58 address on Solana.

Query Parameters

reconcile?string

On unless false. Checks the free principal against a live chain read and reports any difference.

includeRetired?string

Off unless true. Also returns the LP's balance in asset vaults that are no longer offered, so it can be withdrawn.

Response Body

application/json

curl -X GET "https://example.com/api/vaults/positions/1/string"
{  "positions": [    {      "chainId": 8453,      "vault": "0xb367A4306087d3981B38C032464cD7E3A7a03A4E",      "lp": "0x1111111111111111111111111111111111111111",      "principal": "170000000",      "frontHeld": "50000000",      "freePrincipal": "120000000",      "asset": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",      "vaultPaused": false,      "strategyIds": [        "38960560214548620419581884607967218229413556116830054641371650059665611327033"      ],      "offered": true    },    {      "chainId": 8453,      "vault": "0x256218A93992256F47c4735e1Fc070d90EaeA263",      "lp": "0x1111111111111111111111111111111111111111",      "principal": "16719015731379870",      "frontHeld": "0",      "freePrincipal": "16719015731379870",      "asset": "0x4200000000000000000000000000000000000006",      "vaultPaused": false,      "strategyIds": [        "38960560214548620419581884607967218229413556116830054641371650059665611327033"      ],      "offered": true    }  ]}