useEnglishAuction

Get an english auction

function useEnglishAuction(
  contract: RequiredParam<MarketplaceV3>,
  auctionId: RequiredParam<BigNumberish>,
): UseQueryResult<EnglishAuction, unknown>;

Parameters


Returns

a response object that includes the desired english auction

type ReturnType = UseQueryResult<EnglishAuction, unknown>;

Example

const auctionId = 0; // the listing id to check
const {
  data: englishAuction,
  isLoading,
  error,
} = useEnglishAuction(contract, auctionId);