thirdwebDocs
GitHub

getAuction

Retrieves an auction listing based on the provided options.

Example

import { getListing } from "thirdweb/extensions/marketplace";
const listing = await getListing({ contract, listingId: 1n });
function getAuction(
): Promise<EnglishAuction>;

Parameters

The options for retrieving the listing.

Type

Returns

let returnType: {
asset: NFT;
assetContractAddress: Address;
bidBufferBps: bigint;
buyoutBidAmount: bigint;
buyoutCurrencyValue: GetBalanceResult;
creatorAddress: Address;
currencyContractAddress: Address;
endTimeInSeconds: bigint;
id: bigint;
minimumBidAmount: bigint;
minimumBidCurrencyValue: GetBalanceResult;
quantity: bigint;
startTimeInSeconds: bigint;
status: ListingStatus;
timeBufferInSeconds: bigint;
tokenId: bigint;
type: "english-auction";
};

A promise that resolves to the direct listing.