diff --git a/nft/nfts.yaml b/nft/nfts.yaml index 48aa3f67..88abc5c0 100644 --- a/nft/nfts.yaml +++ b/nft/nfts.yaml @@ -2,7 +2,7 @@ openapi: 3.1.0 info: title: 🎨 NFT API version: '1.0' -servers: # servers are also specified at the method level, if there ins't a specification then the server is supported on all the networks below +servers: # servers are also specified at the method level, if there isn't a specification then the server is supported on all the networks below - url: https://{network}.g.alchemy.com/nft variables: network: @@ -42,9 +42,9 @@ paths: ## Below are all the v3 methods '/v3/{apiKey}/getNFTsForOwner': get: - summary: getNFTsForOwner - description: Gets all NFTs currently owned by a given address. - tags: ['Ownership & Token Gating'] + summary: NFTs By Owner + description: getNFTsForOwner - Retrieves all NFTs currently owned by a specified address. + tags: ['NFT Ownership Endpoints'] parameters: - $ref: '#/components/schemas/owner' - $ref: '#/components/schemas/contractAddresses' @@ -92,11 +92,114 @@ paths: withPagination: $ref: '#/components/schemas/v3withPagination_response' operationId: getNFTsForOwner-v3 + '/v3/{apiKey}/getNFTsForContract': + get: + summary: NFTs By Contract + description: getNFTsForContract - Retrieves all NFTs associated with a specific NFT contract. + tags: ['NFT Metadata Endpoints'] + parameters: + - $ref: '#/components/schemas/apiKey' + - $ref: '#/components/schemas/contractAddress' + required: true + - $ref: '#/components/schemas/withMetadata' + - $ref: '#/components/schemas/startToken' + - $ref: '#/components/schemas/limit' + - $ref: '#/components/schemas/tokenUriTimeoutInMs' + x-readme: + samples-languages: + - javascript + - curl + - python + - go + responses: + '200': + description: 'Returns a list of NFTs associated with the specified contract address.' + content: + application/json: + schema: + type: object + properties: + nfts: + description: 'List of objects that represent NFTs stored under the queried contract address.' + type: array + items: + $ref: '#/components/schemas/ownedNFTv3' + pageKey: + type: string + description: 'String - An offset used for pagination. Can be passed back as the "startToken" of a subsequent request to get the next page of results. Absent if there are no more results.' + operationId: getNFTsForContract-v3 + '/v3/{apiKey}/getNFTsForCollection': + get: + summary: NFTs By Collection + description: getNFTsForCollection - Retrieves all NFTs associated with a specific NFT collection. + tags: ['NFT Metadata Endpoints'] + parameters: + - $ref: '#/components/schemas/apiKey' + - $ref: '#/components/schemas/contractAddress' + - $ref: '#/components/schemas/collectionSlug' + - $ref: '#/components/schemas/withMetadata' + - $ref: '#/components/schemas/startToken' + - $ref: '#/components/schemas/limit' + - $ref: '#/components/schemas/tokenUriTimeoutInMs' + x-readme: + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Github: https://github.com/alchemyplatform/alchemy-sdk-js + // Setup: npm install alchemy-sdk + import { Network, Alchemy } from "alchemy-sdk"; + + // Optional Config object, but defaults to demo api-key and eth-mainnet. + const settings = { + apiKey: "demo", // Replace with your Alchemy API Key. + network: Network.ETH_MAINNET, // Replace with your network. + }; + + const alchemy = new Alchemy(settings); + + // Print total NFT collection returned in the response: + alchemy.nft + .getNftsForContract("0x61fce80d72363b731425c3a2a46a1a5fed9814b2") + .then(console.log); + responses: + '200': + description: 'Returns a list of NFTs associated with the specified collection.' + content: + application/json: + schema: + type: object + properties: + nfts: + description: 'List of objects that represent NFTs stored under the queried contract address or collection slug.' + type: array + items: + type: object + properties: + id: + $ref: '#/components/schemas/idV3' + tokenUri: + $ref: '#/components/schemas/tokenUri' + metadata: + $ref: '#/components/schemas/metadata' + timeLastUpdated: + type: string + description: 'String - ISO timestamp of the last cache refresh for the information returned in the metadata field.' + contractMetadata: + $ref: '#/components/schemas/contractMetadata' + nextToken: + type: string + description: 'String - An offset used for pagination. Can be passed back as the "startToken" of a subsequent request to get the next page of results. Absent if there are no more results.' + operationId: getNFTsForCollection-v3 '/v3/{apiKey}/getNFTMetadata': get: - summary: getNFTMetadata - description: Gets the metadata associated with a given NFT. - tags: ['NFT Metadata Access'] + summary: NFT Metadata By Token ID + description: getNFTMetadata - Retrieves the metadata associated with a specific NFT. + tags: ['NFT Metadata Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/contractAddress' @@ -114,7 +217,7 @@ paths: - go responses: '200': - description: '' + description: 'Returns the metadata of the specified NFT.' content: application/json: schema: @@ -122,9 +225,9 @@ paths: operationId: getNFTMetadata-v3 '/v3/{apiKey}/getNFTMetadataBatch': post: - summary: getNFTMetadataBatch - description: Gets the metadata associated with up to 100 given NFT contracts. - tags: ['NFT Metadata Access'] + summary: NFT Metadata By Token ID [Batch] + description: getNFTMetadataBatch - Retrieves metadata for up to 100 specified NFT contracts in a single request. + tags: ['NFT Metadata Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' requestBody: @@ -173,7 +276,7 @@ paths: - go responses: '200': - description: '' + description: 'Returns an array of NFT metadata corresponding to the batch query.' content: application/json: schema: @@ -184,9 +287,9 @@ paths: operationId: getNFTMetadataBatch-v3 '/v3/{apiKey}/getContractMetadata': get: - summary: getContractMetadata - description: Queries NFT high-level collection/contract level information. - tags: ['NFT Metadata Access'] + summary: Contract Metadata By Address + description: getContractMetadata - Retrieves high-level collection or contract-level information for an NFT. + tags: ['NFT Metadata Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/contractAddress' @@ -199,7 +302,7 @@ paths: - go responses: '200': - description: '' + description: 'Returns the contract metadata for the specified address.' content: application/json: schema: @@ -207,9 +310,9 @@ paths: operationId: getContractMetadata-v3 '/v3/{apiKey}/getCollectionMetadata': get: - summary: getCollectionMetadata - description: Queries NFT high-level collection/contract level information. - tags: ['NFT Metadata Access'] + summary: Collection Metadata By Slug + description: getCollectionMetadata - Retrieves high-level collection or contract-level information for an NFT collection. + tags: ['NFT Metadata Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/collectionSlug' @@ -222,7 +325,7 @@ paths: - go responses: '200': - description: '' + description: 'Returns the collection metadata for the specified slug.' content: application/json: schema: @@ -230,9 +333,9 @@ paths: operationId: getCollectionMetadata-v3 '/v3/{apiKey}/invalidateContract': get: - summary: invalidateContract - description: Marks all cached tokens for the particular contract as stale. So the next time the endpoint is queried it fetches live data instead of fetching from cache. - tags: ['NFT Metadata Access'] + summary: Invalidate Contract Cache + description: invalidateContract - Marks all cached tokens for the specified contract as stale, ensuring the next query fetches live data instead of cached data. + tags: ['NFT Metadata Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/contractAddress' @@ -244,7 +347,7 @@ paths: - python responses: '200': - description: '' + description: 'Returns confirmation of cache invalidation along with the number of tokens invalidated.' content: application/json: schema: @@ -260,9 +363,9 @@ paths: operationId: invalidateContract-v3 '/v3/{apiKey}/getContractMetadataBatch': post: - summary: getContractMetadataBatch - description: Gets the metadata associated with the given list of contract addresses - tags: ['NFT Metadata Access'] + summary: Contract Metadata By Address [Batch] + description: getContractMetadataBatch - Retrieves metadata for a list of specified contract addresses in a single request. + tags: ['NFT Metadata Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' requestBody: @@ -273,7 +376,7 @@ paths: properties: contractAddresses: type: array - description: list of contract addresses to batch metadata requests for + description: List of contract addresses to batch metadata requests for. default: [ '0xe785E82358879F061BC3dcAC6f0444462D4b5330', @@ -281,29 +384,6 @@ paths: ] items: $ref: '#/components/schemas/contractAddress' - responses: - '200': - description: '' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/contractMetadatav3' - operationId: getContractMetadataBatch-v3 - '/v3/{apiKey}/getNFTsForContract': - get: - summary: getNFTsForContract - description: Gets all NFTs for a given NFT contract. - tags: ['NFT Metadata Access'] - parameters: - - $ref: '#/components/schemas/apiKey' - - $ref: '#/components/schemas/contractAddress' - required: true - - $ref: '#/components/schemas/withMetadata' - - $ref: '#/components/schemas/startToken' - - $ref: '#/components/schemas/limit' - - $ref: '#/components/schemas/tokenUriTimeoutInMs' x-readme: samples-languages: - javascript @@ -312,93 +392,20 @@ paths: - go responses: '200': - description: '' - content: - application/json: - schema: - type: object - properties: - nfts: - description: 'List of objects that represent NFTs stored under the queried contract address.' - type: array - items: - $ref: '#/components/schemas/ownedNFTv3' - pageKey: - type: string - description: 'String - An offset used for pagination. Can be passed back as the "startToken" of a subsequent request to get the next page of results. Absent if there are no more results.' - operationId: getNFTsForContract-v3 - '/v3/{apiKey}/getNFTsForCollection': - get: - summary: getNFTsForCollection - description: Gets all NFTs for a given NFT contract. - tags: ['NFT Metadata Access'] - parameters: - - $ref: '#/components/schemas/apiKey' - - $ref: '#/components/schemas/contractAddress' - - $ref: '#/components/schemas/collectionSlug' - - $ref: '#/components/schemas/withMetadata' - - $ref: '#/components/schemas/startToken' - - $ref: '#/components/schemas/limit' - - $ref: '#/components/schemas/tokenUriTimeoutInMs' - x-readme: - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Github: https://github.com/alchemyplatform/alchemy-sdk-js - // Setup: npm install alchemy-sdk - import { Network, Alchemy } from "alchemy-sdk"; - - // Optional Config object, but defaults to demo api-key and eth-mainnet. - const settings = { - apiKey: "demo", // Replace with your Alchemy API Key. - network: Network.ETH_MAINNET, // Replace with your network. - }; - - const alchemy = new Alchemy(settings); - - // Print total NFT collection returned in the response: - alchemy.nft - .getNftsForContract("0x61fce80d72363b731425c3a2a46a1a5fed9814b2") - .then(console.log); - responses: - '200': - description: '' + description: 'Returns an array of contract metadata corresponding to the batch query.' content: application/json: schema: - type: object - properties: - nfts: - description: 'List of objects that represent NFTs stored under the queried contract address or collection slug.' - type: array - items: - type: object - properties: - id: - $ref: '#/components/schemas/idV3' - tokenUri: - $ref: '#/components/schemas/tokenUri' - metadata: - $ref: '#/components/schemas/metadata' - timeLastUpdated: - type: string - description: 'String - ISO timestamp of the last cache refresh for the information returned in the metadata field.' - contractMetadata: - $ref: '#/components/schemas/contractMetadata' - nextToken: - type: string - description: 'String - An offset used for pagination. Can be passed back as the "startToken" of a subsequent request to get the next page of results. Absent if there are no more results.' - operationId: getNFTsForCollection-v3 + type: array + description: 'Array of contract metadata objects corresponding to the query.' + items: + $ref: '#/components/schemas/contractMetadatav3' + operationId: getContractMetadataBatch-v3 '/v3/{apiKey}/getOwnersForNFT': get: - summary: getOwnersForNFT - description: Get the owner(s) for a token. - tags: ['Ownership & Token Gating'] + summary: Owners By NFT + description: getOwnersForNFT - Retrieves the owner(s) for a specific token. + tags: ['NFT Ownership Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/contractAddress' @@ -413,7 +420,7 @@ paths: - go responses: '200': - description: '' + description: 'Returns the owner(s) of the specified NFT.' content: application/json: schema: @@ -429,9 +436,9 @@ paths: operationId: getOwnersForNFT-v3 '/v3/{apiKey}/getOwnersForContract': get: - summary: getOwnersForContract - description: Gets all owners for a given NFT contract. - tags: ['Ownership & Token Gating'] + summary: Owners By Contract + description: getOwnersForContract - Retrieves all owners associated with a specific NFT contract. + tags: ['NFT Ownership Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/contractAddress' @@ -448,14 +455,14 @@ paths: - go responses: '200': - description: '' + description: 'Returns a list of all owners for the specified contract.' content: application/json: schema: type: object properties: owners: - description: 'List of all addresses that own one of the NFTs from the queried contract address. The below format is applicable when `withTokenBalances=true`' + description: 'List of all addresses that own one of the NFTs from the queried contract address. The format is applicable when `withTokenBalances=true`.' type: array items: type: object @@ -467,9 +474,9 @@ paths: operationId: getOwnersForContract-v3 '/v3/{apiKey}/getSpamContracts': get: - summary: getSpamContracts - description: Returns a list of all spam contracts marked by Alchemy. - tags: ['Spam Detection'] + summary: Spam Contracts + description: getSpamContracts - Returns a list of all spam contracts marked by Alchemy. + tags: ['NFT Spam Endpoints'] servers: - url: https://{network}.g.alchemy.com/nft variables: @@ -488,24 +495,24 @@ paths: - go responses: '200': - description: '' + description: 'Returns a list of all spam contracts marked by Alchemy.' content: application/json: schema: type: object - description: Object that has list of contract addresses + description: Object that contains a list of contract addresses. properties: contractAddresses: type: array items: type: string - description: A list of contract addresses earmarked as spam by Alchemy. + description: 'A list of contract addresses earmarked as spam by Alchemy.' operationId: getSpamContracts-v3 '/v3/{apiKey}/isSpamContract': get: - summary: isSpamContract - description: Returns whether a contract is marked as spam or not by Alchemy. - tags: ['Spam Detection'] + summary: Is Spam Contract + description: isSpamContract - Determines whether a specific contract is marked as spam by Alchemy. + tags: ['NFT Spam Endpoints'] servers: - url: https://{network}.g.alchemy.com/nft variables: @@ -526,12 +533,12 @@ paths: - go responses: '200': - description: '' + description: 'Returns whether the specified contract is marked as spam.' content: application/json: schema: type: object - description: 'This object has the boolean value inside it' + description: 'This object contains a boolean value indicating the spam status of the contract.' properties: isSpamContract: type: boolean @@ -539,9 +546,9 @@ paths: operationId: isSpamContract-v3 '/v3/{apiKey}/isAirdropNFT': get: - summary: isAirdropNFT - description: 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. - tags: ['Spam Detection'] + summary: Is Airdrop NFT + description: isAirdropNFT - Determines whether a specific token is marked as an airdrop. Airdrops are defined as NFTs minted to a user address in a transaction sent by a different address. + tags: ['NFT Spam Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/contractAddress' @@ -556,12 +563,12 @@ paths: - go responses: '200': - description: '' + description: 'Returns whether the specified token is marked as an airdrop.' content: application/json: schema: type: object - description: 'This object has the boolean value inside it' + description: 'This object contains a boolean value indicating whether the token is an airdrop.' properties: isAirdrop: type: boolean @@ -569,9 +576,9 @@ paths: operationId: isAirdropNFT-v3 '/v3/{apiKey}/summarizeNFTAttributes': get: - summary: summarizeNFTAttributes - description: Generate a summary of attribute prevalence for an NFT collection. - tags: ['Rarity Data'] + summary: Attributes Summary By Contract + description: summarizeNFTAttributes - Generates a summary of attribute prevalence for a specific NFT collection. + tags: ['NFT Metadata Endpoints'] servers: - url: https://{network}.g.alchemy.com/nft variables: @@ -592,7 +599,7 @@ paths: - go responses: '200': - description: '' + description: 'Returns a summary of attribute prevalence for the specified NFT collection.' content: application/json: schema: @@ -612,9 +619,9 @@ paths: operationId: summarizeNFTAttributes-v3 '/v3/{apiKey}/getFloorPrice': get: - summary: getFloorPrice - description: Returns the floor prices of a NFT collection by marketplace. - tags: ['Sales & Marketplace Data'] + summary: Floor Prices By Slug + description: getFloorPrice - Retrieves the floor prices of an NFT collection across different marketplaces. + tags: ['NFT Sales Endpoints'] servers: - url: https://{network}.g.alchemy.com/nft variables: @@ -634,7 +641,7 @@ paths: - go responses: '200': - description: '' + description: 'Returns the floor prices of the specified NFT collection across different marketplaces.' content: application/json: schema: @@ -664,9 +671,9 @@ paths: operationId: getFloorPrice-v3 '/v3/{apiKey}/searchContractMetadata': get: - summary: searchContractMetadata - description: Search for a keyword across metadata of all ERC-721 and ERC-1155 smart contracts - tags: ['NFT Metadata Access'] + summary: Search Contract Metadata + description: searchContractMetadata - Searches for a keyword across metadata of all ERC-721 and ERC-1155 smart contracts. + tags: ['NFT Metadata Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/query' @@ -689,9 +696,9 @@ paths: operationId: searchContractMetadata-v3 '/v3/{apiKey}/isHolderOfContract': get: - summary: isHolderOfContract - description: Checks whether a wallet holds a NFT from a given contract - tags: ['Ownership & Token Gating'] + summary: Is Holder Of Contract + description: isHolderOfContract - Determines whether a specific wallet holds any NFT from a given contract. + tags: ['NFT Ownership Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/wallet' @@ -705,7 +712,7 @@ paths: - go responses: '200': - description: '' + description: 'Returns whether the specified wallet holds any NFT from the given contract.' content: application/json: schema: @@ -718,9 +725,9 @@ paths: operationId: isHolderOfContract-v3 '/v3/{apiKey}/computeRarity': get: - summary: computeRarity - description: Computes the rarity of each attribute of an NFT. - tags: ['Rarity Data'] + summary: Attribute Rarity By NFT + description: computeRarity - Calculates the rarity of each attribute within an NFT. + tags: ['NFT Metadata Endpoints'] servers: - url: https://{network}.g.alchemy.com/nft variables: @@ -743,12 +750,12 @@ paths: - go responses: '200': - description: '' + description: 'Returns the rarity information for each attribute of the specified NFT.' content: application/json: schema: type: object - description: Object containing the rarity info of the collection + description: 'Object containing the rarity info of the collection.' properties: rarities: type: array @@ -758,19 +765,19 @@ paths: properties: trait_type: type: string - description: 'Name of the trait category, i.e. Hat, Color, Face, etc.' + description: 'Name of the trait category, i.e., Hat, Color, Face, etc.' value: type: string - description: 'Value for the trait, i.e. White Cap, Blue, Angry, etc.' + description: 'Value for the trait, i.e., White Cap, Blue, Angry, etc.' prevalence: type: number description: 'Floating point value from 0 to 1 representing the prevalence of this value for this trait type.' operationId: computeRarity-v3 '/v3/{apiKey}/getNFTSales': get: - summary: getNFTSales - description: Gets NFT sales that have happened through on-chain marketplaces - tags: ['Sales & Marketplace Data'] + summary: NFT Sales + description: getNFTSales - Retrieves NFT sales that have occurred through on-chain marketplaces. + tags: ['NFT Sales Endpoints'] servers: - url: https://{network}.g.alchemy.com/nft variables: @@ -787,7 +794,7 @@ paths: - $ref: '#/components/schemas/order' - $ref: '#/components/schemas/marketplace' - $ref: '#/components/schemas/contractAddress' - description: String - The contract address of a NFT collection to filter sales by. Defaults to returning all NFT contracts. + description: String - The contract address of an NFT collection to filter sales by. Defaults to returning all NFT contracts. - $ref: '#/components/schemas/tokenIdForNFTSales' description: String - The token ID of an NFT within the collection specified by contractAddress to filter sales by. Defaults to returning all token IDs. - $ref: '#/components/schemas/buyerAddress' @@ -804,14 +811,14 @@ paths: - go responses: '200': - description: '' + description: 'Returns a list of NFT sales that match the query parameters.' content: application/json: schema: type: object properties: nftSales: - description: 'List of NFT sales that match the query' + description: 'List of NFT sales that match the query.' type: array items: type: object @@ -845,7 +852,7 @@ paths: - SELLER sellerFee: type: object - description: The payment from buyer to the seller + description: The payment from buyer to the seller. properties: amount: type: string @@ -861,7 +868,7 @@ paths: description: Integer - The number of decimals of the token used for the payment. protocolFee: type: object - description: The payment from buyer to the NFT marketplace protocol + description: The payment from buyer to the NFT marketplace protocol. properties: amount: type: string @@ -877,7 +884,7 @@ paths: description: Integer - The number of decimals of the token used for the payment. royaltyFee: type: object - description: The payment from buyer to the royalty address of the NFT collection + description: The payment from buyer to the royalty address of the NFT collection. properties: amount: type: string @@ -914,9 +921,9 @@ paths: operationId: getNFTSales-v3 '/v3/{apiKey}/getContractsForOwner': get: - summary: getContractsForOwner - description: Gets all NFT contracts held by an owner address. - tags: ['NFT Metadata Access'] + summary: Contracts By Owner + description: getContractsForOwner - Retrieves all NFT contracts held by a specified owner address. + tags: ['NFT Ownership Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/owner' @@ -935,7 +942,7 @@ paths: - go responses: '200': - description: '' + description: 'Returns a list of NFT contracts held by the specified owner address.' content: application/json: schema: @@ -957,9 +964,9 @@ paths: operationId: getContractsForOwner-v3 '/v3/{apiKey}/getCollectionsForOwner': get: - summary: getCollectionsForOwner - description: Gets all NFT collections held by an owner address. - tags: ['NFT Metadata Access'] + summary: Collections By Owner + description: getCollectionsForOwner - Retrieves all NFT collections held by a specified owner address. + tags: ['NFT Ownership Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/owner' @@ -976,7 +983,7 @@ paths: - go responses: '200': - description: '' + description: 'Returns a list of NFT collections held by the specified owner address.' content: application/json: schema: @@ -999,9 +1006,9 @@ paths: operationId: getCollectionsForOwner-v3 '/v3/{apiKey}/reportSpam': get: - summary: reportSpam - description: Report a particular address to our APIs if you think it is spam - tags: ['Spam Detection'] + summary: Report Spam Address + description: reportSpam - Reports a specific address to the API if it is suspected to be spam. + tags: ['NFT Spam Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/address' @@ -1014,18 +1021,18 @@ paths: - go responses: '200': - description: '' + description: 'Returns a confirmation message if the address was successfully reported as spam.' content: application/json: schema: type: string - description: 'String - "Address was successfully reported as spam" if calling the API was successful. ' + description: 'String - "Address was successfully reported as spam" if calling the API was successful.' operationId: reportSpam-v3 '/v3/{apiKey}/refreshNftMetadata': post: - summary: refreshNftMetadata - description: Submit a request that Alchemy refresh the cached NFT metadata for a particular token. - tags: ['NFT Metadata Access'] + summary: Refresh NFT Metadata + description: refreshNftMetadata - Submits a request for Alchemy to refresh the cached metadata of a specific NFT token. + tags: ['NFT Metadata Endpoints'] parameters: - $ref: '#/components/schemas/apiKey' x-readme: @@ -1052,7 +1059,7 @@ paths: default: '44' responses: '200': - description: '' + description: 'Returns the status of the refresh request along with the estimated time to complete.' content: application/json: schema: @@ -1060,15 +1067,16 @@ paths: properties: status: type: string - description: 'If the token is successfully queued for ingestion the value will be "Queued"' + description: 'If the token is successfully queued for ingestion the value will be "Queued".' estimatedMsToRefresh: type: string - description: 'Estimated time until we are done refreshing metadata for this token' + description: 'Estimated time until the metadata refresh is complete for this token.' examples: byDefault: $ref: '#/components/schemas/refreshNftMetadata_response' operationId: refreshNftMetadata-v3 ## End of v3 methods + ## ## Below are all the v2 methods ## diff --git a/token/alchemy_getTokenAllowance.yaml b/token/alchemy_getTokenAllowance.yaml index ee4e18f5..0974dffc 100644 --- a/token/alchemy_getTokenAllowance.yaml +++ b/token/alchemy_getTokenAllowance.yaml @@ -45,8 +45,8 @@ x-sandbox: paths: /{apiKey}: post: - summary: alchemy_getTokenAllowance - description: 'Returns the amount which the spender is allowed to withdraw from the owner.' + summary: Token Allowance By Spender & Owner + description: 'alchemy_getTokenAllowance - Returns the amount which the spender is allowed to withdraw from the owner.' tags: [] parameters: - name: apiKey diff --git a/token/alchemy_getTokenBalances.yaml b/token/alchemy_getTokenBalances.yaml index 08285925..4047d34f 100644 --- a/token/alchemy_getTokenBalances.yaml +++ b/token/alchemy_getTokenBalances.yaml @@ -45,8 +45,8 @@ x-sandbox: paths: /{apiKey}: post: - summary: alchemy_getTokenBalances - description: 'Returns ERC20 token balances for all tokens the given address has ever transacted in with. Optionally accepts a list of contracts.' + summary: Token Balances By Wallet + description: 'alchemy_getTokenBalances - Returns ERC20 token balances for all tokens the given address has ever transacted in with. Optionally accepts a list of contracts.' tags: [] parameters: - name: apiKey diff --git a/token/alchemy_getTokenMetadata.yaml b/token/alchemy_getTokenMetadata.yaml index 0aea7da8..5f8906a2 100644 --- a/token/alchemy_getTokenMetadata.yaml +++ b/token/alchemy_getTokenMetadata.yaml @@ -45,8 +45,8 @@ x-sandbox: paths: /{apiKey}: post: - summary: alchemy_getTokenMetadata - description: 'Returns metadata (name, symbol, decimals, logo) for a given token contract address.' + summary: Token Metadata By Contract + description: 'alchemy_getTokenMetadata - Returns metadata (name, symbol, decimals, logo) for a given token contract address.' tags: [] parameters: - name: apiKey