Get Pool

Returns an NFT pool.

Endpoint: getNftPool

Method: POST

Arguments

NameTypeDescription
addressString!

The contract address of the NFT pool.

Required
networkIdInt!

The network ID the NFT collection is deployed on.

Required

Response

NameTypeDescription
acceptedNftTokenIds[String]For ERC1155 pools, the list of NFT token IDs that are accepted by the pool.
assetRecipientAddressString!The wallet address that will receive the tokens or NFT sent to the pair during swaps.
balanceNBTString!The current pool liquidity in the network's base token.
balanceTString!The current pool liquidity in the pool's liquidity token.
bondingCurveAddressString!The contract address of the bonding curve.
bondingCurveTypeBondingCurveType!The bonding curve type that defines how the prices of NFTs change after each buy or sell within a pool.
collectionAddressString!The contract address of the NFT collection.
collectionNameString!The contract name of the NFT collection.
collectionSymbolStringThe symbol of the NFT collection.
deltaString!The current delta used in the bonding curve.
exchangeAddressString!The contract address of the NFT AMM marketplace.
feeString!The current fee for pool.
floorNBTStringThe current price at which the pool is willing to sell an NFT in the network's base token. Only applicable for SELL and BUY_AND_SELL pool types.
floorTStringThe current price at which the pool is willing to sell an NFT in the pool's liquidity token. Only applicable for SELL and BUY_AND_SELL pool types.
networkIdInt!The network ID the NFT collection is deployed on.
nftAssets[NftAsset]The list of NFT assets in the pool.
nftBalanceV2String!The current number of NFTs in the pool.
nftVolumeAllTimeV2String!The total number of NFTs bought and sold over the pool's lifetime.
offerNBTStringThe current price at which the pool is willing to buy an NFT in the network's base token. Only applicable for BUY and BUY_AND_SELL pool types.
offerTStringThe current price at which the pool is willing to buy an NFT in the pool's liquidity token. Only applicable for BUY and BUY_AND_SELL pool types.
ownerString!The wallet address of the pool owner.
poolAddressString!The contract address of the NFT pool.
poolFeesAllTimeNBTString
poolFeesAllTimeTString
poolIdString!The ID of the NFT pool (poolAddress:networkId). For example, 0xdbea289dcc10eed8431e78753414a3d81b8e7201:1.
poolNftTypePoolNftTypeThe type of NFT in the pool.
poolTypeNftPoolType!The type of liquidity pool.
poolVariantGraphQlNftPoolVariant!The pool variant. Can be ERC20 or NATIVE.
propertyCheckerStringThe property checker contract address for the pool.
royalties[NftPoolRoyalty]The list of royalties for the pool. Only applicable for SUDOSWAP_V2 pools.
spotPriceNBTString!The spot price in the network's base token.
spotPriceTString!The instantaneous price for selling 1 NFT to the pool in the pool's liquidity token.
tokenAddressString!The contract address of the liquidity token of the pool (usually WETH).
versionNftPoolContractVersionThe NFT pool contract version. Can be SUDOSWAP_V1 or SUDOSWAP_V2.
volumeAllTimeNBTString!The total volume of the pool in the network's base token over the pool's lifetime.
volumeAllTimeTString!The total volume of the pool in the pool's liquidity token over the pool's lifetime.

Explore

πŸ‘‹

Join our Discord

Ask questions, share what you're working on and request new features πŸ‘¬πŸ‘­