useDirectListing

Hook to get a specific direct listing from a Marketplace V3 contract.

This hook is only for Marketplace V3 contracts.

For Marketplace contracts, use useListing instead.

Example

import { useDirectListing, useContract } from "@thirdweb-dev/react";
function App() {
const { contract } = useContract(contractAddress, "marketplace-v3");
const {
data: directListing,
isLoading,
error,
} = useDirectListing(contract, listingId);
}
function useDirectListing(
contract: RequiredParam<MarketplaceV3>,
listingId: RequiredParam<BigNumberish>,
): UseQueryResult<DirectListingV3, unknown>;

Parameters

Instance of a marketplace v3 contract

Type

let contract: RequiredParam<MarketplaceV3>;

The ID of the listing to get. If the listing is not found (or is not a direct listing), the error property will be set in the return value of the hook.

Type

let listingId: RequiredParam<BigNumberish>;

Returns

let returnType: UseQueryResult<DirectListingV3, unknown>;

The hook's data property, once loaded, is a DirectListingV3 object, containing the following properties:

{
// The id of the listing.
id: string;
// The address of the creator of listing.
creatorAddress: string;
// The address of the asset being listed.
assetContractAddress: string;
// The ID of the token to list.
tokenId: string;
// 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: string;
// The address of the currency to accept for the listing.
currencyContractAddress: string;
// The `CurrencyValue` of the listing. Useful for displaying the price information.
currencyValuePerToken: CurrencyValue;
// The price to pay per unit of NFTs listed.
pricePerToken: string;
// The asset being listed.
asset: NFTMetadata;
// The start time of the listing.
startTimeInSeconds: number;
// The end time of the listing.
endTimeInSeconds: number;
// Whether the listing is reserved to be bought from a specific set of buyers.
isReservedListing: boolean;
// Whether the listing is CREATED, COMPLETED, or CANCELLED.
status: Status;
}