import type { AlchemyContractMetadataResponse } from '../models/AlchemyContractMetadataResponse'; import type { AlchemyGetContractsForOwnerResponse } from '../models/AlchemyGetContractsForOwnerResponse'; import type { AlchemyGetFloorPriceResponse } from '../models/AlchemyGetFloorPriceResponse'; import type { AlchemyGetNFTsForCollectionResponse } from '../models/AlchemyGetNFTsForCollectionResponse'; import type { AlchemyGetNFTsResponse } from '../models/AlchemyGetNFTsResponse'; import type { AlchemyGetOwnersForCollectionResponse } from '../models/AlchemyGetOwnersForCollectionResponse'; import type { AlchemyGetOwnersForTokenResponse } from '../models/AlchemyGetOwnersForTokenResponse'; import type { AlchemyIsHolderOfCollectionResponse } from '../models/AlchemyIsHolderOfCollectionResponse'; import type { AlchemyNFTMetadata } from '../models/AlchemyNFTMetadata'; import type { AlchemyReingestContractResponse } from '../models/AlchemyReingestContractResponse'; import type { AlchemySearchContractMetadataResponse } from '../models/AlchemySearchContractMetadataResponse'; import type { AlchemySummarizeNFTAttributesResponse } from '../models/AlchemySummarizeNFTAttributesResponse'; import type { TraitsAttributeWithPrevalence } from '../models/TraitsAttributeWithPrevalence'; import type { CancelablePromise } from '../core/CancelablePromise'; import type { BaseHttpRequest } from '../core/BaseHttpRequest'; export declare class AlchemyCompatibleExperimentalService { readonly httpRequest: BaseHttpRequest; constructor(httpRequest: BaseHttpRequest); /** * computeRarity * Computes the rarity of each attribute of an NFT. * @returns TraitsAttributeWithPrevalence OK * @throws ApiError */ alchemyComputeRarity({ apiKey, network, contractAddress, tokenId, }: { /** API Key **/ apiKey?: string; /** Network ID **/ network?: 'arbitrum-mainnet' | 'avalanche-mainnet' | 'bsc-mainnet' | 'celo-mainnet' | 'ethereum-goerli' | 'ethereum-mainnet' | 'ethereum-rinkeby' | 'ethereum-ropsten' | 'fantom-mainnet' | 'harmony-mainnet' | 'optimism-mainnet' | 'polygon-mainnet' | 'solana-mainnet'; /** Contract address for the NFTMetadata collection (ERC721 and ERC1155 supported). **/ contractAddress?: string; /** The ID of the token. Can be in hex or decimal format. **/ tokenId?: string; }): CancelablePromise>; /** * getContractMetadata * Queries NFT high-level collection/contract level information. * @returns AlchemyContractMetadataResponse OK * @throws ApiError */ alchemyGetContractMetadata({ apiKey, network, contractAddress, }: { /** API Key **/ apiKey?: string; /** Network ID **/ network?: 'arbitrum-mainnet' | 'avalanche-mainnet' | 'bsc-mainnet' | 'celo-mainnet' | 'ethereum-goerli' | 'ethereum-mainnet' | 'ethereum-rinkeby' | 'ethereum-ropsten' | 'fantom-mainnet' | 'harmony-mainnet' | 'optimism-mainnet' | 'polygon-mainnet' | 'solana-mainnet'; /** Contract address for the NFTMetadata collection (ERC721 and ERC1155 supported). **/ contractAddress?: string; }): CancelablePromise; /** * getContractsForOwner * Gets all NFT contracts held by an owner address. * @returns AlchemyGetContractsForOwnerResponse OK * @throws ApiError */ alchemyGetContractsForOwner({ owner, apiKey, network, pageKey, }: { /** Address for NFT owner (can be in ENS format!). **/ owner: string; /** API Key **/ apiKey?: string; /** Network ID **/ network?: 'arbitrum-mainnet' | 'avalanche-mainnet' | 'bsc-mainnet' | 'celo-mainnet' | 'ethereum-goerli' | 'ethereum-mainnet' | 'ethereum-rinkeby' | 'ethereum-ropsten' | 'fantom-mainnet' | 'harmony-mainnet' | 'optimism-mainnet' | 'polygon-mainnet' | 'solana-mainnet'; /** key for pagination. If more results are available, a pageKey will be returned in the response. Pass back the pageKey as a param to fetch the next page of results. **/ pageKey?: string | null; }): CancelablePromise; /** * getFloorPrice * Returns the floor prices of a NFT collection by marketplace. * @returns AlchemyGetFloorPriceResponse OK * @throws ApiError */ alchemyGetFloorPrice({ apiKey, network, contractAddress, }: { /** API Key **/ apiKey?: string; /** Network ID **/ network?: 'arbitrum-mainnet' | 'avalanche-mainnet' | 'bsc-mainnet' | 'celo-mainnet' | 'ethereum-goerli' | 'ethereum-mainnet' | 'ethereum-rinkeby' | 'ethereum-ropsten' | 'fantom-mainnet' | 'harmony-mainnet' | 'optimism-mainnet' | 'polygon-mainnet' | 'solana-mainnet'; /** Contract address for the NFTMetadata collection (ERC721 and ERC1155 supported). **/ contractAddress?: string; }): CancelablePromise; /** * getNFTMetadata * Gets the metadata associated with a given NFT. * @returns AlchemyNFTMetadata OK * @throws ApiError */ alchemyGetNftMetadata({ apiKey, network, contractAddress, tokenId, tokenUriTimeoutInMs, }: { /** API Key **/ apiKey?: string; /** Network ID **/ network?: 'arbitrum-mainnet' | 'avalanche-mainnet' | 'bsc-mainnet' | 'celo-mainnet' | 'ethereum-goerli' | 'ethereum-mainnet' | 'ethereum-rinkeby' | 'ethereum-ropsten' | 'fantom-mainnet' | 'harmony-mainnet' | 'optimism-mainnet' | 'polygon-mainnet' | 'solana-mainnet'; /** Contract address for the NFTMetadata collection (ERC721 and ERC1155 supported). **/ contractAddress?: string; /** The ID of the token. Can be in hex or decimal format. **/ tokenId?: string; /** No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to only access the cache and not live fetch any metadata for cache misses then set this value to 0. **/ tokenUriTimeoutInMs?: number | null; }): CancelablePromise; /** * getNFTs * Gets all NFTs currently owned by a given address. * @returns AlchemyGetNFTsResponse OK * @throws ApiError */ alchemyGetNfTs({ apiKey, network, contractAddresses, filters, owner, pageKey, pageSize, tokenUriTimeoutInMs, withMetadata, }: { /** API Key **/ apiKey?: string; /** Network ID **/ network?: 'arbitrum-mainnet' | 'avalanche-mainnet' | 'bsc-mainnet' | 'celo-mainnet' | 'ethereum-goerli' | 'ethereum-mainnet' | 'ethereum-rinkeby' | 'ethereum-ropsten' | 'fantom-mainnet' | 'harmony-mainnet' | 'optimism-mainnet' | 'polygon-mainnet' | 'solana-mainnet'; /** Array of contract addresses to filter the responses with. Max limit 100 contracts. **/ contractAddresses?: Array; /** Filters are not supported **/ filters?: Array; /** Address for NFTMetadata owner (can be in ENS format!). **/ owner?: string; /** key for pagination. If more results are available, a pageKey will be returned in the response. Pass back the pageKey as a param to fetch the next page of results. **/ pageKey?: string | null; /** Number of NFTs to be returned per page. Defaults to 100. Max is 100. **/ pageSize?: number | null; /** No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to only access the cache and not live fetch any metadata for cache misses then set this value to 0. **/ tokenUriTimeoutInMs?: number | null; /** if set to true, returns NFTMetadata metadata. Setting this to false will reduce payload size and may result in a faster API call. Defaults to false. **/ withMetadata?: boolean; }): CancelablePromise; /** * getNFTsForCollection * Gets all NFTs for a given NFT contract. * @returns AlchemyGetNFTsForCollectionResponse OK * @throws ApiError */ alchemyGetNfTsForCollection({ apiKey, network, contractAddress, limit, startToken, tokenUriTimeoutInMs, withMetadata, }: { /** API Key **/ apiKey?: string; /** Network ID **/ network?: 'arbitrum-mainnet' | 'avalanche-mainnet' | 'bsc-mainnet' | 'celo-mainnet' | 'ethereum-goerli' | 'ethereum-mainnet' | 'ethereum-rinkeby' | 'ethereum-ropsten' | 'fantom-mainnet' | 'harmony-mainnet' | 'optimism-mainnet' | 'polygon-mainnet' | 'solana-mainnet'; /** Contract address for the NFTMetadata collection (ERC721 and ERC1155 supported). **/ contractAddress?: string; /** Sets the total number of NFTs returned in the response. Defaults to 100. **/ limit?: number | null; /** A tokenID offset used for pagination. Can be a hex string, or a decimal. Users can specify the offset themselves to start from a custom offset, or to fetch multiple token ranges in parallel. **/ startToken?: string | null; /** No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to only access the cache and not live fetch any metadata for cache misses then set this value to 0. **/ tokenUriTimeoutInMs?: number | null; /** if set to true, returns NFTMetadata metadata. Setting this to false will reduce payload size and may result in a faster API call. Defaults to false. **/ withMetadata?: boolean; }): CancelablePromise; /** * getOwnersForCollection * Gets all owners for a given NFT contract. * @returns AlchemyGetOwnersForCollectionResponse OK * @throws ApiError */ alchemyGetOwnersForCollection({ apiKey, network, contractAddress, pageKey, }: { /** API Key **/ apiKey?: string; /** Network ID **/ network?: 'arbitrum-mainnet' | 'avalanche-mainnet' | 'bsc-mainnet' | 'celo-mainnet' | 'ethereum-goerli' | 'ethereum-mainnet' | 'ethereum-rinkeby' | 'ethereum-ropsten' | 'fantom-mainnet' | 'harmony-mainnet' | 'optimism-mainnet' | 'polygon-mainnet' | 'solana-mainnet'; /** Contract address for the NFTMetadata collection (ERC721 and ERC1155 supported). **/ contractAddress?: string; /** key for pagination. If more results are available, a pageKey will be returned in the response. Pass back the pageKey as a param to fetch the next page of results. **/ pageKey?: string | null; }): CancelablePromise; /** * getOwnersForToken * Get the owner(s) for a token. * @returns AlchemyGetOwnersForTokenResponse OK * @throws ApiError */ alchemyGetOwnersForToken({ apiKey, network, contractAddress, tokenId, }: { /** API Key **/ apiKey?: string; /** Network ID **/ network?: 'arbitrum-mainnet' | 'avalanche-mainnet' | 'bsc-mainnet' | 'celo-mainnet' | 'ethereum-goerli' | 'ethereum-mainnet' | 'ethereum-rinkeby' | 'ethereum-ropsten' | 'fantom-mainnet' | 'harmony-mainnet' | 'optimism-mainnet' | 'polygon-mainnet' | 'solana-mainnet'; /** Contract address for the NFTMetadata collection (ERC721 and ERC1155 supported). **/ contractAddress?: string; /** The ID of the token. Can be in hex or decimal format. **/ tokenId?: string; }): CancelablePromise; /** * isHolderOfCollection * Checks whether a wallet holds a NFT in a given collection. * @returns AlchemyIsHolderOfCollectionResponse OK * @throws ApiError */ alchemyIsHolderOfCollection({ apiKey, network, contractAddress, wallet, }: { /** API Key **/ apiKey?: string; /** Network ID **/ network?: 'arbitrum-mainnet' | 'avalanche-mainnet' | 'bsc-mainnet' | 'celo-mainnet' | 'ethereum-goerli' | 'ethereum-mainnet' | 'ethereum-rinkeby' | 'ethereum-ropsten' | 'fantom-mainnet' | 'harmony-mainnet' | 'optimism-mainnet' | 'polygon-mainnet' | 'solana-mainnet'; /** Contract address for the NFTMetadata collection (ERC721 and ERC1155 supported). **/ contractAddress?: string; /** Wallet address to check for collection ownership. **/ wallet?: string; }): CancelablePromise; /** * reingestContract * Triggers metadata refresh for an entire NFT collection and refreshes stale metadata after a collection reveal/collection changes. * @returns AlchemyReingestContractResponse OK * @throws ApiError */ alchemyReingestContract({ apiKey, network, contractAddress, }: { /** API Key **/ apiKey?: string; /** Network ID **/ network?: 'arbitrum-mainnet' | 'avalanche-mainnet' | 'bsc-mainnet' | 'celo-mainnet' | 'ethereum-goerli' | 'ethereum-mainnet' | 'ethereum-rinkeby' | 'ethereum-ropsten' | 'fantom-mainnet' | 'harmony-mainnet' | 'optimism-mainnet' | 'polygon-mainnet' | 'solana-mainnet'; /** Contract address for the NFTMetadata collection (ERC721 and ERC1155 supported). **/ contractAddress?: string; }): CancelablePromise; /** * searchContractMetadata * Search for a keyword across metadata of all ERC-721 and ERC-1155 smart contracts * @returns AlchemySearchContractMetadataResponse OK * @throws ApiError */ alchemySearchContractMetadata({ query, apiKey, network, }: { /** The search string that you want to search for in contract metadata **/ query: string; /** API Key **/ apiKey?: string; /** Network ID **/ network?: 'arbitrum-mainnet' | 'avalanche-mainnet' | 'bsc-mainnet' | 'celo-mainnet' | 'ethereum-goerli' | 'ethereum-mainnet' | 'ethereum-rinkeby' | 'ethereum-ropsten' | 'fantom-mainnet' | 'harmony-mainnet' | 'optimism-mainnet' | 'polygon-mainnet' | 'solana-mainnet'; }): CancelablePromise; /** * summarizeNFTAttributes * Generate a summary of attribute prevalence for an NFT collection. * @returns AlchemySummarizeNFTAttributesResponse OK * @throws ApiError */ alchemySummarizeNftAttributes({ apiKey, network, contractAddress, }: { /** API Key **/ apiKey?: string; /** Network ID **/ network?: 'arbitrum-mainnet' | 'avalanche-mainnet' | 'bsc-mainnet' | 'celo-mainnet' | 'ethereum-goerli' | 'ethereum-mainnet' | 'ethereum-rinkeby' | 'ethereum-ropsten' | 'fantom-mainnet' | 'harmony-mainnet' | 'optimism-mainnet' | 'polygon-mainnet' | 'solana-mainnet'; /** Contract address for the NFTMetadata collection (ERC721 and ERC1155 supported). **/ contractAddress?: string; }): CancelablePromise; }