AptosAptos Network's breakthrough technology and seamless user experience are now available on QuickNode.

Start building today!     

Contents

qn_getTokenMetadataBySymbol RPC Method

The API credit value for this method is 4 . To learn more about API credits and each method's value, visit the API Credits page.

Please note that this RPC method requires the Token API add-on enabled on your QuickNode endpoint. Also, it supports ERC-20 compliant contracts (on Ethereum mainnet).

Parameters:

  1. object - The custom object with the following fields:

    symbol - string - The ERC-20 token symbol you'd like to get details for

    page - integer - (optional) The page number you would like returned. Page numbers start at 1 and end at totalPages. If omitted, defaults to the first page (page 1). If the page number requested is higher than totalPages, an empty tokens array will be returned. If the page number requested is less than 1, an invalid params response will be returned

    perPage - integer - (optional) The maximum amount of tokens to return on each page. You can request up to 100 items per page. If omitted, defaults to 40 items per page

Returns:

  1. pageNumber - The page number of results that was returned with this response

    totalPages - The total number of results pages available

    totalItems - The total number of tokens matching the supplied symbol

    tokens - An array of objects representing tokens matching the supplied symbol

    name - The name of this token

    symbol - The symbol of this token

    address - The contract address of this token

    decimals - The number of decimals this token utilizes

    genesisBlock - The block number in which this contract was deployed

    genesisTransaction - The hash of the transaction in which this contract was deployed

Code Examples:

const ethers = require("ethers");
(async () => {
  const provider = new ethers.providers.JsonRpcProvider("http://sample-endpoint-name.network.quiknode.pro/token-goes-here/");
  provider.connection.headers = { "x-qn-api-version": 1 };
  const heads = await provider.send("qn_getTokenMetadataBySymbol", {
    symbol: "USDC",
  });
  console.log(heads);
})();
Ready to get started? Create a free account