alchemy-sdk

import type { BigNumberish } from '@ethersproject/bignumber'; import { BaseNft, ComputeRarityResponse, GetBaseNftsForContractOptions, GetBaseNftsForOwnerOptions, GetContractMetadataBatchResponse, GetContractsForOwnerOptions, GetContractsForOwnerResponse, GetFloorPriceResponse, GetMintedNftsOptions, GetNftMetadataBatchResponse, GetNftMetadataOptions, GetNftSalesOptions, GetNftSalesOptionsByContractAddress, GetNftSalesResponse, GetNftsForContractOptions, GetNftsForOwnerOptions, GetOwnersForContractOptions, GetOwnersForContractResponse, GetOwnersForContractWithTokenBalancesOptions, GetOwnersForContractWithTokenBalancesResponse, GetOwnersForNftOptions, GetOwnersForNftResponse, GetSpamContractsResponse, GetTransfersForContractOptions, IsAirdropNftResponse, IsSpamContractResponse, Nft, NftAttributesResponse, NftCollection, NftContract, NftContractBaseNftsResponse, NftContractNftsResponse, NftMetadataBatchOptions, NftMetadataBatchToken, OwnedBaseNft, OwnedBaseNftsResponse, OwnedNft, OwnedNftsResponse, SearchContractMetadataResponse, TransfersNftResponse } from '../types/nft-types'; import { GetTransfersForOwnerOptions, GetTransfersForOwnerTransferType, RefreshContractResult } from '../types/types'; /** * The NFT namespace contains all the functionality related to NFTs. * * Do not call this constructor directly. Instead, instantiate an Alchemy object * with `const alchemy = new Alchemy(config)` and then access the core namespace * via `alchemy.nft`. */ export declare class NftNamespace { private readonly config; /** * Get the NFT metadata associated with the provided parameters. * * @param contractAddress - The contract address of the NFT. * @param tokenId - Token id of the NFT. * @param options - Options for the request. * @public */ getNftMetadata(contractAddress: string, tokenId: BigNumberish, options?: GetNftMetadataOptions): Promise<Nft>; /** * Gets the NFT metadata for multiple NFT tokens. * * @param tokens An array of NFT tokens to fetch metadata for. * @param options Configuration options for making the request. */ getNftMetadataBatch(tokens: Array<NftMetadataBatchToken>, options?: NftMetadataBatchOptions): Promise<GetNftMetadataBatchResponse>; /** * Get the NFT contract metadata associated with the provided parameters. * * @param contractAddress - The contract address of the NFT. * @public */ getContractMetadata(contractAddress: string): Promise<NftContract>; /** * Get the NFT contract metadata for multiple NFT contracts in a single request. * * @param contractAddresses - An array of contract addresses to fetch metadata for. */ getContractMetadataBatch(contractAddresses: string[]): Promise<GetContractMetadataBatchResponse>; /** * Get the NFT collection metadata associated with the provided parameters. * * @param collectionSlug - The OpenSea collection slug of the NFT. * @beta */ getCollectionMetadata(collectionSlug: string): Promise<NftCollection>; /** * Fetches all NFTs for a given owner and yields them in an async iterable. * * This method returns the full NFT for the owner and pages through all page * keys until all NFTs have been fetched. * * @param owner - The address of the owner. * @param options - The optional parameters to use for the request. * @public */ getNftsForOwnerIterator(owner: string, options?: GetNftsForOwnerOptions): AsyncIterable<OwnedNft>; /** * Fetches all NFTs for a given owner and yields them in an async iterable. * * This method returns the base NFTs that omit the associated metadata and * pages through all page keys until all NFTs have been fetched. * * @param owner - The address of the owner. * @param options - The optional parameters to use for the request. * @public */ getNftsForOwnerIterator(owner: string, options?: GetBaseNftsForOwnerOptions): AsyncIterable<OwnedBaseNft>; /** * Get all base NFTs for an owner. * * This method returns the base NFTs that omit the associated metadata. To get * all NFTs with their associated metadata, use {@link GetNftsForOwnerOptions}. * * @param owner - The address of the owner. * @param options - The optional parameters to use for the request. * @public */ getNftsForOwner(owner: string, options: GetBaseNftsForOwnerOptions): Promise<OwnedBaseNftsResponse>; /** * Get all NFTs for an owner. * * This method returns the full NFTs in the contract. To get all NFTs without * their associated metadata, use {@link GetBaseNftsForOwnerOptions}. * * @param owner - The address of the owner. * @param options - The optional parameters to use for the request. * @public */ getNftsForOwner(owner: string, options?: GetNftsForOwnerOptions): Promise<OwnedNftsResponse>; /** * Get all NFTs for a given contract address. * * This method returns the full NFTs in the contract. To get all NFTs without * their associated metadata, use {@link GetBaseNftsForContractOptions}. * * @param contractAddress - The contract address of the NFT contract. * @param options - The parameters to use for the request. or * {@link NftContractNftsResponse} response. * @beta */ getNftsForContract(contractAddress: string, options?: GetNftsForContractOptions): Promise<NftContractNftsResponse>; /** * Get all base NFTs for a given contract address. * * This method returns the base NFTs that omit the associated metadata. To get * all NFTs with their associated metadata, use {@link GetNftsForContractOptions}. * * @param contractAddress - The contract address of the NFT contract. * @param options - The optional parameters to use for the request. * @beta */ getNftsForContract(contractAddress: string, options?: GetBaseNftsForContractOptions): Promise<NftContractBaseNftsResponse>; /** * Fetches all NFTs for a given contract address and yields them in an async iterable. * * This method returns the full NFTs in the contract and pages through all * page keys until all NFTs have been fetched. To get all NFTs without their * associated metadata, use {@link GetBaseNftsForContractOptions}. * * @param contractAddress - The contract address of the NFT contract. * @param options - The optional parameters to use for the request. * @beta */ getNftsForContractIterator(contractAddress: string, options?: GetNftsForContractOptions): AsyncIterable<Nft>; /** * Fetches all base NFTs for a given contract address and yields them in an * async iterable. * * This method returns the base NFTs that omit the associated metadata and * pages through all page keys until all NFTs have been fetched. To get all * NFTs with their associated metadata, use {@link GetNftsForContractOptions}. * * @param contractAddress - The contract address of the NFT contract. * @param options - The optional parameters to use for the request. * @beta */ getNftsForContractIterator(contractAddress: string, options?: GetBaseNftsForContractOptions): AsyncIterable<BaseNft>; /** * Gets all the owners for a given NFT contract along with the token balance. * * @param contractAddress - The NFT contract to get the owners for. * @param options Optional parameters to use for the request. * @public */ getOwnersForContract(contractAddress: string, options: GetOwnersForContractWithTokenBalancesOptions): Promise<GetOwnersForContractWithTokenBalancesResponse>; /** * Gets all the owners for a given NFT contract. * * Note that token balances are omitted by default. To include token balances * for each owner, use {@link GetOwnersForContractWithTokenBalancesOptions}, * which has the `withTokenBalances` field set to `true`. * * @param contractAddress - The NFT contract to get the owners for. * @param options Optional parameters to use for the request. * @public */ getOwnersForContract(contractAddress: string, options?: GetOwnersForContractOptions): Promise<GetOwnersForContractResponse>; /** * Gets all the owners for a given NFT contract address and token ID. * * @param contractAddress - The NFT contract address. * @param tokenId - Token id of the NFT. * @param options - Optional parameters to use for the request. * @beta */ getOwnersForNft(contractAddress: string, tokenId: BigNumberish, options?: GetOwnersForNftOptions): Promise<GetOwnersForNftResponse>; /** * Gets all NFT contracts held by the specified owner address. * * @param owner - Address for NFT owner (can be in ENS format!). * @param options - The optional parameters to use for the request. * @public */ getContractsForOwner(owner: string, options?: GetContractsForOwnerOptions): Promise<GetContractsForOwnerResponse>; /** * Gets all NFT transfers for a given owner's address. * * @param owner The owner to get transfers for. * @param category Whether to get transfers to or from the owner address. * @param options Additional options for the request. */ getTransfersForOwner(owner: string, category: GetTransfersForOwnerTransferType, options?: GetTransfersForOwnerOptions): Promise<TransfersNftResponse>; /** * Gets all NFT transfers for a given NFT contract address. * * Defaults to all transfers for the contract. To get transfers for a specific * block range, use {@link GetTransfersForContractOptions}. * * @param contract The NFT contract to get transfers for. * @param options Additional options for the request. */ getTransfersForContract(contract: string, options?: GetTransfersForContractOptions): Promise<TransfersNftResponse>; /** * Get all the NFTs minted by a specified owner address. * * @param owner - Address for the NFT owner (can be in ENS format). * @param options - The optional parameters to use for the request. */ getMintedNfts(owner: string, options?: GetMintedNftsOptions): Promise<TransfersNftResponse>; /** * Checks that the provided owner address owns one of more of the provided * NFT. Returns a boolean indicating whether the owner address owns the provided NFT. * * @param owner - The owner address to check. * @param contractAddress - An NFT contract address to check ownership for. */ verifyNftOwnership(owner: string, contractAddress: string): Promise<boolean>; /** * Checks which of the provided NFTs the owner address owns. Returns a map of * contract address to a boolean indicating whether the owner address owns the NFT. * * @param owner - The owner address to check. * @param contractAddresses - An array NFT contract address to check ownership for. */ verifyNftOwnership(owner: string, contractAddresses: string[]): Promise<{ [contractAddress: string]: boolean; }>; /** * Returns whether a contract is marked as spam or not by Alchemy. For more * information on how we classify spam, go to our NFT API FAQ at * https://docs.alchemy.com/alchemy/enhanced-apis/nft-api/nft-api-faq#nft-spam-classification. * * @param contractAddress - The contract address to check. */ isSpamContract(contractAddress: string): Promise<IsSpamContractResponse>; /** * Returns a list of all spam contracts marked by Alchemy. For details on how * Alchemy marks spam contracts, go to * https://docs.alchemy.com/alchemy/enhanced-apis/nft-api/nft-api-faq#nft-spam-classification. */ getSpamContracts(): Promise<GetSpamContractsResponse>; /** * Returns whether a contract is marked as spam or not by Alchemy. For more * information on how we classify spam, go to our NFT API FAQ at * https://docs.alchemy.com/alchemy/enhanced-apis/nft-api/nft-api-faq#nft-spam-classification. * * @param contractAddress - The contract address to check. */ reportSpam(contractAddress: string): Promise<void>; /** * Returns whether a token is marked as an airdrop or not. * Airdrops are defined as NFTs that were minted to a user address in a transaction * sent by a different address. * * @param contractAddress - The contract address to check. * @param tokenId - Token id of the NFT. */ isAirdropNft(contractAddress: string, tokenId: string): Promise<IsAirdropNftResponse>; /** * Returns the floor prices of a NFT contract by marketplace. * * @param contractAddress - The contract address for the NFT collection. * @beta */ getFloorPrice(contractAddress: string): Promise<GetFloorPriceResponse>; /** * Returns NFT sales that have happened through on-chain marketplaces. * * @param options - The optional parameters to use for the request. * @beta */ getNftSales(options?: GetNftSalesOptions): Promise<GetNftSalesResponse>; getNftSales(options?: GetNftSalesOptionsByContractAddress): Promise<GetNftSalesResponse>; /** * Get the rarity of each attribute of an NFT. * * @param contractAddress - Contract address for the NFT collection. * @param tokenId - Token id of the NFT. */ computeRarity(contractAddress: string, tokenId: BigNumberish): Promise<ComputeRarityResponse>; /** * Search for a keyword across metadata of all ERC-721 and ERC-1155 smart contracts. * * @param query - The search string that you want to search for in contract metadata. */ searchContractMetadata(query: string): Promise<SearchContractMetadataResponse>; /** * Get a summary of attribute prevalence for an NFT collection. * * @param contractAddress - Contract address for the NFT collection. */ summarizeNftAttributes(contractAddress: string): Promise<NftAttributesResponse>; /** * Refreshes the cached metadata for a provided NFT contract address and token * id. Returns a boolean value indicating whether the metadata was refreshed. * * This method is useful when you want to refresh the metadata for a NFT that * has been updated since the last time it was fetched. Note that the backend * only allows one refresh per token every 15 minutes, globally for all users. * The last refresh time for an NFT can be accessed on the * {@link Nft.timeLastUpdated} field. * * To trigger a refresh for all NFTs in a contract, use {@link refreshContract} instead. * * @param contractAddress - The contract address of the NFT. * @param tokenId - The token id of the NFT. */ refreshNftMetadata(contractAddress: string, tokenId: BigNumberish): Promise<boolean>; /** * Triggers a metadata refresh all NFTs in the provided contract address. This * method is useful after an NFT collection is revealed. * * Refreshes are queued on the Alchemy backend and may take time to fully * process. To refresh the metadata for a specific token, use the * {@link refreshNftMetadata} method instead. * * @param contractAddress - The contract address of the NFT collection. * @beta */ refreshContract(contractAddress: string): Promise<RefreshContractResult>; }