LFJ Developer Docs
  • Liquidity Book
  • Introduction
  • LB V2.2 Key Changes
  • Guides
    • Swap Tokens
    • Add/Remove Liquidity
    • Tracking Volume
    • Tracking Pool Balances
    • Finding The Best Quote
    • Byte32 Decoding
    • Price From Bin Id
    • Bin Id From Price
    • Finding Liquidity Depth
    • User Balances
  • Concepts
    • Concentrated Liquidity
    • Bin Math
    • Bin Liquidity
    • Swaps
    • Fees
    • Oracle
  • Contracts
    • Interfaces
      • ILBLegacyFactory
      • ILBLegacyToken
      • ILBLegacyPair
      • ILBLegacyRouter
      • ILBFlashLoanCallback
      • IPendingOwnable
      • IJoeFactory
      • IJoePair
      • IJoeRouter01
      • IJoeRouter02
      • IWNATIVE
      • ILBFactory
      • ILBHooks
      • ILBPair
      • ILBRouter
      • ILBToken
    • Libraries
      • Math
        • BitMath
        • Encoded
        • LiquidityConfigurations
        • PackedUint128Math
        • SafeCast
        • SampleMath
        • TreeMath
        • Uint128x128Math
        • Uint256x256Math
      • BinHelper
      • Clone
      • Constants
      • FeeHelper
      • Hooks
      • ImmutableClone
      • JoeLibrary
      • OracleHelper
      • PairParameterHelper
      • PriceHelper
      • ReentrancyGuardUpgradeable
      • TokenHelper
    • LBBaseHooks
    • LBFactory
    • LBPair
    • LBQuoter
    • LBRouter
    • LBToken
  • Deployment Addresses
    • Avalanche C-Chain
    • Fuji Testnet
    • Arbitrum One
    • Binance Smart Chain
    • Binance Smart Chain Testnet
    • Ethereum Mainnet
    • Monad Testnet
  • SDK
    • Introduction
    • Making a Trade
    • Adding Liquidity
    • Removing Liquidity
  • Audits
  • AMM
    • Joe V1 Contracts
    • Joe V1 Audits
  • LFJ DEX API
    • Dex Analytics
    • Pools
    • Rewards
    • User
    • User Lifetime Stats
    • Vaults
    • Models
  • LFJ Aggregator API
    • Default
    • Models
Powered by GitBook
On this page
  1. LFJ DEX API

Vaults

PreviousUser Lifetime StatsNextModels

List Vaults

get
Query parameters
pageSizeinteger · max: 100OptionalDefault: 20
pageNumintegerOptionalDefault: 1
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/vaults HTTP/1.1
Host: api.lfj.dev
Accept: */*
[
  {
    "address": "text",
    "chain": "avalanche",
    "chainId": 1,
    "name": "text",
    "pair": {
      "address": "text",
      "chain": "avalanche",
      "version": "v2.0",
      "binStep": 1,
      "baseFeePct": 1
    },
    "tokenX": {
      "address": "text",
      "chain": "avalanche",
      "symbol": "text",
      "decimals": 1
    },
    "tokenY": {
      "address": "text",
      "chain": "avalanche",
      "symbol": "text",
      "decimals": 1
    },
    "tokenX7DayPerformance": 1,
    "tokenY7DayPerformance": 1,
    "hodl5050Performance": 1,
    "tokenX30DayPerformance": 1,
    "tokenY30DayPerformance": 1,
    "hodl30Day5050Performance": 1,
    "strategy": {
      "address": "text",
      "chain": "avalanche",
      "aumAnnualFeePct": 1
    },
    "aptPrice": 1,
    "apt1dPriceChange": 1,
    "tvlUsd": 1,
    "feesUsd": 1,
    "apr1d": 1,
    "farm": {
      "farmId": "text",
      "vaultId": "text",
      "liquidity": "text",
      "liquidityRaw": 1,
      "liquidityUsd": 1,
      "aptDecimals": 1,
      "apr1d": 1,
      "rewardsPerSec": 1,
      "reward": {
        "id": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1
      },
      "rewarder": {
        "rewarderContract": "text",
        "rewarderTokenId": "text",
        "rewarderTokenName": "text",
        "rewarderTokenSymbol": "text",
        "rewarderTokenDecimals": 1,
        "rewarderTokenPerSec": 1,
        "rewarderApr1d": 1
      }
    }
  }
]

List Vaults By Chain

get
Path parameters
chainstring · enumRequired

An enumeration.

Possible values:
Query parameters
pageSizeinteger · max: 100OptionalDefault: 20
pageNumintegerOptionalDefault: 1
userAddressstringOptionalExample: 0xe785e0899e7acd50a55f6b517f1f9c46574c9d7c
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/vaults/{chain} HTTP/1.1
Host: api.lfj.dev
Accept: */*
[
  {
    "address": "text",
    "chain": "avalanche",
    "chainId": 1,
    "name": "text",
    "pair": {
      "address": "text",
      "chain": "avalanche",
      "version": "v2.0",
      "binStep": 1,
      "baseFeePct": 1
    },
    "tokenX": {
      "address": "text",
      "chain": "avalanche",
      "symbol": "text",
      "decimals": 1
    },
    "tokenY": {
      "address": "text",
      "chain": "avalanche",
      "symbol": "text",
      "decimals": 1
    },
    "tokenX7DayPerformance": 1,
    "tokenY7DayPerformance": 1,
    "hodl5050Performance": 1,
    "tokenX30DayPerformance": 1,
    "tokenY30DayPerformance": 1,
    "hodl30Day5050Performance": 1,
    "strategy": {
      "address": "text",
      "chain": "avalanche",
      "aumAnnualFeePct": 1
    },
    "aptPrice": 1,
    "apt1dPriceChange": 1,
    "tvlUsd": 1,
    "feesUsd": 1,
    "apr1d": 1,
    "farm": {
      "farmId": "text",
      "vaultId": "text",
      "liquidity": "text",
      "liquidityRaw": 1,
      "liquidityUsd": 1,
      "aptDecimals": 1,
      "apr1d": 1,
      "rewardsPerSec": 1,
      "reward": {
        "id": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1
      },
      "rewarder": {
        "rewarderContract": "text",
        "rewarderTokenId": "text",
        "rewarderTokenName": "text",
        "rewarderTokenSymbol": "text",
        "rewarderTokenDecimals": 1,
        "rewarderTokenPerSec": 1,
        "rewarderApr1d": 1
      }
    }
  }
]

Get Vault Share Price

get
Path parameters
chainstring · enumRequired

An enumeration.

Possible values:
vault_addressstringRequiredExample: 0xe785e0899e7acd50a55f6b517f1f9c46574c9d7c
Query parameters
fromTimestampintegerRequired
toTimestampintegerOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/vaults/{chain}/{vault_address}/share-price HTTP/1.1
Host: api.lfj.dev
Accept: */*
[
  {
    "chain": "avalanche",
    "vaultAddress": "text",
    "blockNumber": 1,
    "sharePrice": "text",
    "timestamp": "2025-06-18T03:49:35.552Z"
  }
]

Get Vault

get
Path parameters
chainstring · enumRequired

An enumeration.

Possible values:
vault_addressstringRequiredExample: 0xe785e0899e7acd50a55f6b517f1f9c46574c9d7c
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/vaults/{chain}/{vault_address} HTTP/1.1
Host: api.lfj.dev
Accept: */*
{
  "address": "text",
  "chain": "avalanche",
  "chainId": 1,
  "name": "text",
  "pair": {
    "address": "text",
    "chain": "avalanche",
    "version": "v2.0",
    "binStep": 1,
    "baseFeePct": 1
  },
  "tokenX": {
    "address": "text",
    "chain": "avalanche",
    "symbol": "text",
    "decimals": 1
  },
  "tokenY": {
    "address": "text",
    "chain": "avalanche",
    "symbol": "text",
    "decimals": 1
  },
  "tokenX7DayPerformance": 1,
  "tokenY7DayPerformance": 1,
  "hodl5050Performance": 1,
  "tokenX30DayPerformance": 1,
  "tokenY30DayPerformance": 1,
  "hodl30Day5050Performance": 1,
  "strategy": {
    "address": "text",
    "chain": "avalanche",
    "aumAnnualFeePct": 1
  },
  "aptPrice": 1,
  "apt1dPriceChange": 1,
  "tvlUsd": 1,
  "feesUsd": 1,
  "apr1d": 1,
  "farm": {
    "farmId": "text",
    "vaultId": "text",
    "liquidity": "text",
    "liquidityRaw": 1,
    "liquidityUsd": 1,
    "aptDecimals": 1,
    "apr1d": 1,
    "rewardsPerSec": 1,
    "reward": {
      "id": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 1
    },
    "rewarder": {
      "rewarderContract": "text",
      "rewarderTokenId": "text",
      "rewarderTokenName": "text",
      "rewarderTokenSymbol": "text",
      "rewarderTokenDecimals": 1,
      "rewarderTokenPerSec": 1,
      "rewarderApr1d": 1
    }
  }
}

Get Vault Tvl History

get
Path parameters
chainstring · enumRequired

An enumeration.

Possible values:
vault_addressstringRequiredExample: 0xe785e0899e7acd50a55f6b517f1f9c46574c9d7c
Query parameters
startTimeintegerRequired
endTimeintegerOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/vaults/{chain}/{vault_address}/tvl-history HTTP/1.1
Host: api.lfj.dev
Accept: */*
[
  {
    "date": "2025-06-18T03:49:35.552Z",
    "timestamp": 1,
    "amountX": 1,
    "amountY": 1,
    "amountXUsd": 1,
    "amountYUsd": 1,
    "tvlUsd": 1
  }
]

Get Vault Recent Activity

get
Path parameters
chainstring · enumRequired

An enumeration.

Possible values:
vault_addressstringRequiredExample: 0xe785e0899e7acd50a55f6b517f1f9c46574c9d7c
Query parameters
pageSizeinteger · max: 100OptionalDefault: 20
pageNumintegerOptionalDefault: 1
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/vaults/{chain}/{vault_address}/recent-activity HTTP/1.1
Host: api.lfj.dev
Accept: */*
[
  {
    "date": "2025-06-18T03:49:35.552Z",
    "timestamp": 1,
    "transactionHash": "text",
    "deposits": [
      {
        "binId": 1,
        "amountX": 1,
        "amountY": 1
      }
    ],
    "withdrawals": [
      {
        "binId": 1,
        "amountX": 1,
        "amountY": 1
      }
    ]
  }
]

Get Vault Withdrawals By User

get
Path parameters
chainstring · enumRequired

An enumeration.

Possible values:
user_addressstringRequiredExample: 0xe785e0899e7acd50a55f6b517f1f9c46574c9d7c
Query parameters
pageSizeinteger · max: 100OptionalDefault: 20
pageNumintegerOptionalDefault: 1
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/vaults/{chain}/withdrawals/{user_address} HTTP/1.1
Host: api.lfj.dev
Accept: */*
[
  {
    "chain": "avalanche",
    "vaultAddress": "text",
    "userAddress": "text",
    "round": 1,
    "shares": 1
  }
]

Get Vault Withdrawals By User And Vault

get
Path parameters
chainstring · enumRequired

An enumeration.

Possible values:
vault_addressstringRequiredExample: 0xe785e0899e7acd50a55f6b517f1f9c46574c9d7c
user_addressstringRequiredExample: 0xe785e0899e7acd50a55f6b517f1f9c46574c9d7c
Query parameters
pageSizeinteger · max: 100OptionalDefault: 20
pageNumintegerOptionalDefault: 1
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/vaults/{chain}/{vault_address}/withdrawals/{user_address} HTTP/1.1
Host: api.lfj.dev
Accept: */*
[
  {
    "chain": "avalanche",
    "vaultAddress": "text",
    "userAddress": "text",
    "round": 1,
    "shares": 1
  }
]
  • GETList Vaults
  • GETList Vaults By Chain
  • GETGet Vault Share Price
  • GETGet Vault
  • GETGet Vault Tvl History
  • GETGet Vault Recent Activity
  • GETGet Vault Withdrawals By User
  • GETGet Vault Withdrawals By User And Vault