useWinningBid

Get the winning bid for an auction

function useWinningBid(
  contract: RequiredParam<Marketplace>,
  listingId: RequiredParam<BigNumberish>,
): UseQueryResult<undefined | Offer, unknown>;

Parameters


Returns

a response object that includes the Offer that is winning the auction

type ReturnType = UseQueryResult<undefined | Offer, unknown>;

Example

const listingId = 0;
const {
  data: winningBid,
  isLoading,
  error,
} = useWinningBid(contract, listingId);