Commonly used to fetch the native, fungible (ERC20), and non-fungible (ERC721 & ERC1155) tokens held by an address. Response includes spot prices and other metadata.
Overview
Welcome to the Covalent API!
The Covalent GoldRush API can be used to pull token balances, positions and historical granular transaction data from dozens of blockchain networks. This data enables hundreds of end-user use-cases like wallets, investor dashboards, taxation tools and as-of-yet unknown use-cases.
Switching from one blockchain network to another is simply changing the chain_name path parameter. It's really that simple.
One GoldRush API. One Billion Possibilities.
The Covalent API is RESTful. The API is designed around the main resources that's available through the web interface. Sample API calls are provided next to each method using cURL.
Broadly speaking, there are three classes of APIs:
Class A - APIs that return enriched blockchain data applicable to all blockchain networks, eg: token balances, transactions, log events, etc.
Class B - APIs maintained by Covalent for a specific protocol on a specific blockchain, eg: Constant Product AMMs (
XY=K) on various blockchains.Class C - APIs created and maintained by the community.
URL Patterns
The API Host for all requests is https://api.covalenthq.com/v1/. Some additional points to keep in mind:
The current version of the API is
v1.All requests are done over HTTPS (calls over plain HTTP will fail.)
The default return format for all endpoints is JSON, unless the query parameter
format=csvis specified.All requests require authentication.
Authentication
To access the Covalent API, you will need an API key. You can find your API key in the web interface. Various authentication mechanisms are available:
Authentication via Query parameter
Bash
curl -X GET https://api.covalenthq.com/v1/ENDPOINT/?key=API_KEY
Simply append key=API_KEY as a query parameter to all requests. The main advantage of this method is to embed the API endpoints within applications that do not support more sophisticated auth mechanisms, like Google Sheets or as IFrames.
Authentication via Basic Auth
Bash
curl -X GET https://api.covalenthq.com/v1/ENDPOINT/ \ -u API_KEY: -H 'Content-Type: application/json' # The colon prevents curl from asking for a password.
Provide your API key as the basic auth username. You can find your API key in the web interface. You do not need to provide a password.
Use of CXT (Covalent X Token)
The Covalent API does not require the CXT token in order to use it. CXT is a staking and governance token and for every API call, CXT is market bought and distributed to the service providers who are fulfilling the API requests. This "fee switch" mechanism is yet to launch.
Response format
JavaScript
❴ "data": ..., "error": false, "error_message": null, "error_code": null ❵
By default, the Covalent API returns JSON responses with the same shape for all endpoints. The main keys are data, error, error_message and error_code.
You can ask for a CSV format by sending the format=csv query parameter.
Supported Networks
Covalent supports over 70+ different blockchains all with the same GoldRush API. For a full list see here.
Rate limiting & Premium Tier
We have a limit of 5 requests per second per API key for free users. Furthermore, free users are also limited to 100,000 credits per month, reset on the first of each month.
If you upgrade to a Premium Tier, you get access to higher rate limits and the ability to unlock flex credits.
Refresh rate
We classify the APIs as:
real time
batched
Real-time endpoints have a delay of 2 blocks – for example, on blockchains like Ethereum with block times of 15 seconds, the delay will be 30 seconds which on blockchains like Polygon with blocktimes of 3 seocnds, the delay will be 6 seconds.
Batched endpoints have a delay of 30 minutes.
Pagination
Certain endpoints take two parameters: page-size and page-number implementing offset-limit pagination.
Error codes
Covalent uses standard HTTP response codes to indicate the success or failure of an API request. In general: codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.). Codes in the 5xx range indicate an error with Covalent's servers (these are rare).
Support channels
Support is available via multiple channels:
Change log
Available here.
Class A
APIs that return enriched blockchain data applicable to all blockchain networks, eg: token balances, transactions, log events, etc.
Get token balances for address
- Costs:
- 1.00 Credits
- Processing:
- Realtime
chevron_right Show BalancesResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.BalanceService.getTokenBalancesForWalletAddress();
console.log(resp.data);
}
Get historical token balances for address
Commonly used to fetch the historical native, fungible (ERC20), and non-fungible (ERC721 & ERC1155) tokens held by an address at a given block height or date. Response includes daily prices and other metadata.
Supports only Ethereum, Binance Smart Chain and Polygon.
- Costs:
- 1.00 Credits
- Processing:
- Realtime
chevron_right Show HistoricalBalancesResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.BalanceService.getHistoricalTokenBalancesForWalletAddress();
console.log(resp.data);
}
Get native token balance for address
Commonly used to get the native token balance for an address. This endpoint is required because native tokens are usually not ERC20 tokens and sometimes you want something lightweight.
- Costs:
- 0.50 Credits
- Processing:
- Realtime
chevron_right Show TokenBalanceNativeResponse Object
Related guide: Building a Web3 Portfolio Tracker with the GoldRush API
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.BalanceService.getNativeTokenBalance();
console.log(resp.data);
}
Get historical portfolio value over time
Commonly used to render a daily portfolio balance for an address broken down by the token. The timeframe is user-configurable, defaults to 30 days.
- Costs:
- 2.00 Credits per 30 days
- Processing:
- Realtime
chevron_right Show PortfolioResponse Object
Related guide: How to Build a 30-Day Historical Crypto Portfolio Chart
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.BalanceService.getHistoricalPortfolioForWalletAddress();
console.log(resp.data);
}
Get ERC20 token transfers for address
Commonly used to render the transfer-in and transfer-out of a token along with historical prices from an address.
- Costs:
- 0.05 Credits per item
- Processing:
- Realtime
chevron_right Show Erc20TransfersResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
try {
for await (const resp of client.BalanceService.getErc20TransfersForWalletAddress()) {
console.log(resp);
}
} catch (error) {
console.log(error.message);
}
}
Get token holders as of any block height (v2)
Commonly used to get a list of all the token holders for a specified ERC20 or ERC721 token. Returns historic token holders when block-height is set (defaults to latest). Useful for building pie charts of token holders.
- Costs:
- 0.02 Credits per item
- Processing:
- Realtime
chevron_right Show TokenHoldersResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
try {
for await (const resp of client.BalanceService.getTokenHoldersV2ForTokenAddress()) {
console.log(resp);
}
} catch (error) {
console.log(error.message);
}
}
Get NFTs for address
Commonly used to render the NFTs (including ERC721 and ERC1155) held by an address.
- Costs:
- 1.00 Credits
- Processing:
- Realtime
chevron_right Show NftAddressBalanceNftResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.NftService.getNftsForAddress();
console.log(resp.data);
}
Get NFTs from contract with metadata
Commonly used to get NFT token IDs with metadata from a collection. Useful for building NFT card displays.
- Costs:
- 15.00 Credits
- Processing:
- Realtime
chevron_right Show NftMetadataResponse Object
Related guides: How to Block NFT Spam, NFT Provenance: Bringing Property Rights Onchain
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
try {
for await (const resp of client.NftService.getTokenIdsForContractWithMetadata()) {
console.log(resp);
}
} catch (error) {
console.log(error.message);
}
}
Get single NFT with cached metadata from contract
Commonly used to get a single NFT metadata by token ID from a collection. Useful for building NFT card displays.
This endpoint defaults to serving cached metadata for certain chains. If attempted on a non-cached chain, it issues a warning, advising the setting of with-uncached=true.
For any given asset, if it's cached, the asset_cached field on the response returns true, providing the URL and other related data. If not cached yet, asset_cached shows false, with null values for the URL and other fields.
- Costs:
- 2.00 Credits
- Processing:
- Realtime
chevron_right Show NftMetadataResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.NftService.getNftMetadataForGivenTokenIdForContract();
console.log(resp.data);
}
Get NFT transactions for contract
Commonly used to get all transactions of an NFT token. Useful for building a transaction history table or price chart.
- Costs:
- 0.10 Credits per item
- Processing:
- Realtime
chevron_right Show NftTransactionsResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.NftService.getNftTransactionsForContractTokenId();
console.log(resp.data);
}
Get traits for a collection
Commonly used to fetch and render the traits of a collection as seen in rarity calculators.
- Costs:
- 2.00 Credits
- Processing:
- Batch
chevron_right Show NftCollectionTraitsResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.NftService.getTraitsForCollection();
console.log(resp.data);
}
Get trait summary for collection
Commonly used to calculate rarity scores for a collection based on its traits.
- Costs:
- 5.00 Credits
- Processing:
- Batch
chevron_right Show NftCollectionTraitSummaryResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.NftService.getCollectionTraitsSummary();
console.log(resp.data);
}
Get attributes for a collection trait
Commonly used to get the count of unique values for traits within an NFT collection.
- Costs:
- 2.00 Credits
- Processing:
- Batch
chevron_right Show NftCollectionAttributesForTraitResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.NftService.getAttributesForTraitInCollection();
console.log(resp.data);
}
Get chain collections
Commonly used to fetch the list of NFT collections with downloaded and cached off chain data like token metadata and asset files.
- Costs:
- 0.01 Credits
- Processing:
- Batch
chevron_right Show ChainCollectionResponse Object
Related guide: How to Block NFT Spam
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
try {
for await (const resp of client.NftService.getChainCollections()) {
console.log(resp);
}
} catch (error) {
console.log(error.message);
}
}
Get historical floor prices for a collection
Commonly used to render a price floor chart for an NFT collection.
- Costs:
- 2.00 Credits
- Processing:
- Batch
chevron_right Show NftMarketFloorPriceResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.NftService.getNftMarketFloorPrice();
console.log(resp.data);
}
Get historical volume for a collection
Commonly used to build a time-series chart of the transaction volume of an NFT collection.
- Costs:
- 2.00 Credits
- Processing:
- Batch
chevron_right Show NftMarketVolumeResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.NftService.getNftMarketVolume();
console.log(resp.data);
}
Get historical sales count for a collection
Commonly used to build a time-series chart of the sales count of an NFT collection.
- Costs:
- 2.00 Credits
- Processing:
- Batch
chevron_right Show NftMarketSaleCountResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.NftService.getNftMarketSaleCount();
console.log(resp.data);
}
Check ownership in NFT collection
Commonly used to verify ownership of NFTs (including ERC-721 and ERC-1155) within a collection.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show NftOwnershipForCollectionResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.NftService.checkOwnershipInNft();
console.log(resp.data);
}
Check ownership in NFT collection for specific token
Commonly used to verify ownership of a specific token (ERC-721 or ERC-1155) within a collection.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show NftOwnershipForCollectionResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.NftService.checkOwnershipInNftForSpecificTokenId();
console.log(resp.data);
}
Get token approvals for address
Commonly used to get a list of approvals across all token contracts categorized by spenders for a wallet’s assets.
- Costs:
- 2.00 Credits
- Processing:
- Realtime
chevron_right Show ApprovalsResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.SecurityService.getApprovals();
console.log(resp.data);
}
Get NFT approvals for address
Commonly used to get a list of NFT approvals across all token contracts categorized by spenders for a wallet’s assets.
- Costs:
- 2.00 Credits
- Processing:
- Realtime
chevron_right Show NftApprovalsResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.SecurityService.getNftApprovals();
console.log(resp.data);
}
Get a transaction
Commonly used to fetch and render a single transaction including its decoded log events.
Requests that return status 200 and no data cost 0.1 credits.
Enabling no-logs reduces request cost to 0.05 per item.
- Costs:
- 0.10 Credits
- Processing:
- Realtime
chevron_right Show TransactionResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.TransactionService.getTransaction();
console.log(resp.data);
}
Get transaction summary for address
Commonly used to fetch the earliest and latest transactions, and the transaction count for a wallet. Calculate the age of the wallet and the time it has been idle and quickly gain insights into their engagement with web3.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show TransactionsSummaryResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.TransactionService.getTransactionSummary();
console.log(resp.data);
}
Get earliest transactions for address (v3)
Commonly used to fetch and render the earliest transactions involving an address. Frequently seen in wallet applications.
Returns the same results as the first timebucket for an address in the Get recent transactions endpoint.
Requests that return status 200 and no data cost 0.1 credits.
Enabling no-logs reduces request cost to 0.05 per item.
- Costs:
- 0.10 Credits per item
- Processing:
- Realtime
chevron_right Show TransactionsTimeBucketResponse Object
Request
curl -X GET https://api.covalenthq.com/v1/{chainName}/bulk/transactions/{walletAddress}/ \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet recent transactions for address (v3)
Commonly used to fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
Requests that return status 200 and no data cost 0.1 credits.
Enabling no-logs reduces request cost to 0.05 per item.
- Costs:
- 0.10 Credits per item
- Processing:
- Realtime
chevron_right Show RecentTransactionsResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
try {
for await (const resp of client.TransactionService.getAllTransactionsForAddress()) {
console.log(resp);
}
} catch (error) {
console.log(error.message);
}
}
Get paginated transactions for address (v3)
Commonly used to fetch the transactions involving an address including the decoded log events in a paginated fashion.
This endpoint returns paginated transactions, starting with the earliest transactions on page 0. For the most recent transactions, refer to the Get recent transactions for address (v3) endpoint.
Requests that return status 200 and no data cost 0.1 credits.
Enabling no-logs reduces request cost to 0.05 per item.
- Costs:
- 0.10 Credits per item
- Processing:
- Realtime
chevron_right Show TransactionsResponse Object
Request
curl -X GET https://api.covalenthq.com/v1/{chainName}/address/{walletAddress}/transactions_v3/page/{page}/ \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet bulk time bucket transactions for address (v3)
Commonly used to fetch all transactions including their decoded log events in a 15-minute time bucket interval.
Requests that return status 200 and no data cost 0.1 credits.
Enabling no-logs reduces request cost to 0.05 per item.
- Costs:
- 0.10 Credits per item
- Processing:
- Realtime
chevron_right Show TransactionsTimeBucketResponse Object
Request
curl -X GET https://api.covalenthq.com/v1/{chainName}/bulk/transactions/{walletAddress}/{timeBucket}/ \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet all transactions in a block (v3)
Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
Requests that return status 200 and no data cost 0.1 credits.
Enabling no-logs reduces request cost to 0.05 per item.
- Costs:
- 0.10 Credits per item
- Processing:
- Realtime
chevron_right Show TransactionsBlockResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.TransactionService.getTransactionsForBlock();
console.log(resp.data);
}
Get all transactions in a block by page (v3)
Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
Requests that return status 200 and no data cost 0.1 credits.
Enabling no-logs reduces request cost to 0.05 per item.
- Costs:
- 0.10 Credits per item
- Processing:
- Realtime
chevron_right Show TransactionsBlockPageResponse Object
Request
curl -X GET https://api.covalenthq.com/v1/{chainName}/block/{blockHeight}/transactions_v3/page/{page}/ \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet a block
Commonly used to fetch and render a single block for a block explorer.
- Costs:
- 1.00 Credits
- Processing:
- Realtime
chevron_right Show BlockResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.BaseService.getBlock();
console.log(resp.data);
}
Get block heights
Commonly used to get all the block heights within a particular date range. Useful for rendering a display where you sort blocks by day.
- Costs:
- 1.00 Credits
- Processing:
- Realtime
chevron_right Show BlockHeightsResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
try {
for await (const resp of client.BaseService.getBlockHeights()) {
console.log(resp);
}
} catch (error) {
console.log(error.message);
}
}
Get logs
Commonly used to get all the event logs of the latest block, or for a range of blocks. Includes sender contract metadata as well as decoded logs.
Limits:
For a block range of 2,000 blocks or less, the response will include all logs within the range.
For a block range greater than 2,000 blocks:
The response will include up to 10,000 logs.
If the number of logs exceeds 10,000, no logs will be included in the response. Instead, the response will contain a suggested range within the
infoobject, including a link and message.
- Costs:
- 0.01 Credits per item
- Processing:
- Realtime
chevron_right Show GetLogsResponse Object
Related guide: How to Get the Latest Axie Spawns
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.BaseService.getLogs();
console.log(resp.data);
}
Get log events by contract address
Commonly used to get all the event logs emitted from a particular contract address. Useful for building dashboards that examine on-chain interactions.
- Costs:
- 0.01 Credits per item
- Processing:
- Realtime
chevron_right Show LogEventsByAddressResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
try {
for await (const resp of client.BaseService.getLogEventsByAddress()) {
console.log(resp);
}
} catch (error) {
console.log(error.message);
}
}
Get log events by topic hash(es)
Commonly used to get all event logs of the same topic hash across all contracts within a particular chain. Useful for cross-sectional analysis of event logs that are emitted on-chain.
- Costs:
- 0.01 Credits per item
- Processing:
- Realtime
chevron_right Show LogEventsByTopicHashResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
try {
for await (const resp of client.BaseService.getLogEventsByTopicHash()) {
console.log(resp);
}
} catch (error) {
console.log(error.message);
}
}
Get resolved address for registered address
Commonly used to resolve ENS, RNS and Unstoppable Domains addresses.
Note: all our endpoints support address resolution natively allowing an ENS, RNS or Unstoppable Domains address to be passed in directly.
- Costs:
- 1.00 Credits
- Processing:
- Realtime
chevron_right Show ResolvedAddress Object
Related guide: How to Resolve a Wallet Address Given an ENS Domain
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.BaseService.getResolvedAddress();
console.log(resp.data);
}
Get all chains
Commonly used to build internal dashboards for all supported chains on Covalent.
- Costs:
- 0.01 Credits
- Processing:
- Realtime
chevron_right Show AllChainsResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.BaseService.getAllChains();
console.log(resp.data);
}
Get all chain statuses
Commonly used to build internal status dashboards of all supported chains.
- Costs:
- 1.00 Credits
- Processing:
- Realtime
chevron_right Show AllChainsStatusResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.BaseService.getAllChainStatus();
console.log(resp.data);
}
Get gas prices
Get real-time gas estimates for different transaction speeds on a specific network, enabling users to optimize transaction costs and confirmation times.
Currently support these event types: erc20 token transfers, nativetokens transfer, and uniswapv3 swap events.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show GasPricesResponse Object
Related guide: How to Fetch Onchain Gas Prices and Estimate Gas Costs
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.BaseService.getGasPrices();
console.log(resp.data);
}
Get cross-chain activity for address
Commonly used to locate chains which an address is active on with a single API call.
- Costs:
- 0.50 Credits
- Processing:
- Realtime
chevron_right Show ChainActivityResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.BaseService.getAddressActivity();
console.log(resp.data);
}
Class B
APIs maintained by Covalent for a specific protocol on a specific blockchain, eg: Constant Product AMMs (XY=K) on various blockchains.
Get XY=K pools
Commonly used to get all the pools of a particular DEX. Supports most common DEXs (Uniswap, SushiSwap, etc), and returns detailed trading data (volume, liquidity, swap counts, fees, LP token prices).
The returned list of pools only contains the active ones and we define active as pools that have had atleast one swap in the last days.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show PoolResponse Object
Related guide: How to Use GoldRush's DEX API for DeFi Apps
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getPools();
console.log(resp.data);
}
Get XY=K pool by address
Commonly used to get the 7 day and 30 day time-series data (volume, liquidity, price) of a particular liquidity pool in a DEX. Useful for building time-series charts on DEX trading activity.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show PoolByAddressResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getPoolByAddress();
console.log(resp.data);
}
Get XY=K pools for ERC20 token address
Commonly used to get all pools and the supported DEX for a token. Useful for building a table of top pairs across all supported DEXes that the token is trading on.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show PoolsDexDataResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getPoolsForTokenAddress();
console.log(resp.data);
}
Get XY=K pools for wallet address
Commonly used to get all pools and supported DEX for a wallet. Useful for building a personal DEX UI showcasing pairs and supported DEXes associated to the wallet.
Supports only Ethereum, Binance Smart Chain and Polygon.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show PoolsDexDataResponse Object
Related guide: How to Use GoldRush's DEX API for DeFi Apps
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getPoolsForWalletAddress();
console.log(resp.data);
}
Get XY=K address exchange balances
Commonly used to return balance of a wallet/contract address on a specific DEX.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show AddressExchangeBalancesResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getAddressExchangeBalances();
console.log(resp.data);
}
Get XY=K network exchange tokens
Commonly used to retrieve all network exchange tokens for a specific DEX. Useful for building a top tokens table by total liquidity within a particular DEX.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show NetworkExchangeTokensResponse Object
Related guide: How to Use GoldRush's DEX API for DeFi Apps
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getNetworkExchangeTokens();
console.log(resp.data);
}
Get XY=K supported DEXes
Commonly used to get all the supported DEXs available for the xy=k endpoints, along with the swap fees and factory addresses.
- Costs:
- 0.01 Credits
- Processing:
- Realtime
chevron_right Show SupportedDexesResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getSupportedDEXes();
console.log(resp.data);
}
Get XY=K DEX for pool address
Commonly used to get the corresponding supported DEX given a pool address, along with the swap fees, DEX's logo url, and factory addresses. Useful to identifying the specific DEX to which a pair address is associated.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show PoolToDexResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getDexForPoolAddress();
console.log(resp.data);
}
Get XY=K swap count for exchange token
Commonly used to get historical daily swap count for a single network exchange token.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show SingleNetworkExchangeTokenResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getSingleNetworkExchangeToken();
console.log(resp.data);
}
Get XY=K network liquidity pool token details
Commonly used to get a detailed view for a single liquidity pool token. Includes time series data.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show NetworkExchangeTokenViewResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getLpTokenView();
console.log(resp.data);
}
Get XY=K transactions for account address
Commonly used to get all the DEX transactions of a wallet. Useful for building tables of DEX activity segmented by wallet.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show TransactionsForAccountAddressResponse Object
Related guide: How to Use GoldRush's DEX API for DeFi Apps
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getTransactionsForAccountAddress();
console.log(resp.data);
}
Get XY=K transactions for token address
Commonly used to get all the transactions of a token within a particular DEX. Useful for getting a per-token view of DEX activity.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show TransactionsForTokenAddressResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getTransactionsForTokenAddress();
console.log(resp.data);
}
Get XY=K transactions for DEX
Commonly used to get all the the transactions for a given DEX. Useful for building DEX activity views.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show NetworkTransactionsResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getTransactionsForDex();
console.log(resp.data);
}
Get XY=K transactions for exchange pool
Commonly used for getting all the transactions of a particular DEX liquidity pool. Useful for building a transactions history table for an individual pool.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show TransactionsForExchangeResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getTransactionsForExchange();
console.log(resp.data);
}
Get XY=K ecosystem chart data
Commonly used to get a 7d and 30d time-series chart of DEX activity. Includes volume and swap count.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show EcosystemChartDataResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getEcosystemChartData();
console.log(resp.data);
}
Get XY=K health data
Commonly used to ping the health of xy=k endpoints to get the synced block height per chain.
- Costs:
- 1.00 Credits
- Processing:
- Realtime
chevron_right Show HealthDataResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.XykService.getHealthData();
console.log(resp.data);
}
Pricing
Get historical token prices
Commonly used to get historic prices of a token between date ranges. Supports native tokens.
- Costs:
- 1.00 Credits
- Processing:
- Batch
chevron_right Show TokenPricesResponse Object
Installation
npm install @covalenthq/client-sdk
Request
import { CovalentClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new CovalentClient("YOUR_API_KEY");
const resp = await client.PricingService.getTokenPrices();
console.log(resp.data);
}
Class C
APIs created and maintained by the community.
Get market data by address
Get market data for a specific Aave lending pool.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/aave/market_data \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet all markets
Get all markets for Aave including TVL, Supply and Borrow rates.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/aave/markets \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet balances for a wallet address
Get balances for a Aave wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/aave/balances \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet transactions by wallet address
Get transactions for a Aave wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/aave/transactions \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet redeemable token balance
Get underlying tokens for a wallet's LP tokens.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/balancer/tokens \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet market data by address
Get market data for a specific Balancer pool.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/balancer/market_data \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet all markets
Get all markets for Balancer including TVL, Supply and Borrow rates.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/balancer/markets \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet transactions by wallet address
Get transactions for a Balancer wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/balancer/transactions \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet balances for a wallet address
Get balances for a Balancer wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/balancer/balances \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet transactions by wallet address
Get transactions for a Bitcoin wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/bitcoin/transactions \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet market data by address
Get market data for a specific Compound lending pool.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/compound/market_data \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet all markets
Get all markets for Compound including TVL, Supply and Borrow rates.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/compound/markets \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet balances for a wallet address
Get balances for a Compound wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/compound/balances \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet transactions by wallet address
Get transactions for a Compound wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/compound/transactions \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet market data by address
Get market data for all Curve pools.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/curve/market_data \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet redeemable token balance
Get underlying tokens for a wallet's LP tokens.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/curve/tokens \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet all markets
Get all markets for Curve including TVL, Supply and Borrow rates.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/curve/markets \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet transactions by wallet address
Get transactions for a Curve wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/curve/transactions \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet balances for a wallet address
Get balances for a Curve wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/curve/balances \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet market data by address
Get market data for a specific Dodo pool.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/dodo/market_data \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet all markets
Get all markets for Dodo.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/dodo/markets \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet transactions by wallet address
Get transactions for a Dodo wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/dodo/transactions \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet balances for a wallet address
Get balances for a Dodo wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/dodo/balances \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet redeemable token balance
Get underlying tokens for a wallet's LP tokens.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/frax/tokens \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet market data by address
Get market data for a specific Frax lending pool.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/frax/market_data \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet all markets
Get all markets for Frax including TVL, Supply and Borrow rates.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/frax/markets \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet balances for a wallet address
Get balances for a Frax wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/frax/balances \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet transactions by wallet address
Get transactions for a Frax wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/frax/transactions \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet all markets
Get all markets for InstaDapp.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/instadapp/markets \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet market data by address
Get market data for all InstaDapp vaults.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/instadapp/market_data \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet transactions by wallet address
Get transactions for a InstaDapp wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/instadapp/transactions \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet balances for a wallet address
Get balances for a InstaDapp wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/instadapp/balances \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet market data by address
Get market data for a specific Lido lending pool.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/lido/market_data \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet balances for a wallet address
Get balances for a Lido wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/lido/balances \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet transactions by wallet address
Get transactions for a Lido wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/lido/transactions \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet market data by address
Get market data for all Yearn vaults.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/yearn/market_data \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet all markets
Get all markets for Yearn including TVL, Supply and Borrow rates.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/yearn/markets \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet transactions by wallet address
Get transactions for a Yearn wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/yearn/transactions \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordGet balances for a wallet address
Get balances for a Yearn wallet.
- Processing:
- Batch
Request
curl -X GET https://api.covalenthq.com/v1/cq/covalent/app/yearn/balances \
-H 'Content-Type: application/json' \
-u YOUR_API_KEY: \
# The colon prevents curl from asking for a passwordWas this helpful?
Yes
No