thirdwebDocs
GitHub

useListing

Defined in

Hook for getting a specific listing on a Marketplace contract.

This hook is only available for Marketplace contracts

If you are using Marketplace V3 , use useDirectListing or useEnglishAuction instead.

Example

import { useContract, useListing } from "@thirdweb-dev/react";
 
const listingId = 0;
 
function App() {
  const { contract } = useContract(contractAddress, "marketplace");
  const { data, isLoading, error } = useListing(contract, listingId);
}
function useListing(
  contract: RequiredParam<Marketplace>,
  listingId: RequiredParam<BigNumberish>,
): UseQueryResult<AuctionListing | DirectListing, unknown>;

Parameters

Instance of a marketplace contract

Type

let contract: RequiredParam<Marketplace>;

The listing id to check

Type

let listingId: RequiredParam<BigNumberish>;

Returns

let returnType: UseQueryResult<
  unknown
>;

Query Result object that includes the desired listing.

The hook's data property, once loaded, is an object containing the desired listing data.

The exact shape of the object depends on the type of listing.

For auctions, it will be a AuctionListing object. For direct listings, it will be a DirectListing object.

AuctionListing | DirectListing | undefined;

You can use the shared type property to determine which type of listing is being returned.

interface AuctionListing {
  // The id of the listing
  id: string;
 
  // The address of the asset being listed.
  assetContractAddress: string;
 
  // The ID of the token to list.
  tokenId: BigNumberish;
 
  // The asset being listed.
  asset: NFTMetadata;
 
  // The start time of the listing.
  startTimeInEpochSeconds: BigNumberish;
 
  // Number of seconds until the auction expires.
  endTimeInEpochSeconds: BigNumberish;
 
  // The quantity of tokens to include in the listing.
  // For ERC721s, this value should always be 1 (and will be forced internally regardless of what is passed here).
  quantity: BigNumberish;
 
  // The address of the currency to accept for the listing.
  currencyContractAddress: string;
 
  // The reserve price is the minimum price that a bid must be in order to be accepted.
  reservePrice: BigNumber;
 
  // The buyout price of the listing.
  buyoutPrice: BigNumber;
 
  // The `CurrencyValue` of the buyout price listing.
  // Useful for displaying the price information.
  buyoutCurrencyValuePerToken: CurrencyValue;
 
  // The `CurrencyValue` of the reserve price.
  // Useful for displaying the price information.
  reservePriceCurrencyValuePerToken: CurrencyValue;
 
  // The address of the seller.
  sellerAddress: string;
 
  // The type of listing.
  type: ListingType.Auction;
}
 
interface DirectListing {
  // The id of the listing.
  id: string;
 
  // The address of the asset being listed.
  assetContractAddress: string;
 
  // The ID of the token to list.
  tokenId: BigNumberish;
 
  // The asset being listed.
  asset: NFTMetadata;
 
  // The start time of the listing.
  startTimeInSeconds: BigNumberish;
 
  // Number of seconds until the listing expires.
  secondsUntilEnd: BigNumberish;
 
  // The quantity of tokens to include in the listing.
  // For ERC721s, this value should always be 1 (and will be forced internally regardless of what is passed here).
  quantity: BigNumberish;
 
  // The address of the currency to accept for the listing.
  currencyContractAddress: string;
 
  // The `CurrencyValue` of the listing. Useful for displaying the price information.
  buyoutCurrencyValuePerToken: CurrencyValue;
 
  // The buyout price of the listing.
  buyoutPrice: BigNumber;
 
  // The address of the seller.
  sellerAddress: string;
 
  // The type of listing.
  type: ListingType.Direct;
}