User

GET /v1/user/bin-ids/{user_address}/{chain}/{pool_address}

User Current Bin Ids

http

GET https://api.lfj.dev/v1/user/bin-ids/{user_address}/{chain}/{pool_address}

Authentication: x-lfj-api-key header.

Parameter	In	Type	Required
`user_address`	path	`string`	yes
`chain`	path	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`pool_address`	path	`string`	yes

Status	Description	Body
200	Successful Response	array of `integer`
422	Validation Error	HTTPValidationError

Schemas

HTTPValidationError

Field	Type	Required	Description
`detail`	array of ValidationError

ValidationError

Field	Type	Required
`loc`	array of `string` \| `integer`	yes
`msg`	`string`	yes
`type`	`string`	yes

GET /v1/user/pool-ids/{user_address}/

Get User Pool Ids

http

GET https://api.lfj.dev/v1/user/pool-ids/{user_address}/{chain}

Authentication: x-lfj-api-key header.

Parameter	In	Type	Required	Description
`user_address`	path	`string`	yes
`chain`	path	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`pageSize`	query	`integer`		Default: `20`. Range: > 0, ≤ 100.
`pageNum`	query	`integer`		Default: `1`. Range: > 0.

Status	Description	Body
200	Successful Response	array of UserPoolPosition
422	Validation Error	HTTPValidationError

Schemas

UserPoolPosition

Field	Type	Required
`poolAddress`	`string`	yes
`pairName`	`string`	yes
`status`	`main` \| `old`	yes
`version`	`v2.0` \| `v2.1` \| `v2.2`	yes
`chain`	`string`	yes
`lbBinStep`	`number`	yes
`lbBaseFeePct`	`number`	yes
`lbMaxFeePct`	`number`	yes
`binIds`	array of `integer`	yes
`tokenX`	UserPoolPositionToken	yes
`tokenY`	UserPoolPositionToken	yes

UserPoolPositionToken

Field	Type	Required
`address`	`string`	yes
`name`	`string`	yes
`symbol`	`string`	yes
`decimals`	`integer`	yes
`priceUsd`	`number`	yes

HTTPValidationError

Field	Type	Required	Description
`detail`	array of ValidationError

ValidationError

Field	Type	Required
`loc`	array of `string` \| `integer`	yes
`msg`	`string`	yes
`type`	`string`	yes

Get Pool User Balances

This API is only accessible by users with the partner API key.

http

GET https://api.lfj.dev/v1/user/pool-user-balances

This API is only accessible by users with the partner API key.

Authentication: x-lfj-api-key header.

Parameter	In	Type	Required
`chainId`	query	`integer`	yes
`lpAddress`	query	`string`	yes
`poolAddress`	query	`string`	yes

Status	Description	Body
200	Successful Response	array of PoolUserBalance
422	Validation Error	HTTPValidationError

Schemas

PoolUserBalance

Field	Type	Required
`user`	`string`	yes
`balance`	`string`	yes
`pool`	`string`	yes
`lpTokenAddress`	`string`	yes
`baseTokenBalance`	`string`	yes
`quoteTokenBalance`	`string`	yes
`baseTokenAddress`	`string`	yes
`quoteTokenAddress`	`string`	yes

HTTPValidationError

Field	Type	Required	Description
`detail`	array of ValidationError

ValidationError

Field	Type	Required
`loc`	array of `string` \| `integer`	yes
`msg`	`string`	yes
`type`	`string`	yes

GET /v1/user/{chain}/{user_address}/farms

Get User Farm Positions

http

GET https://api.lfj.dev/v1/user/{chain}/{user_address}/farms

Authentication: x-lfj-api-key header.

Parameter	In	Type	Required	Description
`chain`	path	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`user_address`	path	`string`	yes

Status	Description	Body
200	Successful Response	array of GetUserFarmPosition
422	Validation Error	HTTPValidationError

Schemas

GetUserFarmPosition

Field	Type	Required
`farmId`	`string`	yes
`userPosition`	`string`	yes
`userPositionRaw`	`string`	yes
`userPositionUsd`	`string`	yes
`pendingJoe`	`number`	yes

HTTPValidationError

Field	Type	Required	Description
`detail`	array of ValidationError

ValidationError

Field	Type	Required
`loc`	array of `string` \| `integer`	yes
`msg`	`string`	yes
`type`	`string`	yes

GET /v1/user/{chain}/{user_address}/farms/{vault_id}

Get User Farm Position

http

GET https://api.lfj.dev/v1/user/{chain}/{user_address}/farms/{vault_id}

Authentication: x-lfj-api-key header.

Parameter	In	Type	Required
`chain`	path	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`user_address`	path	`string`	yes
`vault_id`	path	`string`	yes

Status	Description	Body
200	Successful Response	GetUserFarmPosition
422	Validation Error	HTTPValidationError

Schemas

GetUserFarmPosition

Field	Type	Required
`farmId`	`string`	yes
`userPosition`	`string`	yes
`userPositionRaw`	`string`	yes
`userPositionUsd`	`string`	yes
`pendingJoe`	`number`	yes

HTTPValidationError

Field	Type	Required	Description
`detail`	array of ValidationError

ValidationError

Field	Type	Required
`loc`	array of `string` \| `integer`	yes
`msg`	`string`	yes
`type`	`string`	yes

GET /v1/user/{chain}/history/{user_address}/{pool_address}

User Historical Position

http

GET https://api.lfj.dev/v1/user/{chain}/history/{user_address}/{pool_address}

Authentication: x-lfj-api-key header.

Parameter	In	Type	Required	Description
`chain`	path	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`user_address`	path	`string`	yes
`pool_address`	path	`string`	yes
`pageSize`	query	`integer`		Default: `20`. Range: > 0, ≤ 100.
`pageNum`	query	`integer`		Default: `1`. Range: > 0.
`startTime`	query	`integer`	yes
`endTime`	query	`integer`

Status	Description	Body
200	Successful Response	array of UserBinHistory
422	Validation Error	HTTPValidationError

Schemas

UserBinHistory

Field	Type	Required
`poolAddress`	`string`	yes
`pairName`	`string`	yes
`binId`	`integer`	yes
`lbBinStep`	`number`	yes
`lbBaseFeePct`	`number`	yes
`lbMaxFeePct`	`number`	yes
`tokenX`	UserBinPositionTokenWrapper	yes
`tokenY`	UserBinPositionTokenWrapper	yes
`isDeposit`	`boolean`	yes
`timestamp`	`string`	yes
`blockNumber`	`integer`	yes

UserBinPositionTokenWrapper

Field	Type	Required
`address`	`string`	yes
`name`	`string`	yes
`symbol`	`string`	yes
`decimals`	`integer`	yes
`amount`	`number`	yes
`amountRaw`	`string`	yes
`price`	`number`	yes
`priceUsd`	`number`

HTTPValidationError

Field	Type	Required	Description
`detail`	array of ValidationError

ValidationError

Field	Type	Required
`loc`	array of `string` \| `integer`	yes
`msg`	`string`	yes
`type`	`string`	yes

GET /v1/user/fees-earned/{chain}/{user_address}/{pool_address}

User Earned Fees Per Bin

http

GET https://api.lfj.dev/v1/user/fees-earned/{chain}/{user_address}/{pool_address}

Authentication: x-lfj-api-key header.

Parameter	In	Type	Required
`chain`	path	`all` \| `avalanche` \| `arbitrum` \| `mantle` \| `monad`	yes
`user_address`	path	`string`	yes
`pool_address`	path	`string`	yes

Status	Description	Body
200	Successful Response	array of UserFeesEarnedPerBin
422	Validation Error	HTTPValidationError

Schemas

UserFeesEarnedPerBin

Field	Type	Required
`binId`	`integer`	yes
`mostRecentDepositTime`	`string`	yes
`timestamp`	`integer`	yes
`accruedFeesX`	`number`	yes
`accruedFeesY`	`number`	yes
`accruedFeesL`	`number`	yes
`priceXY`	`number`	yes
`priceYX`	`number`	yes

HTTPValidationError

Field	Type	Required	Description
`detail`	array of ValidationError

ValidationError

Field	Type	Required
`loc`	array of `string` \| `integer`	yes
`msg`	`string`	yes
`type`	`string`	yes

Guides

Concepts

Contracts

Interfaces

Libraries

Math

Deployment Addresses

Legacy Pools

SDK

Joe V1 Audits

User

GET /v1/user/bin-ids/{user_address}/{chain}/{pool_address}

GET /v1/user/pool-ids/{user_address}/

Get Pool User Balances

GET /v1/user/{chain}/{user_address}/farms

GET /v1/user/{chain}/{user_address}/farms/{vault_id}

GET /v1/user/{chain}/history/{user_address}/{pool_address}

GET /v1/user/fees-earned/{chain}/{user_address}/{pool_address}

Interfaces

Libraries

Math

Legacy Pools

User ​

GET /v1/user/bin-ids/{user_address}/{chain}/{pool_address} ​

GET /v1/user/pool-ids/{user_address}/ ​

Get Pool User Balances ​

GET /v1/user/{chain}/{user_address}/farms ​

GET /v1/user/{chain}/{user_address}/farms/{vault_id} ​

GET /v1/user/{chain}/history/{user_address}/{pool_address} ​

GET /v1/user/fees-earned/{chain}/{user_address}/{pool_address} ​

User

GET /v1/user/bin-ids/{user_address}/{chain}/{pool_address}

GET /v1/user/pool-ids/{user_address}/

Get Pool User Balances

GET /v1/user/{chain}/{user_address}/farms

GET /v1/user/{chain}/{user_address}/farms/{vault_id}

GET /v1/user/{chain}/history/{user_address}/{pool_address}

GET /v1/user/fees-earned/{chain}/{user_address}/{pool_address}