Models

The Chain object

Chain

One of: avalanche, arbitrum, base, berachain, binance, ethereum, mantle, monad, solana, sonic

The ChainParam object

ChainParam

One of: all, avalanche, arbitrum, mantle, monad

The ClaimableReward object

ClaimableReward

Field	Type	Required
`market`	`string`	yes
`epoch`	`integer`	yes
`claimableRewards`	array of GetLBPairReward	yes

The DexAnalytics object

DexAnalytics

Field	Type	Required
`date`	`string`	yes
`timestamp`	`integer`	yes
`reserveUsd`	`number`	yes
`reserveNative`	`number`	yes
`volumeUsd`	`number`	yes
`volumeNative`	`number`	yes
`feesUsd`	`number`	yes
`feesNative`	`number`	yes
`protocolFeesUsd`	`number`	yes
`protocolFeesNative`	`number`	yes

The FilterType object

FilterType

One of: 1h, 1d, 7d, 14d, 30d

The GetFarm object

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

The GetLBPairReward object

GetLBPairReward

Field	Type	Required	Description
`amount`	`string`	yes
`tokenAddress`	`string`	yes

The GetPair object

GetPair

Field	Type	Required
`pairAddress`	`string`	yes
`chain`	`avalanche` \| `arbitrum` \| `base` \| `berachain` \| `binance` \| `ethereum` \| `mantle` \| `monad` \| `solana` \| `sonic`	yes
`name`	`string`	yes
`status`	`main` \| `old`	yes
`version`	`v2.0` \| `v2.1` \| `v2.2`	yes
`tokenX`	TokenWrapper	yes
`tokenY`	TokenWrapper	yes
`reserveX`	`number`	yes
`reserveY`	`number`	yes
`lbBinStep`	`integer`	yes
`lbBaseFeePct`	`number`	yes
`lbMaxFeePct`	`number`	yes
`activeBinId`	`integer`
`liquidityUsd`	`number`	yes
`liquidityNative`	`string`	yes
`liquidityDepthMinus`	`number`	yes
`liquidityDepthPlus`	`number`	yes
`liquidityDepthTokenX`	`number`	yes
`liquidityDepthTokenY`	`number`	yes
`volumeUsd`	`number`	yes
`volumeNative`	`string`	yes
`feesUsd`	`number`	yes
`feesNative`	`string`	yes
`protocolSharePct`	`number`

The GetProof object

GetProof

Field	Type	Required
`market`	`string`	yes
`epoch`	`integer`	yes
`token`	`string`	yes

The GetProofBatch object

GetProofBatch

Field	Type	Required	Description
`batch`	array of GetProof	yes

The GetReward object

GetReward

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

The GetRewarder object

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

The GetUserFarmPosition object

GetUserFarmPosition

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

The GetUserRewardHistoryResponse object

GetUserRewardHistoryResponse

Field	Type	Required
`epoch`	`integer`	yes
`epochStart`	`integer`	yes
`epochEnd`	`integer`	yes
`progress`	`number`	yes
`rewards`	array of GetLBPairReward	yes

The GetVault object

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

The GetVaultActivity object

GetVaultActivity

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

The GetVaultPair object

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

The GetVaultStrategy object

GetVaultStrategy

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

The GetVaultTVL object

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

The GetVaultToken object

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

The GetVaultWithdrawal object

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

The HTTPValidationError object

HTTPValidationError

Field	Type	Required	Description
`detail`	array of ValidationError

The PairStatus object

PairStatus

One of: main, old

The PoolSortType object

PoolSortType

One of: liquidity, volume, name

The PoolUserBalance object

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

The QueryStatus object

QueryStatus

One of: main, old, all

The TokenWrapper object

TokenWrapper

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

The UserBinHistory object

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

The UserBinPositionTokenWrapper object

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`

The UserFeesEarnedPerBin object

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

The UserPoolPosition object

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

The UserPoolPositionToken object

UserPoolPositionToken

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

The ValidationError object

ValidationError

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

The VaultBinActivity object

VaultBinActivity

Field	Type	Required
`binId`	`integer`	yes
`amountX`	`integer`	yes
`amountY`	`integer`	yes

The VaultSharePrice object

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

The commonmodelsdex_v2versionPairVersion object

PairVersion

One of: v2.0, v2.1, v2.2

The dexbarnschemasv1basePairVersion object

PairVersion

One of: v2.0, v2.1, v2.2, all

Interfaces

Libraries

Math

Legacy Pools

Models ​

The Chain object ​

The ChainParam object ​

The ClaimableReward object ​

The DexAnalytics object ​

The FilterType object ​

The GetFarm object ​

The GetLBPairReward object ​

The GetPair object ​

The GetProof object ​

The GetProofBatch object ​

The GetReward object ​

The GetRewarder object ​

The GetUserFarmPosition object ​

The GetUserRewardHistoryResponse object ​

The GetVault object ​

The GetVaultActivity object ​

The GetVaultPair object ​

The GetVaultStrategy object ​

The GetVaultTVL object ​

The GetVaultToken object ​

The GetVaultWithdrawal object ​

The HTTPValidationError object ​

The PairStatus object ​

The PoolSortType object ​

The PoolUserBalance object ​

The QueryStatus object ​

The TokenWrapper object ​

The UserBinHistory object ​

The UserBinPositionTokenWrapper object ​

The UserFeesEarnedPerBin object ​

The UserPoolPosition object ​

The UserPoolPositionToken object ​

The ValidationError object ​

The VaultBinActivity object ​

The VaultSharePrice object ​

The common__models__dex_v2__version__PairVersion object ​

The dexbarn__schemas__v1__base__PairVersion object ​