Vaults

GET /v1/vaults

List Vaults

http

GET https://api.lfj.dev/v1/vaults

Authentication: x-lfj-api-key header.

Parameter	In	Type	Required	Description
`pageSize`	query	`integer`		Default: `20`. Range: > 0, ≤ 100.
`pageNum`	query	`integer`		Default: `1`. Range: > 0.

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

Schemas

GetVault

Field	Type	Required
`address`	`string`	yes
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`chainId`	`integer`	yes
`name`	`string`	yes
`pair`	GetVaultPair	yes
`tokenX`	GetVaultToken	yes
`tokenY`	GetVaultToken	yes
`tokenX7DayPerformance`	`number`	yes
`tokenY7DayPerformance`	`number`	yes
`hodl5050Performance`	`number`	yes
`tokenX30DayPerformance`	`number`	yes
`tokenY30DayPerformance`	`number`	yes
`hodl30Day5050Performance`	`number`	yes
`strategy`	GetVaultStrategy
`aptPrice`	`number`
`apt1dPriceChange`	`number`	yes
`tvlUsd`	`number`	yes
`feesUsd`	`number`	yes
`apr1d`	`number`	yes
`farm`	GetFarm

GetVaultPair

Field	Type	Required
`address`	`string`	yes
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`version`	`v2.0` \| `v2.1` \| `v2.2`	yes
`binStep`	`integer`	yes
`baseFeePct`	`number`	yes

GetVaultToken

Field	Type	Required
`address`	`string`	yes
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`symbol`	`string`	yes
`decimals`	`integer`	yes

GetVaultStrategy

Field	Type	Required
`address`	`string`	yes
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`aumAnnualFeePct`	`number`	yes

GetFarm

Field	Type	Required
`farmId`	`string`	yes
`vaultId`	`string`	yes
`liquidity`	`string`	yes
`liquidityRaw`	`integer`	yes
`liquidityUsd`	`number`	yes
`aptDecimals`	`integer`	yes
`apr1d`	`number`	yes
`rewardsPerSec`	`number`	yes
`reward`	GetReward	yes
`rewarder`	GetRewarder

GetReward

Field	Type	Required
`id`	`string`	yes
`name`	`string`	yes
`symbol`	`string`	yes
`decimals`	`integer`	yes

GetRewarder

Field	Type	Required
`rewarderContract`	`string`	yes
`rewarderTokenId`	`string`	yes
`rewarderTokenName`	`string`	yes
`rewarderTokenSymbol`	`string`	yes
`rewarderTokenDecimals`	`integer`	yes
`rewarderTokenPerSec`	`number`	yes
`rewarderApr1d`	`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/vaults/

List Vaults By Chain

http

GET https://api.lfj.dev/v1/vaults/{chain}

Authentication: x-lfj-api-key header.

Parameter	In	Type	Required	Description
`chain`	path	`all` \| `avalanche` \| `arbitrum` \| `mantle` \| `monad`	yes
`pageSize`	query	`integer`		Default: `20`. Range: > 0, ≤ 100.
`pageNum`	query	`integer`		Default: `1`. Range: > 0.
`userAddress`	query	`string`

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

Schemas

GetVault

Field	Type	Required
`address`	`string`	yes
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`chainId`	`integer`	yes
`name`	`string`	yes
`pair`	GetVaultPair	yes
`tokenX`	GetVaultToken	yes
`tokenY`	GetVaultToken	yes
`tokenX7DayPerformance`	`number`	yes
`tokenY7DayPerformance`	`number`	yes
`hodl5050Performance`	`number`	yes
`tokenX30DayPerformance`	`number`	yes
`tokenY30DayPerformance`	`number`	yes
`hodl30Day5050Performance`	`number`	yes
`strategy`	GetVaultStrategy
`aptPrice`	`number`
`apt1dPriceChange`	`number`	yes
`tvlUsd`	`number`	yes
`feesUsd`	`number`	yes
`apr1d`	`number`	yes
`farm`	GetFarm

GetVaultPair

Field	Type	Required
`address`	`string`	yes
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`version`	`v2.0` \| `v2.1` \| `v2.2`	yes
`binStep`	`integer`	yes
`baseFeePct`	`number`	yes

GetVaultToken

Field	Type	Required
`address`	`string`	yes
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`symbol`	`string`	yes
`decimals`	`integer`	yes

GetVaultStrategy

Field	Type	Required
`address`	`string`	yes
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`aumAnnualFeePct`	`number`	yes

GetFarm

Field	Type	Required
`farmId`	`string`	yes
`vaultId`	`string`	yes
`liquidity`	`string`	yes
`liquidityRaw`	`integer`	yes
`liquidityUsd`	`number`	yes
`aptDecimals`	`integer`	yes
`apr1d`	`number`	yes
`rewardsPerSec`	`number`	yes
`reward`	GetReward	yes
`rewarder`	GetRewarder

GetReward

Field	Type	Required
`id`	`string`	yes
`name`	`string`	yes
`symbol`	`string`	yes
`decimals`	`integer`	yes

GetRewarder

Field	Type	Required
`rewarderContract`	`string`	yes
`rewarderTokenId`	`string`	yes
`rewarderTokenName`	`string`	yes
`rewarderTokenSymbol`	`string`	yes
`rewarderTokenDecimals`	`integer`	yes
`rewarderTokenPerSec`	`number`	yes
`rewarderApr1d`	`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 Vault Share Price

http

GET https://api.lfj.dev/v1/vaults/{chain}/{vault_address}/share-price

Authentication: x-lfj-api-key header.

Parameter	In	Type	Required
`chain`	path	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`vault_address`	path	`string`	yes
`fromTimestamp`	query	`integer`	yes
`toTimestamp`	query	`integer`

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

Schemas

VaultSharePrice

Field	Type	Required
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`vaultAddress`	`string`	yes
`blockNumber`	`integer`	yes
`sharePrice`	`string`	yes
`timestamp`	`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/vaults/{chain}/{vault_address}

Get Vault

http

GET https://api.lfj.dev/v1/vaults/{chain}/{vault_address}

Authentication: x-lfj-api-key header.

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

Status	Description	Body
200	Successful Response	GetVault
422	Validation Error	HTTPValidationError

Schemas

GetVault

Field	Type	Required
`address`	`string`	yes
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`chainId`	`integer`	yes
`name`	`string`	yes
`pair`	GetVaultPair	yes
`tokenX`	GetVaultToken	yes
`tokenY`	GetVaultToken	yes
`tokenX7DayPerformance`	`number`	yes
`tokenY7DayPerformance`	`number`	yes
`hodl5050Performance`	`number`	yes
`tokenX30DayPerformance`	`number`	yes
`tokenY30DayPerformance`	`number`	yes
`hodl30Day5050Performance`	`number`	yes
`strategy`	GetVaultStrategy
`aptPrice`	`number`
`apt1dPriceChange`	`number`	yes
`tvlUsd`	`number`	yes
`feesUsd`	`number`	yes
`apr1d`	`number`	yes
`farm`	GetFarm

GetVaultPair

Field	Type	Required
`address`	`string`	yes
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`version`	`v2.0` \| `v2.1` \| `v2.2`	yes
`binStep`	`integer`	yes
`baseFeePct`	`number`	yes

GetVaultToken

Field	Type	Required
`address`	`string`	yes
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`symbol`	`string`	yes
`decimals`	`integer`	yes

GetVaultStrategy

Field	Type	Required
`address`	`string`	yes
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`aumAnnualFeePct`	`number`	yes

GetFarm

Field	Type	Required
`farmId`	`string`	yes
`vaultId`	`string`	yes
`liquidity`	`string`	yes
`liquidityRaw`	`integer`	yes
`liquidityUsd`	`number`	yes
`aptDecimals`	`integer`	yes
`apr1d`	`number`	yes
`rewardsPerSec`	`number`	yes
`reward`	GetReward	yes
`rewarder`	GetRewarder

GetReward

Field	Type	Required
`id`	`string`	yes
`name`	`string`	yes
`symbol`	`string`	yes
`decimals`	`integer`	yes

GetRewarder

Field	Type	Required
`rewarderContract`	`string`	yes
`rewarderTokenId`	`string`	yes
`rewarderTokenName`	`string`	yes
`rewarderTokenSymbol`	`string`	yes
`rewarderTokenDecimals`	`integer`	yes
`rewarderTokenPerSec`	`number`	yes
`rewarderApr1d`	`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/vaults/{chain}/{vault_address}/tvl-history

Get Vault Tvl History

http

GET https://api.lfj.dev/v1/vaults/{chain}/{vault_address}/tvl-history

Authentication: x-lfj-api-key header.

Parameter	In	Type	Required
`chain`	path	`all` \| `avalanche` \| `arbitrum` \| `mantle` \| `monad`	yes
`vault_address`	path	`string`	yes
`startTime`	query	`integer`	yes
`endTime`	query	`integer`

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

Schemas

GetVaultTVL

Field	Type	Required
`date`	`string`	yes
`timestamp`	`integer`	yes
`amountX`	`integer`	yes
`amountY`	`integer`	yes
`amountXUsd`	`number`	yes
`amountYUsd`	`number`	yes
`tvlUsd`	`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/vaults/{chain}/{vault_address}/recent-activity

Get Vault Recent Activity

http

GET https://api.lfj.dev/v1/vaults/{chain}/{vault_address}/recent-activity

Authentication: x-lfj-api-key header.

Parameter	In	Type	Required	Description
`chain`	path	`all` \| `avalanche` \| `arbitrum` \| `mantle` \| `monad`	yes
`vault_address`	path	`string`	yes
`pageSize`	query	`integer`		Default: `20`. Range: > 0, ≤ 100.
`pageNum`	query	`integer`		Default: `1`. Range: > 0.

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

Schemas

GetVaultActivity

Field	Type	Required
`date`	`string`	yes
`timestamp`	`integer`	yes
`transactionHash`	`string`	yes
`deposits`	array of VaultBinActivity	yes
`withdrawals`	array of VaultBinActivity	yes

VaultBinActivity

Field	Type	Required
`binId`	`integer`	yes
`amountX`	`integer`	yes
`amountY`	`integer`	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/vaults/{chain}/withdrawals/{user_address}

Get Vault Withdrawals By User

http

GET https://api.lfj.dev/v1/vaults/{chain}/withdrawals/{user_address}

Authentication: x-lfj-api-key header.

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

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

Schemas

GetVaultWithdrawal

Field	Type	Required
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`vaultAddress`	`string`	yes
`userAddress`	`string`	yes
`round`	`integer`	yes
`shares`	`integer`	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/vaults/{chain}/{vault_address}/withdrawals/{user_address}

Get Vault Withdrawals By User And Vault

http

GET https://api.lfj.dev/v1/vaults/{chain}/{vault_address}/withdrawals/{user_address}

Authentication: x-lfj-api-key header.

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

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

Schemas

GetVaultWithdrawal

Field	Type	Required
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`vaultAddress`	`string`	yes
`userAddress`	`string`	yes
`round`	`integer`	yes
`shares`	`integer`	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

Vaults

GET /v1/vaults

GET /v1/vaults/

GET /v1/vaults/{chain}/{vault_address}

GET /v1/vaults/{chain}/{vault_address}/tvl-history

GET /v1/vaults/{chain}/{vault_address}/recent-activity

GET /v1/vaults/{chain}/withdrawals/{user_address}

GET /v1/vaults/{chain}/{vault_address}/withdrawals/{user_address}

Interfaces

Libraries

Math

Legacy Pools

Vaults ​

GET /v1/vaults ​

GET /v1/vaults/ ​

GET /v1/vaults/{chain}/{vault_address}/share-price ​

GET /v1/vaults/{chain}/{vault_address} ​

GET /v1/vaults/{chain}/{vault_address}/tvl-history ​

GET /v1/vaults/{chain}/{vault_address}/recent-activity ​

GET /v1/vaults/{chain}/withdrawals/{user_address} ​

GET /v1/vaults/{chain}/{vault_address}/withdrawals/{user_address} ​

Vaults

GET /v1/vaults

GET /v1/vaults/

GET /v1/vaults/{chain}/{vault_address}/share-price

GET /v1/vaults/{chain}/{vault_address}

GET /v1/vaults/{chain}/{vault_address}/tvl-history

GET /v1/vaults/{chain}/{vault_address}/recent-activity

GET /v1/vaults/{chain}/withdrawals/{user_address}

GET /v1/vaults/{chain}/{vault_address}/withdrawals/{user_address}