{ "openapi": "3.1.0", "info": { "title": "GoldRush Multichain Data APIs", "version": "1.0.0", "description": "Covalent's GoldRush Multichain Data APIs OpenAPI Schema." }, "servers": [ { "url": "https://api.covalenthq.com" } ], "security": [ { "bearerAuth": [] } ], "paths": { "/v1/allchains/transactions/": { "get": { "tags": [ "get-allchains-transactions" ], "description": "Fetch paginated transactions for up to 10 EVM addresses and 10 EVM chains with one API call. Useful for building Activity Feeds. ", "operationId": "getTransactions", "parameters": [ { "name": "chains", "in": "query", "description": "Comma separated list of chain names or IDs to retrieve transactions from. Defaults to all foundational chains.", "required": false, "schema": { "type": "string" } }, { "name": "addresses", "in": "query", "description": "Comma separated list of addresses for which transactions are fetched.", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Number of transactions to return per page, up to the default max of 100 items.", "required": false, "schema": { "type": "integer" } }, { "name": "before", "in": "query", "description": "Pagination cursor pointing to fetch transactions before a certain point.", "required": false, "schema": { "type": "string" } }, { "name": "after", "in": "query", "description": "Pagination cursor pointing to fetch transactions after a certain point.", "required": false, "schema": { "type": "string" } }, { "name": "with-logs", "in": "query", "description": "Whether to include raw logs in the response.", "required": false, "schema": { "type": "boolean" } }, { "name": "with-decoded-logs", "in": "query", "description": "Whether to include decoded logs in the response.", "required": false, "schema": { "type": "boolean" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, `GBP`, `BTC` and `ETH`.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "Timestamp for when the data was last updated." }, "cursor_before": { "type": "string", "description": "Pagination cursor pointing to the previous page." }, "cursor_after": { "type": "string", "description": "Pagination cursor pointing to the next page." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_height": { "type": "integer", "description": "The height of the block." }, "block_signed_at": { "type": "string", "format": "date-time", "description": "The signed block timestamp in UTC." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from blocks that are reorged." }, "tx_hash": { "type": "string", "description": "The transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "miner_address": { "type": "string", "description": "The address of the miner who mined the block." }, "from_address": { "type": "string" }, "to_address": { "type": "string", "description": "The recipient's wallet address." }, "value": { "type": "string", "description": "b;The value of the transaction in wei." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_offered": { "type": "integer", "format": "int64", "description": "The gas offered for the transaction." }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas actually spent by the transaction." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "successful": { "type": "boolean", "description": "Indicated whether the transaction was successful or failed." }, "chain_id": { "type": "string", "description": "The chain ID of the blockchain where the transaction occurred." }, "chain_name": { "type": "string", "description": "The chain name of the blockchain where the transaction occurred." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The block explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "Event logs generated by the transaction." } } }, "description": "List of transactions returned by the API." } } } } } } }, "x-codeSamples": [] } }, "/v1/allchains/address/{walletAddress}/balances/": { "get": { "tags": [ "get-allchains-balances" ], "description": "Fetch paginated spot & historical native and token balances for a single address on up to 10 EVM chains with one API call.", "operationId": "getTokenBalances", "parameters": [ { "name": "walletAddress", "in": "path", "description": "The requested address. Domain names (e.g. `demo.eth`) NOT supported.", "required": true, "schema": { "type": "string" } }, { "name": "chains", "in": "query", "description": "Comma separated list of chain names or IDs to retrieve token balances from. Defaults to all foundational chains.", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Number of token balances to return per page, up to the default max of 100 items.", "required": false, "schema": { "type": "integer" } }, { "name": "before", "in": "query", "description": "Pagination cursor pointing to fetch token balances before a certain point.", "required": false, "schema": { "type": "string" } }, { "name": "cutoff-timestamp", "in": "query", "description": "UNIX timestamp to retrieve the balance snapshot from the nearest block before the specified cutoff time.", "required": false, "schema": { "type": "integer" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, `GBP`, `BTC` and `ETH`.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "Timestamp for when the data was last updated." }, "cursor_before": { "type": "string", "description": "Pagination cursor pointing to the previous page." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "contract_display_name": { "type": "string", "description": "A display-friendly name for the contract." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_urls": { "type": "object", "properties": { "token_logo_url": { "type": "string", "description": "The token logo URL." }, "protocol_logo_url": { "type": "string", "description": "The protocol logo URL." }, "chain_logo_url": { "type": "string", "description": "The chain logo URL." } }, "description": "The contract logo URLs." }, "last_transferred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was transferred." }, "is_native_token": { "type": "boolean", "description": "Indicates if a token is the chain's native gas token, eg: ETH on Ethereum." }, "type": { "type": "string", "description": "One of `cryptocurrency`, `stablecoin`, `nft` or `dust`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "balance_24h": { "type": "string", "description": "b;The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote_rate_24h": { "type": "number", "format": "double", "description": "The 24h exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "quote_24h": { "type": "number", "format": "double", "description": "The 24h balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "pretty_quote_24h": { "type": "string", "description": "A prettier version of the 24h quote for rendering purposes." }, "chain_id": { "type": "integer", "description": "The chain ID that this balance is on. eg: `1`." }, "chain_name": { "type": "string", "description": "The chain name that this balance is on. eg: `eth-mainnet`." }, "chain_display_name": { "type": "string", "description": "A display-friendly name for the chain." } } }, "description": "List of token balances returned by the API." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.AllChainsService.getTokenBalances({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/approvals/{walletAddress}/": { "get": { "tags": [ "get-token-approvals-for-address" ], "description": "Commonly used to get a list of approvals across all token contracts categorized by spenders for a wallet’s assets.", "operationId": "getApprovals", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "token_address": { "type": "string", "description": "The address for the token that has approvals." }, "token_address_label": { "type": "string", "description": "The name for the token that has approvals." }, "ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "balance": { "type": "string", "description": "b;Wallet balance of the token." }, "balance_quote": { "type": "number", "format": "double", "description": "Value of the wallet balance of the token." }, "pretty_balance_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "value_at_risk": { "type": "string", "description": "Total amount at risk across all spenders." }, "value_at_risk_quote": { "type": "number", "format": "double", "description": "Value of total amount at risk across all spenders." }, "pretty_value_at_risk_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "spenders": { "type": "array", "items": { "type": "object", "properties": { "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log.\"" }, "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "tx_hash": { "type": "string", "description": "Most recent transaction that updated approval amounts for the token." }, "spender_address": { "type": "string", "description": "Address of the contract with approval for the token." }, "allowance": { "type": "string", "description": "Remaining number of tokens granted to the spender by the approval." }, "allowance_quote": { "type": "number", "format": "double", "description": "Value of the remaining allowance specified by the approval." }, "pretty_allowance_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "value_at_risk": { "type": "string", "description": "Amount at risk for spender." }, "value_at_risk_quote": { "type": "number", "format": "double", "description": "Value of amount at risk for spender." }, "pretty_value_at_risk_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "risk_factor": { "type": "string" } } }, "description": "Contracts with non-zero approvals for this token." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.SecurityService.getApprovals({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/address/{walletAddress}/balances_v2/": { "get": { "tags": [ "get-token-balances-for-address" ], "description": "Commonly used to fetch the native and fungible (ERC20) tokens held by an address. Response includes spot prices and other metadata.", "operationId": "getTokenBalancesForWalletAddress", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "no-spam", "in": "query", "description": "If `true`, the suspected spam tokens are removed. Supported on all Foundational Chains.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "contract_display_name": { "type": "string", "description": "A display-friendly name for the contract." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_urls": { "type": "object", "properties": { "token_logo_url": { "type": "string", "description": "The token logo URL." }, "protocol_logo_url": { "type": "string", "description": "The protocol logo URL." }, "chain_logo_url": { "type": "string", "description": "The chain logo URL." } }, "description": "The contract logo URLs." }, "last_transferred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was transferred." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "is_native_token": { "type": "boolean", "description": "Indicates if a token is the chain's native gas token, eg: ETH on Ethereum." }, "type": { "type": "string", "description": "One of `cryptocurrency`, `stablecoin`, `nft` or `dust`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "balance_24h": { "type": "string", "description": "b;The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote_rate_24h": { "type": "number", "format": "double", "description": "The 24h exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "quote_24h": { "type": "number", "format": "double", "description": "The 24h balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "pretty_quote_24h": { "type": "string", "description": "A prettier version of the 24h quote for rendering purposes." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BalanceService.getTokenBalancesForWalletAddress({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/address/{walletAddress}/portfolio_v2/": { "get": { "tags": [ "get-historical-portfolio-value-over-time" ], "description": "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.", "operationId": "getHistoricalPortfolioForWalletAddress", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "days", "in": "query", "description": "The number of days to return data for. Defaults to 30 days.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "holdings": { "type": "array", "items": { "type": "object", "properties": { "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "timestamp": { "type": "string", "format": "date-time" }, "close": { "type": "object", "properties": { "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." } } }, "high": { "type": "object", "properties": {} }, "low": { "type": "object", "properties": {} }, "open": { "type": "object", "properties": {} } } } } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BalanceService.getHistoricalPortfolioForWalletAddress({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/address/{walletAddress}/transfers_v2/": { "get": { "tags": [ "get-erc20-token-transfers-for-address" ], "description": "Commonly used to render the transfer-in and transfer-out of a token along with historical prices from an address.", "operationId": "getErc20TransfersForWalletAddress", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "contract-address", "in": "query", "description": "The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "starting-block", "in": "query", "description": "The block height to start from, defaults to `0`.", "required": false, "schema": { "type": "integer" } }, { "name": "ending-block", "in": "query", "description": "The block height to end at, defaults to current block height.", "required": false, "schema": { "type": "integer" } }, { "name": "page-size", "in": "query", "description": "Number of items per page. Omitting this parameter defaults to 100.", "required": false, "schema": { "type": "integer" } }, { "name": "page-number", "in": "query", "description": "0-indexed page number to begin pagination.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Whether or not transaction is successful." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The transaction's gas_price * gas_spent, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "transfers": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "transfer_type": { "type": "string", "description": "Categorizes token transactions as either `transfer-in` or `transfer-out`, indicating whether tokens are being received or sent from an account." }, "delta": { "type": "string", "description": "b;The delta attached to this transfer." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "delta_quote": { "type": "number", "format": "double", "description": "The current delta converted to fiat in `quote-currency`." }, "pretty_delta_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "balance_quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "method_calls": { "type": "array", "items": { "type": "object", "properties": { "sender_address": { "type": "string", "description": "The address of the sender." }, "method": { "type": "string" } } }, "description": "Additional details on which transfer events were invoked. Defaults to `true`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." } } } } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BalanceService.getErc20TransfersForWalletAddress({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/tokens/{tokenAddress}/token_holders_v2/": { "get": { "tags": [ "get-token-holders-as-of-any-block-height-v2" ], "description": "Used to get a paginated list of current or historical token holders for a specified ERC20 or ERC721 token. ", "operationId": "getTokenHoldersV2ForTokenAddress", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "tokenAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "no-snapshot", "in": "query", "description": "Defaults to `false`. Set to `true` to bypass last snapshot and get the latest token holders list.", "required": false, "schema": { "type": "boolean" } }, { "name": "block-height", "in": "query", "description": "Ending block to define a block range. Omitting this parameter defaults to the latest block height.", "required": false, "schema": { "type": "integer" } }, { "name": "date", "in": "query", "description": "Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date.", "required": false, "schema": { "type": "string" } }, { "name": "page-size", "in": "query", "description": "Number of items per page. Note: Currently, only values of `100` and `1000` are supported. Omitting this parameter defaults to 100.", "required": false, "schema": { "type": "integer" } }, { "name": "page-number", "in": "query", "description": "0-indexed page number to begin pagination.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "address": { "type": "string", "description": "The requested address." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "total_supply": { "type": "string", "description": "b;Total supply of this token." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BalanceService.getTokenHoldersV2ForTokenAddress({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/address/{walletAddress}/historical_balances/": { "get": { "tags": [ "get-historical-token-balances-for-address" ], "description": "Commonly used to fetch the historical native and fungible (ERC20) tokens held by an address at a given block height or date. Response includes daily prices and other metadata.", "operationId": "getHistoricalTokenBalancesForWalletAddress", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "no-spam", "in": "query", "description": "If `true`, the suspected spam tokens are removed. Supported on all Foundational Chains.", "required": false, "schema": { "type": "boolean" } }, { "name": "block-height", "in": "query", "description": "Ending block to define a block range. Omitting this parameter defaults to the latest block height.", "required": false, "schema": { "type": "integer" } }, { "name": "date", "in": "query", "description": "Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "last_transferred_block_height": { "type": "integer", "format": "int64", "description": "The block height when the token was last transferred." }, "contract_display_name": { "type": "string" }, "last_transferred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was transferred." }, "is_native_token": { "type": "boolean", "description": "Indicates if a token is the chain's native gas token, eg: ETH on Ethereum." }, "type": { "type": "string", "description": "One of `cryptocurrency`, `stablecoin`, `nft` or `dust`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BalanceService.getHistoricalTokenBalancesForWalletAddress({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/address/{walletAddress}/balances_native/": { "get": { "tags": [ "get-native-token-balance" ], "description": "Lightweight endpoint to just get the native token balance for an EVM address. ", "operationId": "getNativeTokenBalance", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "block-height", "in": "query", "description": "Ending block to define a block range. Omitting this parameter defaults to the latest block height.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BalanceService.getNativeTokenBalance({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/btc-mainnet/address/{walletAddress}/hd_wallets/": { "get": { "tags": [ "get-bitcoin-balances-for-hd-address" ], "description": "Fetch balances for each active child address derived from a Bitcoin HD wallet. ", "operationId": "getBitcoinHdWalletBalances", "parameters": [ { "name": "walletAddress", "in": "path", "description": "The extended public key (xPub/yPub/zPub) of the HD wallet.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert the balance to. Supports `USD`, `CAD`, `EUR`, etc.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "The extended public key (xPub/yPub/zPub) or HD wallet address." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `20090103`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `btc-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "child_address": { "type": "string", "description": "The specific Bitcoin address derived from the HD wallet." }, "address_path": { "type": "string", "description": "Derivation path used to derive the specific Bitcoin address, e.g., `M/0H/0/0`." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The name of the token, e.g., `Bitcoin`." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for the token, e.g., `BTC`." }, "contract_address": { "type": "string", "description": "Address placeholder for native tokens like BTC." }, "contract_display_name": { "type": "string", "description": "A display-friendly name for the token, e.g., `Bitcoin`." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "Typically null for Bitcoin, but left for compatibility." }, "logo_urls": { "type": "object", "properties": { "token_logo_url": { "type": "string", "description": "The token logo URL." }, "protocol_logo_url": { "type": "string", "description": "The protocol logo URL." }, "chain_logo_url": { "type": "string", "description": "The chain logo URL." } }, "description": "The contract logo URLs." }, "last_transferred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was last transferred." }, "is_native_token": { "type": "boolean", "description": "Indicates if a token is the chain's native gas token, eg: BTC on Bitcoin." }, "type": { "type": "string", "description": "One of `cryptocurrency`, `stablecoin`, `nft` or `dust`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "balance_24h": { "type": "string", "description": "b;The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote_rate_24h": { "type": "number", "format": "double", "description": "The 24h exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "quote_24h": { "type": "number", "format": "double", "description": "The 24h balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "pretty_quote_24h": { "type": "string", "description": "A prettier version of the 24h quote for rendering purposes." } } }, "description": "List of HD wallet balance items, each containing derived addresses and balances." } } } } } } }, "x-codeSamples": [] } }, "/v1/btc-mainnet/address/{walletAddress}/balances_v2/": { "get": { "tags": [ "get-bitcoin-balance-for-address" ], "description": "Fetch Bitcoin balance for a non-HD address. Response includes spot prices and other metadata.", "operationId": "getBitcoinBalanceForWalletAddress", "parameters": [ { "name": "walletAddress", "in": "path", "description": "The requested bitcoin non-HD address.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "contract_display_name": { "type": "string", "description": "A display-friendly name for the contract." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_urls": { "type": "object", "properties": { "token_logo_url": { "type": "string", "description": "The token logo URL." }, "protocol_logo_url": { "type": "string", "description": "The protocol logo URL." }, "chain_logo_url": { "type": "string", "description": "The chain logo URL." } }, "description": "The contract logo URLs." }, "last_transferred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was transferred." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "is_native_token": { "type": "boolean", "description": "Indicates if a token is the chain's native gas token, eg: ETH on Ethereum." }, "type": { "type": "string", "description": "One of `cryptocurrency`, `stablecoin`, `nft` or `dust`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "balance_24h": { "type": "string", "description": "b;The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote_rate_24h": { "type": "number", "format": "double", "description": "The 24h exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "quote_24h": { "type": "number", "format": "double", "description": "The 24h balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "pretty_quote_24h": { "type": "string", "description": "A prettier version of the 24h quote for rendering purposes." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BalanceService.getBitcoinBalanceForWalletAddress({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/btc-mainnet/address/{walletAddress}/historical_balances/": { "get": { "tags": [ "get-historical-bitcoin-balance-for-address" ], "description": "Commonly used to fetch the historical Bitcoin balance held by an address at a given block height or date. Response includes daily prices and other metadata.", "operationId": "getHistoricalBitcoinBalanceForWalletAddress", "parameters": [ { "name": "walletAddress", "in": "path", "description": "Only Bitcoin non-HD addresses are supported.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "block-height", "in": "query", "description": "Ending block to define a block range. Omitting this parameter defaults to the latest block height.", "required": false, "schema": { "type": "integer" } }, { "name": "date", "in": "query", "description": "Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "last_transferred_block_height": { "type": "integer", "format": "int64", "description": "The block height when the token was last transferred." }, "contract_display_name": { "type": "string" }, "last_transferred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was transferred." }, "is_native_token": { "type": "boolean", "description": "Indicates if a token is the chain's native gas token, eg: ETH on Ethereum." }, "type": { "type": "string", "description": "One of `cryptocurrency`, `stablecoin`, `nft` or `dust`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BalanceService.getHistoricalBitcoinBalanceForWalletAddress({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/block_v2/{blockHeight}/": { "get": { "tags": [ "get-a-block" ], "description": "Commonly used to fetch and render a single block for a block explorer.", "operationId": "getBlock", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "blockHeight", "in": "path", "description": "The block height or `latest` for the latest block available.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_hash": { "type": "string", "description": "The hash of the block." }, "signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "height": { "type": "integer", "description": "The block height." }, "block_parent_hash": { "type": "string", "description": "The parent block hash." }, "extra_data": { "type": "string", "description": "Extra data written to the block." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "mining_cost": { "type": "integer", "format": "int64", "description": "The associated mining cost." }, "gas_used": { "type": "integer", "format": "int64", "description": "The associated gas used." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The associated gas limit." }, "transactions_link": { "type": "string", "description": "The link to the related tx by block endpoint." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BaseService.getBlock({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/address/{walletAddress}/resolve_address/": { "get": { "tags": [ "get-resolved-address-for-registered-address" ], "description": "Commonly used to resolve ENS, RNS and Unstoppable Domains addresses. Only supports the resolution of a registered domain to an address.", "operationId": "getResolvedAddress", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "name": { "type": "string" } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BaseService.getResolvedAddress({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/block_v2/{startDate}/{endDate}/": { "get": { "tags": [ "get-block-heights" ], "description": "Commonly used to get all the block heights within a particular date range. Useful for rendering a display where you sort blocks by day.", "operationId": "getBlockHeights", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "The start date in YYYY-MM-DD format.", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "path", "description": "The end date in YYYY-MM-DD format or `latest` for the latest block available.", "required": true, "schema": { "type": "string" } }, { "name": "page-size", "in": "query", "description": "Number of items per page. Omitting this parameter defaults to 100.", "required": false, "schema": { "type": "integer" } }, { "name": "page-number", "in": "query", "description": "0-indexed page number to begin pagination.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_hash": { "type": "string", "description": "The hash of the block." }, "signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "height": { "type": "integer", "description": "The block height." }, "block_parent_hash": { "type": "string", "description": "The parent block hash." }, "extra_data": { "type": "string", "description": "Extra data written to the block." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "mining_cost": { "type": "integer", "format": "int64", "description": "The associated mining cost." }, "gas_used": { "type": "integer", "format": "int64", "description": "The associated gas used." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The associated gas limit." }, "transactions_link": { "type": "string", "description": "The link to the related tx by block endpoint." } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BaseService.getBlockHeights({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/events/": { "get": { "tags": [ "get-logs" ], "description": "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.", "operationId": "getLogs", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "starting-block", "in": "query", "description": "The first block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.", "required": false, "schema": { "type": "integer" } }, { "name": "ending-block", "in": "query", "description": "The last block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "The address of the log events sender contract.", "required": false, "schema": { "type": "string" } }, { "name": "topics", "in": "query", "description": "The topic hash(es) to retrieve logs with.", "required": false, "schema": { "type": "string" } }, { "name": "block-hash", "in": "query", "description": "The block hash to retrieve logs for.", "required": false, "schema": { "type": "string" } }, { "name": "skip-decode", "in": "query", "description": "Omit decoded log events.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for the sender. This field is set by a developer and non-unique across a network." }, "sender_address": { "type": "string", "description": "The address of the sender." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BaseService.getLogs({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/events/address/{contractAddress}/": { "get": { "tags": [ "get-log-events-by-contract-address" ], "description": "Commonly used to get all the event logs emitted from a particular contract address. Useful for building dashboards that examine on-chain interactions.", "operationId": "getLogEventsByAddress", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "contractAddress", "in": "path", "description": "The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "starting-block", "in": "query", "description": "The first block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.", "required": false, "schema": { "type": "integer" } }, { "name": "ending-block", "in": "query", "description": "The last block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.", "required": false, "schema": { "type": "string" } }, { "name": "page-size", "in": "query", "description": "Number of items per page. Omitting this parameter defaults to 100.", "required": false, "schema": { "type": "integer" } }, { "name": "page-number", "in": "query", "description": "0-indexed page number to begin pagination.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BaseService.getLogEventsByAddress({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/events/topics/{topicHash}/": { "get": { "tags": [ "get-log-events-by-topic-hash" ], "description": "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.", "operationId": "getLogEventsByTopicHash", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "topicHash", "in": "path", "description": "The endpoint will return event logs that contain this topic hash.", "required": true, "schema": { "type": "string" } }, { "name": "starting-block", "in": "query", "description": "The first block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.", "required": false, "schema": { "type": "integer" } }, { "name": "ending-block", "in": "query", "description": "The last block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.", "required": false, "schema": { "type": "string" } }, { "name": "secondary-topics", "in": "query", "description": "Additional topic hash(es) to filter on - padded & unpadded address fields are supported. Separate multiple topics with a comma.", "required": false, "schema": { "type": "string" } }, { "name": "page-size", "in": "query", "description": "Number of items per page. Omitting this parameter defaults to 100.", "required": false, "schema": { "type": "integer" } }, { "name": "page-number", "in": "query", "description": "0-indexed page number to begin pagination.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BaseService.getLogEventsByTopicHash({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/chains/": { "get": { "tags": [ "get-all-chains" ], "description": "Commonly used to build internal dashboards for all supported chains on Covalent.", "operationId": "getAllChains", "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The chain name eg: `eth-mainnet`." }, "chain_id": { "type": "string", "description": "The requested chain ID eg: `1`." }, "is_testnet": { "type": "boolean", "description": "True if the chain is a testnet." }, "db_schema_name": { "type": "string", "description": "Schema name to use for direct SQL." }, "label": { "type": "string", "description": "The chains label eg: `Ethereum Mainnet`." }, "category_label": { "type": "string", "description": "The category label eg: `Ethereum`." }, "logo_url": { "type": "string", "description": "A png logo url for the chain." }, "black_logo_url": { "type": "string", "description": "A black png logo url for the chain." }, "white_logo_url": { "type": "string", "description": "A white png logo url for the chain." }, "color_theme": { "type": "object", "properties": { "red": { "type": "integer", "description": "The red color code." }, "green": { "type": "integer", "description": "The green color code." }, "blue": { "type": "integer", "description": "The blue color code." }, "alpha": { "type": "integer", "description": "The alpha color code." }, "hex": { "type": "string", "description": "The hexadecimal color code." }, "css_rgb": { "type": "string", "description": "The color represented in css rgb() functional notation." } }, "description": "The color theme for the chain." }, "is_appchain": { "type": "boolean", "description": "True if the chain is an AppChain." }, "appchain_of": { "type": "object", "properties": {}, "description": "The ChainItem the appchain is a part of." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BaseService.getAllChains({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/chains/status/": { "get": { "tags": [ "get-all-chain-statuses" ], "description": "Commonly used to build internal status dashboards of all supported chains.", "operationId": "getAllChainStatus", "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The chain name eg: `eth-mainnet`." }, "chain_id": { "type": "string", "description": "The requested chain ID eg: `1`." }, "is_testnet": { "type": "boolean", "description": "True if the chain is a testnet." }, "logo_url": { "type": "string", "description": "A png logo url for the chain." }, "black_logo_url": { "type": "string", "description": "A black png logo url for the chain." }, "white_logo_url": { "type": "string", "description": "A white png logo url for the chain." }, "is_appchain": { "type": "boolean", "description": "True if the chain is an AppChain." }, "chain_tip_height": { "type": "integer", "description": "The height of the lastest block available." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The signed timestamp of lastest block available." }, "has_data": { "type": "boolean", "description": "True if the chain has data and ready for querying." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BaseService.getAllChainStatus({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/address/{walletAddress}/activity/": { "get": { "tags": [ "get-address-activity" ], "description": "Commonly used to locate chains which an address is active on with a single API call.", "operationId": "getAddressActivity", "parameters": [ { "name": "walletAddress", "in": "path", "description": "The requested wallet address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "testnets", "in": "query", "description": "Set to true to include testnets with activity in the response. By default, it's set to `false` and only returns mainnet activity.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "address": { "type": "string", "description": "The requested address." }, "items": { "type": "array", "items": { "type": "object", "properties": { "extends": { "type": "object", "properties": { "name": { "type": "string", "description": "The chain name eg: `eth-mainnet`." }, "chain_id": { "type": "string", "description": "The requested chain ID eg: `1`." }, "is_testnet": { "type": "boolean", "description": "True if the chain is a testnet." }, "db_schema_name": { "type": "string", "description": "Schema name to use for direct SQL." }, "label": { "type": "string", "description": "The chains label eg: `Ethereum Mainnet`." }, "category_label": { "type": "string", "description": "The category label eg: `Ethereum`." }, "logo_url": { "type": "string", "description": "A png logo url for the chain." }, "black_logo_url": { "type": "string", "description": "A black png logo url for the chain." }, "white_logo_url": { "type": "string", "description": "A white png logo url for the chain." }, "color_theme": { "type": "object", "properties": { "red": { "type": "integer", "description": "The red color code." }, "green": { "type": "integer", "description": "The green color code." }, "blue": { "type": "integer", "description": "The blue color code." }, "alpha": { "type": "integer", "description": "The alpha color code." }, "hex": { "type": "string", "description": "The hexadecimal color code." }, "css_rgb": { "type": "string", "description": "The color represented in css rgb() functional notation." } }, "description": "The color theme for the chain." }, "is_appchain": { "type": "boolean", "description": "True if the chain is an AppChain." }, "appchain_of": { "type": "object", "properties": {}, "description": "The ChainItem the appchain is a part of." } } }, "first_seen_at": { "type": "string", "format": "date-time", "description": "The timestamp when the address was first seen on the chain." }, "last_seen_at": { "type": "string", "format": "date-time", "description": "The timestamp when the address was last seen on the chain." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BaseService.getAddressActivity({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/event/{eventType}/gas_prices/": { "get": { "tags": [ "get-gas-prices" ], "description": "Get real-time gas estimates for different transaction speeds on a specific network, enabling users to optimize transaction costs and confirmation times.", "operationId": "getGasPrices", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "eventType", "in": "path", "description": "The desired event type to retrieve gas prices for. Supports `erc20` transfer events, `uniswapv3` swap events and `nativetokens` transfers.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "event_type": { "type": "string", "description": "The requested event type." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "base_fee": { "type": "string", "description": "b;The lowest gas fee for the latest block height." }, "items": { "type": "array", "items": { "type": "object", "properties": { "gas_price": { "type": "string", "description": "The average gas price, in WEI, for the time interval." }, "gas_spent": { "type": "string", "description": "The average gas spent for the time interval." }, "gas_quote": { "type": "number", "format": "double", "description": "The average gas spent in `quote-currency` denomination for the time interval." }, "other_fees": { "type": "object", "properties": { "l_1_gas_quote": { "type": "number", "format": "double", "description": "The calculated L1 gas spent, when applicable, in quote-currency, for the specified time interval." } }, "description": "Other fees, when applicable. For example: OP chain L1 fees." }, "total_gas_quote": { "type": "number", "format": "double", "description": "The sum of the L1 and L2 gas spent, in quote-currency, for the specified time interval." }, "pretty_total_gas_quote": { "type": "string", "description": "A prettier version of the total average gas spent, in quote-currency, for the specified time interval, for rendering purposes." }, "interval": { "type": "string", "description": "The specified time interval." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.BaseService.getGasPrices({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/address/{walletAddress}/balances_nft/": { "get": { "tags": [ "get-nfts-for-address" ], "description": "Commonly used to render the NFTs (including ERC721 and ERC1155) held by an address.", "operationId": "getNftsForAddress", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "no-spam", "in": "query", "description": "If `true`, the suspected spam tokens are removed. Supported on all Foundational Chains.", "required": false, "schema": { "type": "boolean" } }, { "name": "no-nft-asset-metadata", "in": "query", "description": "If `true`, the response shape is limited to a list of collections and token ids, omitting metadata and asset information. Helpful for faster response times and wallets holding a large number of NFTs.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam. Supported on all Foundational Chains." }, "last_transfered_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was transferred." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "balance_24h": { "type": "string", "description": "b;The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "type": { "type": "string" }, "floor_price_quote": { "type": "number", "format": "double", "description": "The current floor price converted to fiat in `quote-currency`. The floor price is determined by the last minimum sale price within the last 30 days across all the supported markets where the collection is sold on." }, "pretty_floor_price_quote": { "type": "string", "description": "A prettier version of the floor price quote for rendering purposes." }, "floor_price_native_quote": { "type": "number", "format": "double", "description": "The current floor price in native currency. The floor price is determined by the last minimum sale price within the last 30 days across all the supported markets where the collection is sold on." }, "nft_data": { "type": "array", "items": { "type": "object", "properties": { "token_id": { "type": "string", "description": "b;The token's id." }, "token_url": { "type": "string" }, "original_owner": { "type": "string", "description": "The original minter." }, "current_owner": { "type": "string", "description": "The current holder of this NFT." }, "external_data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "asset_url": { "type": "string" }, "asset_file_extension": { "type": "string" }, "asset_mime_type": { "type": "string" }, "asset_size_bytes": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." } } }, "asset_cached": { "type": "boolean", "description": "If `true`, the asset data is available from the Covalent CDN." }, "image_cached": { "type": "boolean", "description": "If `true`, the image data is available from the Covalent CDN." } } } } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.NftService.getNftsForAddress({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/address/{walletAddress}/collection/{collectionContract}/": { "get": { "tags": [ "check-ownership-in-nft-collection" ], "description": "Commonly used to verify ownership of NFTs (including ERC-721 and ERC-1155) within a collection.", "operationId": "checkOwnershipInNft", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "collectionContract", "in": "path", "description": "The requested collection address.", "required": true, "schema": { "type": "string" } }, { "name": "traits-filter", "in": "query", "description": "Filters NFTs based on a specific trait. If this filter is used, the API will return all NFTs with the specified trait. Must be used with \"values-filter\", is case-sensitive, and requires proper URL encoding.", "required": false, "schema": { "type": "string" } }, { "name": "values-filter", "in": "query", "description": "Filters NFTs based on a specific trait value. If this filter is used, the API will return all NFTs with the specified trait value. Must be used with \"traits-filter\", is case-sensitive, and requires proper URL encoding.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "address": { "type": "string", "description": "The requested address." }, "collection": { "type": "string", "description": "The requested collection." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam. Supported on all Foundational Chains." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "token_id": { "type": "string", "description": "b;The token's id." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "last_transfered_at": { "type": "string", "format": "date-time" }, "balance": { "type": "string", "description": "b;Nft balance." }, "balance_24h": { "type": "string" }, "type": { "type": "string" }, "nft_data": { "type": "object", "properties": { "token_id": { "type": "string", "description": "b;The token's id." }, "token_url": { "type": "string" }, "original_owner": { "type": "string", "description": "The original minter." }, "current_owner": { "type": "string", "description": "The current holder of this NFT." }, "external_data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "asset_url": { "type": "string" }, "asset_file_extension": { "type": "string" }, "asset_mime_type": { "type": "string" }, "asset_size_bytes": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." } } }, "asset_cached": { "type": "boolean", "description": "If `true`, the asset data is available from the Covalent CDN." }, "image_cached": { "type": "boolean", "description": "If `true`, the image data is available from the Covalent CDN." } } } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.NftService.checkOwnershipInNft({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/address/{walletAddress}/collection/{collectionContract}/token/{tokenId}/": { "get": { "tags": [ "check-ownership-in-nft-collection-token" ], "description": "Commonly used to verify ownership of a specific token (ERC-721 or ERC-1155) within a collection.", "operationId": "checkOwnershipInNftForSpecificTokenId", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "collectionContract", "in": "path", "description": "The requested collection address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "tokenId", "in": "path", "description": "The requested token ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "address": { "type": "string", "description": "The requested address." }, "collection": { "type": "string", "description": "The requested collection." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam. Supported on all Foundational Chains." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "token_id": { "type": "string", "description": "b;The token's id." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "last_transfered_at": { "type": "string", "format": "date-time" }, "balance": { "type": "string", "description": "b;Nft balance." }, "balance_24h": { "type": "string" }, "type": { "type": "string" }, "nft_data": { "type": "object", "properties": { "token_id": { "type": "string", "description": "b;The token's id." }, "token_url": { "type": "string" }, "original_owner": { "type": "string", "description": "The original minter." }, "current_owner": { "type": "string", "description": "The current holder of this NFT." }, "external_data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "asset_url": { "type": "string" }, "asset_file_extension": { "type": "string" }, "asset_mime_type": { "type": "string" }, "asset_size_bytes": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." } } }, "asset_cached": { "type": "boolean", "description": "If `true`, the asset data is available from the Covalent CDN." }, "image_cached": { "type": "boolean", "description": "If `true`, the image data is available from the Covalent CDN." } } } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.NftService.checkOwnershipInNftForSpecificTokenId({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/pricing/historical_by_addresses_v2/{chainName}/{quoteCurrency}/{contractAddress}/": { "get": { "tags": [ "get-historical-token-prices" ], "description": "Get the historical prices of one (or many) large cap ERC20 tokens between specified date ranges. Also supports native tokens.", "operationId": "getTokenPrices", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "quoteCurrency", "in": "path", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": true, "schema": { "type": "string" } }, { "name": "contractAddress", "in": "path", "description": "Contract address for the token. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically. Supports multiple contract addresses separated by commas.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "The start day of the historical price range (YYYY-MM-DD).", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "The end day of the historical price range (YYYY-MM-DD).", "required": false, "schema": { "type": "string" } }, { "name": "prices-at-asc", "in": "query", "description": "Sort the prices in chronological ascending order. By default, it's set to `false` and returns prices in chronological descending order.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "update_at": { "type": "string", "format": "date-time" }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "logo_urls": { "type": "object", "properties": { "token_logo_url": { "type": "string", "description": "The token logo URL." }, "protocol_logo_url": { "type": "string", "description": "The protocol logo URL." }, "chain_logo_url": { "type": "string", "description": "The chain logo URL." } }, "description": "The contract logo URLs." }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date of the price capture." }, "price": { "type": "number", "format": "double", "description": "The price in the requested `quote-currency`." }, "pretty_price": { "type": "string", "description": "A prettier version of the price for rendering purposes." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.PricingService.getTokenPrices({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/pricing/spot_prices/{chainName}/pools/{contractAddress}/": { "get": { "tags": [ "get-pool-spot-prices" ], "description": "Get the spot token pair prices for a specified pool contract address. Supports pools on Uniswap V2, V3 and their forks. ", "operationId": "getPoolSpotPrices", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "contractAddress", "in": "path", "description": "The pool contract address.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated." }, "pool_address": { "type": "string", "description": "The deployed pool contract address." }, "token_0_address": { "type": "string", "description": "The deployed contract address of `token_0` in the token pair making up the pool." }, "token_0_name": { "type": "string", "description": "The deployed contract name of `token_0` in the token pair making up the pool." }, "token_0_ticker": { "type": "string", "description": "The deployed contract symbol of `token_0` in the token pair making up the pool." }, "token_0_price": { "type": "string", "description": "Price of `token_0` in units of `token_1`." }, "token_0_price_24h": { "type": "string", "description": "Price of `token_0` in units of `token_1` as of 24 hours ago." }, "token_0_price_quote": { "type": "string", "description": "Price of `token_0` in the selected quote currency (defaults to USD)." }, "token_0_price_24h_quote": { "type": "string", "description": "Price of `token_0` in the selected quote currency (defaults to USD) as of 24 hours ago." }, "token_1_address": { "type": "string", "description": "The deployed contract address of `token_1` in the token pair making up the pool." }, "token_1_name": { "type": "string", "description": "The deployed contract name of `token_1` in the token pair making up the pool." }, "token_1_ticker": { "type": "string", "description": "The deployed contract symbol of `token_1` in the token pair making up the pool." }, "token_1_price": { "type": "string", "description": "Price of `token_1` in units of `token_0`." }, "token_1_price_24h": { "type": "string", "description": "Price of `token_1` in units of `token_0` as of 24 hours ago." }, "token_1_price_quote": { "type": "string", "description": "Price of `token_1` in the selected quote currency (defaults to USD)." }, "token_1_price_24h_quote": { "type": "string", "description": "Price of `token_1` in the selected quote currency (defaults to USD) as of 24 hours ago." }, "quote_currency": { "type": "string", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, `GBP`, `BTC` and `ETH`." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.PricingService.getPoolSpotPrices({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/transaction_v2/{txHash}/": { "get": { "tags": [ "get-a-transaction" ], "description": "Used to fetch and render a single transaction including its decoded event logs. For foundational chains, can also retrieve internal transactions, state changes and method ID where available. ", "operationId": "getTransaction", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "txHash", "in": "path", "description": "The transaction hash.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "no-logs", "in": "query", "description": "Omit log events.", "required": false, "schema": { "type": "boolean" } }, { "name": "with-internal", "in": "query", "description": "Whether to include internal transfers/transactions.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.TransactionService.getTransaction({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/address/{walletAddress}/transactions_v3/": { "get": { "tags": [ "get-recent-transactions-for-address-v3" ], "description": "Commonly used to fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.", "operationId": "getRecentTransactionsForAddress", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "no-logs", "in": "query", "description": "Omit log events.", "required": false, "schema": { "type": "boolean" } }, { "name": "block-signed-at-asc", "in": "query", "description": "Sort the transactions in ascending chronological order. By default, it's set to `false` and returns transactions in descending chronological order.", "required": false, "schema": { "type": "boolean" } }, { "name": "with-internal", "in": "query", "description": "Whether to include internal transfers/transactions.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "current_page": { "type": "integer", "description": "The current page of the response." }, "links": { "type": "object", "properties": { "prev": { "type": "string", "description": "URL link to the next page." }, "next": { "type": "string", "description": "URL link to the previous page." } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.TransactionService.getRecentTransactionsForAddress({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/address/{walletAddress}/transactions_v3/page/{page}/": { "get": { "tags": [ "get-paginated-transactions-for-address-v3" ], "description": "Commonly used to fetch the transactions involving an address including the decoded log events in a paginated fashion.", "operationId": "getTransactionsForAddressV3", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "path", "description": "The requested page, 0-indexed.", "required": true, "schema": { "type": "integer" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "no-logs", "in": "query", "description": "Omit log events.", "required": false, "schema": { "type": "boolean" } }, { "name": "block-signed-at-asc", "in": "query", "description": "Sort the transactions in ascending chronological order. By default, it's set to `false` and returns transactions in descending chronological order.", "required": false, "schema": { "type": "boolean" } }, { "name": "with-internal", "in": "query", "description": "Whether to include internal transfers/transactions.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "current_page": { "type": "integer", "description": "The current page of the response." }, "links": { "type": "object", "properties": { "prev": { "type": "string", "description": "URL link to the next page." }, "next": { "type": "string", "description": "URL link to the previous page." } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [] } }, "/v1/{chainName}/bulk/transactions/{walletAddress}/{timeBucket}/": { "get": { "tags": [ "get-time-bucket-transactions-for-address-v3" ], "description": "Commonly used to fetch all transactions including their decoded log events in a 15-minute time bucket interval.", "operationId": "getTimeBucketTransactionsForAddress", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "timeBucket", "in": "path", "description": "The 0-indexed 15-minute time bucket. E.g. 27 Feb 2023 05:23 GMT = 1677475383 (Unix time). 1677475383/900=1863861 timeBucket.", "required": true, "schema": { "type": "integer" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "no-logs", "in": "query", "description": "Omit log events.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "complete": { "type": "boolean" }, "current_bucket": { "type": "integer", "description": "The current bucket of the response." }, "links": { "type": "object", "properties": { "prev": { "type": "string", "description": "URL link to the next page." }, "next": { "type": "string", "description": "URL link to the previous page." } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [] } }, "/v1/{chainName}/bulk/transactions/{walletAddress}/": { "get": { "tags": [ "get-earliest-transactions-for-address-v3" ], "description": "Commonly used to fetch and render the earliest transactions involving an address. Frequently seen in wallet applications.", "operationId": "getEarliestTimeBucketTransactionsForAddress", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "no-logs", "in": "query", "description": "Omit log events.", "required": false, "schema": { "type": "boolean" } }, { "name": "with-internal", "in": "query", "description": "Whether to include internal transfers/transactions.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "complete": { "type": "boolean" }, "current_bucket": { "type": "integer", "description": "The current bucket of the response." }, "links": { "type": "object", "properties": { "prev": { "type": "string", "description": "URL link to the next page." }, "next": { "type": "string", "description": "URL link to the previous page." } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [] } }, "/v1/{chainName}/block/{blockHeight}/transactions_v3/page/{page}/": { "get": { "tags": [ "get-all-transactions-in-a-block-by-page" ], "description": "Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.", "operationId": "getTransactionsForBlockByPage", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "blockHeight", "in": "path", "description": "The requested block height. Also accepts `latest` to get latest block.", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "path", "description": "The requested 0-indexed page number.", "required": true, "schema": { "type": "integer" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "no-logs", "in": "query", "description": "Omit log events.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "links": { "type": "object", "properties": { "prev": { "type": "string", "description": "URL link to the next page." }, "next": { "type": "string", "description": "URL link to the previous page." } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [] } }, "/v1/{chainName}/block/{blockHeight}/transactions_v3/": { "get": { "tags": [ "get-all-transactions-in-a-block" ], "description": "Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.", "operationId": "getTransactionsForBlock", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "blockHeight", "in": "path", "description": "The requested block height.", "required": true, "schema": { "type": "integer" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "no-logs", "in": "query", "description": "Omit log events.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.TransactionService.getTransactionsForBlock({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/block_hash/{blockHash}/transactions_v3/": { "get": { "tags": [ "get-all-transactions-in-a-block" ], "description": "Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.", "operationId": "getTransactionsForBlockHash", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "blockHash", "in": "path", "description": "The requested block hash.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "no-logs", "in": "query", "description": "Omit log events.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.TransactionService.getTransactionsForBlockHash({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/{chainName}/address/{walletAddress}/transactions_summary/": { "get": { "tags": [ "get-transaction-summary-for-address" ], "description": "Used to fetch the earliest and latest transactions, and the transaction count for a wallet. Also enriched with gas expenditure details and total ERC20 token transfers count.", "operationId": "getTransactionSummary", "parameters": [ { "name": "chainName", "in": "path", "description": "The chain name eg: `eth-mainnet`.", "required": true, "schema": { "type": "string" } }, { "name": "walletAddress", "in": "path", "description": "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.", "required": true, "schema": { "type": "string" } }, { "name": "quote-currency", "in": "query", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.", "required": false, "schema": { "type": "string" } }, { "name": "with-gas", "in": "query", "description": "Include gas summary details. Response times may be impacted for wallets with large number of transactions.", "required": false, "schema": { "type": "boolean" } }, { "name": "with-transfer-count", "in": "query", "description": "Represents the total count of ERC-20 token movement events, including `Transfer`, `Deposit` and `Withdraw`. Response times may be impacted for wallets with large number of transactions.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "address": { "type": "string", "description": "The requested address." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "total_count": { "type": "integer", "format": "int64", "description": "The total number of transactions." }, "transfer_count": { "type": "integer", "format": "int64", "description": "Represents the total count of ERC-20 token movement events, including `Transfer`, `Deposit` and `Withdraw`." }, "earliest_transaction": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_detail_link": { "type": "string", "description": "The link to the transaction details using the Covalent API." } }, "description": "The earliest transaction detected." }, "latest_transaction": { "type": "object", "properties": {}, "description": "The latest transaction detected." }, "gas_summary": { "type": "object", "properties": { "total_sent_count": { "type": "integer", "format": "int64", "description": "The total number of transactions sent by the address." }, "total_fees_paid": { "type": "string", "description": "b;The total transaction fees paid by the address, denoted in wei." }, "total_gas_quote": { "type": "number", "format": "double", "description": "The total transaction fees paid by the address, denoted in `quote-currency`." }, "pretty_total_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "average_gas_quote_per_tx": { "type": "number", "format": "double", "description": "The average gas quote per transaction." }, "pretty_average_gas_quote_per_tx": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." } }, "description": "The gas summary for the transactions." } } }, "description": "List of response items." } } } } } } }, "x-codeSamples": [ { "lang": "TypeScript", "label": "GoldRush SDK", "source": "import { GoldRushClient } from \"@covalenthq/client-sdk\";\n\nconst ApiServices = async () => {\n const client = new GoldRushClient(\"\");\n const resp = await client.TransactionService.getTransactionSummary({chainName: \"chainName\", walletAddress: \"walletAddress\"});\n console.log(resp.data);\n};\n\nApiServices();" } ] } }, "/v1/cq/covalent/app/bitcoin/transactions/": { "get": { "tags": [ "get-transactions-for-bitcoin-address" ], "description": "Used to fetch the full transaction history of a Bitcoin non-HD wallet address. ", "operationId": "getTransactionsForBtcAddress", "parameters": [ { "name": "address", "in": "query", "description": "The bitcoin address to query.", "required": false, "schema": { "type": "string" } }, { "name": "page-size", "in": "query", "description": "Number of items per page. Omitting this parameter defaults to 100.", "required": false, "schema": { "type": "integer" } }, { "name": "page-number", "in": "query", "description": "0-indexed page number to begin pagination.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "chain_id": { "type": "integer", "description": "The requested chain ID eg: `20090103`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `btc-mainnet`." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_idx": { "type": "integer", "description": "The position index of the tx in the block." }, "type": { "type": "string", "description": "Either 'input' as the sender or 'output' as the receiver of btc." }, "address": { "type": "string", "description": "The wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx in satoshi." }, "quote": { "type": "number", "format": "double", "description": "The value attached to this tx in USD." }, "quote_rate": { "type": "number", "format": "double", "description": "The value token exchange rate in USD." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees denoted in satoshi." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in USD." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas token exchange rate in USD." }, "coinbase": { "type": "boolean", "description": "Indicates if this is a coinbase tx where btc is rewarded to a miner for validating the block." }, "locktime": { "type": "integer", "description": "The earliest Unix timestamp or block height at which the tx is valid and can be included. Is `0` if no restriction." }, "weight": { "type": "integer", "description": "A measure that reflects impact on the block size limit. Used to determine fees." } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } } } } } }, "x-codeSamples": [] } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Bearer authentication header of the form: `Bearer `, where `` is your GoldRush API Key." } }, "schemas": { "ContractMetadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } } }, "Explorer": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "LogoUrls": { "type": "object", "properties": { "token_logo_url": { "type": "string", "description": "The token logo URL." }, "protocol_logo_url": { "type": "string", "description": "The protocol logo URL." }, "chain_logo_url": { "type": "string", "description": "The chain logo URL." } } }, "Pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } } }, "PaginationLinks": { "type": "object", "properties": { "prev": { "type": "string", "description": "URL link to the next page." }, "next": { "type": "string", "description": "URL link to the previous page." } } }, "AllChainsBalance": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "contract_display_name": { "type": "string", "description": "A display-friendly name for the contract." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_urls": { "type": "object", "properties": { "token_logo_url": { "type": "string", "description": "The token logo URL." }, "protocol_logo_url": { "type": "string", "description": "The protocol logo URL." }, "chain_logo_url": { "type": "string", "description": "The chain logo URL." } }, "description": "The contract logo URLs." }, "last_transferred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was transferred." }, "is_native_token": { "type": "boolean", "description": "Indicates if a token is the chain's native gas token, eg: ETH on Ethereum." }, "type": { "type": "string", "description": "One of `cryptocurrency`, `stablecoin`, `nft` or `dust`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "balance_24h": { "type": "string", "description": "b;The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote_rate_24h": { "type": "number", "format": "double", "description": "The 24h exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "quote_24h": { "type": "number", "format": "double", "description": "The 24h balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "pretty_quote_24h": { "type": "string", "description": "A prettier version of the 24h quote for rendering purposes." }, "chain_id": { "type": "integer", "description": "The chain ID that this balance is on. eg: `1`." }, "chain_name": { "type": "string", "description": "The chain name that this balance is on. eg: `eth-mainnet`." }, "chain_display_name": { "type": "string", "description": "A display-friendly name for the chain." } } }, "AllChainsBalancesResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "Timestamp for when the data was last updated." }, "cursor_before": { "type": "string", "description": "Pagination cursor pointing to the previous page." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "contract_display_name": { "type": "string", "description": "A display-friendly name for the contract." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_urls": { "type": "object", "properties": { "token_logo_url": { "type": "string", "description": "The token logo URL." }, "protocol_logo_url": { "type": "string", "description": "The protocol logo URL." }, "chain_logo_url": { "type": "string", "description": "The chain logo URL." } }, "description": "The contract logo URLs." }, "last_transferred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was transferred." }, "is_native_token": { "type": "boolean", "description": "Indicates if a token is the chain's native gas token, eg: ETH on Ethereum." }, "type": { "type": "string", "description": "One of `cryptocurrency`, `stablecoin`, `nft` or `dust`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "balance_24h": { "type": "string", "description": "b;The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote_rate_24h": { "type": "number", "format": "double", "description": "The 24h exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "quote_24h": { "type": "number", "format": "double", "description": "The 24h balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "pretty_quote_24h": { "type": "string", "description": "A prettier version of the 24h quote for rendering purposes." }, "chain_id": { "type": "integer", "description": "The chain ID that this balance is on. eg: `1`." }, "chain_name": { "type": "string", "description": "The chain name that this balance is on. eg: `eth-mainnet`." }, "chain_display_name": { "type": "string", "description": "A display-friendly name for the chain." } } }, "description": "List of token balances returned by the API." } } }, "AllChainsTransaction": { "type": "object", "properties": { "block_height": { "type": "integer", "description": "The height of the block." }, "block_signed_at": { "type": "string", "format": "date-time", "description": "The signed block timestamp in UTC." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from blocks that are reorged." }, "tx_hash": { "type": "string", "description": "The transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "miner_address": { "type": "string", "description": "The address of the miner who mined the block." }, "from_address": { "type": "string" }, "to_address": { "type": "string", "description": "The recipient's wallet address." }, "value": { "type": "string", "description": "b;The value of the transaction in wei." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_offered": { "type": "integer", "format": "int64", "description": "The gas offered for the transaction." }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas actually spent by the transaction." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "successful": { "type": "boolean", "description": "Indicated whether the transaction was successful or failed." }, "chain_id": { "type": "string", "description": "The chain ID of the blockchain where the transaction occurred." }, "chain_name": { "type": "string", "description": "The chain name of the blockchain where the transaction occurred." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The block explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "Event logs generated by the transaction." } } }, "AllChainsTransactionsResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "Timestamp for when the data was last updated." }, "cursor_before": { "type": "string", "description": "Pagination cursor pointing to the previous page." }, "cursor_after": { "type": "string", "description": "Pagination cursor pointing to the next page." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_height": { "type": "integer", "description": "The height of the block." }, "block_signed_at": { "type": "string", "format": "date-time", "description": "The signed block timestamp in UTC." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from blocks that are reorged." }, "tx_hash": { "type": "string", "description": "The transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "miner_address": { "type": "string", "description": "The address of the miner who mined the block." }, "from_address": { "type": "string" }, "to_address": { "type": "string", "description": "The recipient's wallet address." }, "value": { "type": "string", "description": "b;The value of the transaction in wei." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_offered": { "type": "integer", "format": "int64", "description": "The gas offered for the transaction." }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas actually spent by the transaction." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "successful": { "type": "boolean", "description": "Indicated whether the transaction was successful or failed." }, "chain_id": { "type": "string", "description": "The chain ID of the blockchain where the transaction occurred." }, "chain_name": { "type": "string", "description": "The chain name of the blockchain where the transaction occurred." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The block explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "Event logs generated by the transaction." } } }, "description": "List of transactions returned by the API." } } }, "DecodedItem": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } } }, "LogEvent": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "Param": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } }, "ApprovalsResponse": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "token_address": { "type": "string", "description": "The address for the token that has approvals." }, "token_address_label": { "type": "string", "description": "The name for the token that has approvals." }, "ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "balance": { "type": "string", "description": "b;Wallet balance of the token." }, "balance_quote": { "type": "number", "format": "double", "description": "Value of the wallet balance of the token." }, "pretty_balance_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "value_at_risk": { "type": "string", "description": "Total amount at risk across all spenders." }, "value_at_risk_quote": { "type": "number", "format": "double", "description": "Value of total amount at risk across all spenders." }, "pretty_value_at_risk_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "spenders": { "type": "array", "items": { "type": "object", "properties": { "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log.\"" }, "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "tx_hash": { "type": "string", "description": "Most recent transaction that updated approval amounts for the token." }, "spender_address": { "type": "string", "description": "Address of the contract with approval for the token." }, "allowance": { "type": "string", "description": "Remaining number of tokens granted to the spender by the approval." }, "allowance_quote": { "type": "number", "format": "double", "description": "Value of the remaining allowance specified by the approval." }, "pretty_allowance_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "value_at_risk": { "type": "string", "description": "Amount at risk for spender." }, "value_at_risk_quote": { "type": "number", "format": "double", "description": "Value of amount at risk for spender." }, "pretty_value_at_risk_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "risk_factor": { "type": "string" } } }, "description": "Contracts with non-zero approvals for this token." } } }, "description": "List of response items." } } }, "TokenSpenderItem": { "type": "object", "properties": { "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log.\"" }, "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "tx_hash": { "type": "string", "description": "Most recent transaction that updated approval amounts for the token." }, "spender_address": { "type": "string", "description": "Address of the contract with approval for the token." }, "allowance": { "type": "string", "description": "Remaining number of tokens granted to the spender by the approval." }, "allowance_quote": { "type": "number", "format": "double", "description": "Value of the remaining allowance specified by the approval." }, "pretty_allowance_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "value_at_risk": { "type": "string", "description": "Amount at risk for spender." }, "value_at_risk_quote": { "type": "number", "format": "double", "description": "Value of amount at risk for spender." }, "pretty_value_at_risk_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "risk_factor": { "type": "string" } } }, "TokensApprovalItem": { "type": "object", "properties": { "token_address": { "type": "string", "description": "The address for the token that has approvals." }, "token_address_label": { "type": "string", "description": "The name for the token that has approvals." }, "ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "balance": { "type": "string", "description": "b;Wallet balance of the token." }, "balance_quote": { "type": "number", "format": "double", "description": "Value of the wallet balance of the token." }, "pretty_balance_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "value_at_risk": { "type": "string", "description": "Total amount at risk across all spenders." }, "value_at_risk_quote": { "type": "number", "format": "double", "description": "Value of total amount at risk across all spenders." }, "pretty_value_at_risk_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "spenders": { "type": "array", "items": { "type": "object", "properties": { "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log.\"" }, "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "tx_hash": { "type": "string", "description": "Most recent transaction that updated approval amounts for the token." }, "spender_address": { "type": "string", "description": "Address of the contract with approval for the token." }, "allowance": { "type": "string", "description": "Remaining number of tokens granted to the spender by the approval." }, "allowance_quote": { "type": "number", "format": "double", "description": "Value of the remaining allowance specified by the approval." }, "pretty_allowance_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "value_at_risk": { "type": "string", "description": "Amount at risk for spender." }, "value_at_risk_quote": { "type": "number", "format": "double", "description": "Value of amount at risk for spender." }, "pretty_value_at_risk_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "risk_factor": { "type": "string" } } }, "description": "Contracts with non-zero approvals for this token." } } }, "BalanceItem": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "contract_display_name": { "type": "string", "description": "A display-friendly name for the contract." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_urls": { "type": "object", "properties": { "token_logo_url": { "type": "string", "description": "The token logo URL." }, "protocol_logo_url": { "type": "string", "description": "The protocol logo URL." }, "chain_logo_url": { "type": "string", "description": "The chain logo URL." } }, "description": "The contract logo URLs." }, "last_transferred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was transferred." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "is_native_token": { "type": "boolean", "description": "Indicates if a token is the chain's native gas token, eg: ETH on Ethereum." }, "type": { "type": "string", "description": "One of `cryptocurrency`, `stablecoin`, `nft` or `dust`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "balance_24h": { "type": "string", "description": "b;The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote_rate_24h": { "type": "number", "format": "double", "description": "The 24h exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "quote_24h": { "type": "number", "format": "double", "description": "The 24h balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "pretty_quote_24h": { "type": "string", "description": "A prettier version of the 24h quote for rendering purposes." } } }, "BalanceNftData": { "type": "object", "properties": { "token_id": { "type": "string", "description": "b;The token's id." }, "token_balance": { "type": "string", "description": "b;The count of the number of NFTs with this ID." }, "token_url": { "type": "string", "description": "External URL for additional metadata." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "token_price_wei": { "type": "string", "description": "b;The latest price value on chain of the token ID." }, "token_quote_rate_eth": { "type": "string", "description": "The latest quote_rate of the token ID denominated in unscaled ETH." }, "original_owner": { "type": "string", "description": "The address of the original owner of this NFT." }, "external_data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." }, "owner": { "type": "string" } } }, "owner": { "type": "string", "description": "The current owner of this NFT." }, "owner_address": { "type": "string", "description": "The address of the current owner of this NFT." }, "burned": { "type": "boolean", "description": "When set to true, this NFT has been Burned." } } }, "BalancesResponse": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "contract_display_name": { "type": "string", "description": "A display-friendly name for the contract." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_urls": { "type": "object", "properties": { "token_logo_url": { "type": "string", "description": "The token logo URL." }, "protocol_logo_url": { "type": "string", "description": "The protocol logo URL." }, "chain_logo_url": { "type": "string", "description": "The chain logo URL." } }, "description": "The contract logo URLs." }, "last_transferred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was transferred." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "is_native_token": { "type": "boolean", "description": "Indicates if a token is the chain's native gas token, eg: ETH on Ethereum." }, "type": { "type": "string", "description": "One of `cryptocurrency`, `stablecoin`, `nft` or `dust`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "balance_24h": { "type": "string", "description": "b;The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote_rate_24h": { "type": "number", "format": "double", "description": "The 24h exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "quote_24h": { "type": "number", "format": "double", "description": "The 24h balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "pretty_quote_24h": { "type": "string", "description": "A prettier version of the 24h quote for rendering purposes." } } }, "description": "List of response items." } } }, "BitcoinHdBalanceItem": { "type": "object", "properties": { "child_address": { "type": "string", "description": "The specific Bitcoin address derived from the HD wallet." }, "address_path": { "type": "string", "description": "Derivation path used to derive the specific Bitcoin address, e.g., `M/0H/0/0`." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The name of the token, e.g., `Bitcoin`." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for the token, e.g., `BTC`." }, "contract_address": { "type": "string", "description": "Address placeholder for native tokens like BTC." }, "contract_display_name": { "type": "string", "description": "A display-friendly name for the token, e.g., `Bitcoin`." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "Typically null for Bitcoin, but left for compatibility." }, "logo_urls": { "type": "object", "properties": { "token_logo_url": { "type": "string", "description": "The token logo URL." }, "protocol_logo_url": { "type": "string", "description": "The protocol logo URL." }, "chain_logo_url": { "type": "string", "description": "The chain logo URL." } }, "description": "The contract logo URLs." }, "last_transferred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was last transferred." }, "is_native_token": { "type": "boolean", "description": "Indicates if a token is the chain's native gas token, eg: BTC on Bitcoin." }, "type": { "type": "string", "description": "One of `cryptocurrency`, `stablecoin`, `nft` or `dust`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "balance_24h": { "type": "string", "description": "b;The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote_rate_24h": { "type": "number", "format": "double", "description": "The 24h exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "quote_24h": { "type": "number", "format": "double", "description": "The 24h balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "pretty_quote_24h": { "type": "string", "description": "A prettier version of the 24h quote for rendering purposes." } } }, "BitcoinHdBalancesResponse": { "type": "object", "properties": { "address": { "type": "string", "description": "The extended public key (xPub/yPub/zPub) or HD wallet address." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `20090103`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `btc-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "child_address": { "type": "string", "description": "The specific Bitcoin address derived from the HD wallet." }, "address_path": { "type": "string", "description": "Derivation path used to derive the specific Bitcoin address, e.g., `M/0H/0/0`." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The name of the token, e.g., `Bitcoin`." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for the token, e.g., `BTC`." }, "contract_address": { "type": "string", "description": "Address placeholder for native tokens like BTC." }, "contract_display_name": { "type": "string", "description": "A display-friendly name for the token, e.g., `Bitcoin`." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "Typically null for Bitcoin, but left for compatibility." }, "logo_urls": { "type": "object", "properties": { "token_logo_url": { "type": "string", "description": "The token logo URL." }, "protocol_logo_url": { "type": "string", "description": "The protocol logo URL." }, "chain_logo_url": { "type": "string", "description": "The chain logo URL." } }, "description": "The contract logo URLs." }, "last_transferred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was last transferred." }, "is_native_token": { "type": "boolean", "description": "Indicates if a token is the chain's native gas token, eg: BTC on Bitcoin." }, "type": { "type": "string", "description": "One of `cryptocurrency`, `stablecoin`, `nft` or `dust`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "balance_24h": { "type": "string", "description": "b;The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote_rate_24h": { "type": "number", "format": "double", "description": "The 24h exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "quote_24h": { "type": "number", "format": "double", "description": "The 24h balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "pretty_quote_24h": { "type": "string", "description": "A prettier version of the 24h quote for rendering purposes." } } }, "description": "List of HD wallet balance items, each containing derived addresses and balances." } } }, "BlockTransactionWithContractTransfers": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Whether or not transaction is successful." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The transaction's gas_price * gas_spent, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "transfers": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "transfer_type": { "type": "string", "description": "Categorizes token transactions as either `transfer-in` or `transfer-out`, indicating whether tokens are being received or sent from an account." }, "delta": { "type": "string", "description": "b;The delta attached to this transfer." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "delta_quote": { "type": "number", "format": "double", "description": "The current delta converted to fiat in `quote-currency`." }, "pretty_delta_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "balance_quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "method_calls": { "type": "array", "items": { "type": "object", "properties": { "sender_address": { "type": "string", "description": "The address of the sender." }, "method": { "type": "string" } } }, "description": "Additional details on which transfer events were invoked. Defaults to `true`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." } } } } } }, "Erc20TransfersResponse": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Whether or not transaction is successful." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The transaction's gas_price * gas_spent, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "transfers": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "transfer_type": { "type": "string", "description": "Categorizes token transactions as either `transfer-in` or `transfer-out`, indicating whether tokens are being received or sent from an account." }, "delta": { "type": "string", "description": "b;The delta attached to this transfer." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "delta_quote": { "type": "number", "format": "double", "description": "The current delta converted to fiat in `quote-currency`." }, "pretty_delta_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "balance_quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "method_calls": { "type": "array", "items": { "type": "object", "properties": { "sender_address": { "type": "string", "description": "The address of the sender." }, "method": { "type": "string" } } }, "description": "Additional details on which transfer events were invoked. Defaults to `true`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." } } } } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } }, "HistoricalBalanceItem": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "last_transferred_block_height": { "type": "integer", "format": "int64", "description": "The block height when the token was last transferred." }, "contract_display_name": { "type": "string" }, "last_transferred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was transferred." }, "is_native_token": { "type": "boolean", "description": "Indicates if a token is the chain's native gas token, eg: ETH on Ethereum." }, "type": { "type": "string", "description": "One of `cryptocurrency`, `stablecoin`, `nft` or `dust`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." } } }, "HistoricalBalancesResponse": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "last_transferred_block_height": { "type": "integer", "format": "int64", "description": "The block height when the token was last transferred." }, "contract_display_name": { "type": "string" }, "last_transferred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was transferred." }, "is_native_token": { "type": "boolean", "description": "Indicates if a token is the chain's native gas token, eg: ETH on Ethereum." }, "type": { "type": "string", "description": "One of `cryptocurrency`, `stablecoin`, `nft` or `dust`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." } } }, "description": "List of response items." } } }, "HoldingItem": { "type": "object", "properties": { "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "timestamp": { "type": "string", "format": "date-time" }, "close": { "type": "object", "properties": { "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." } } }, "high": { "type": "object", "properties": {} }, "low": { "type": "object", "properties": {} }, "open": { "type": "object", "properties": {} } } }, "MethodCallsForTransfers": { "type": "object", "properties": { "sender_address": { "type": "string", "description": "The address of the sender." }, "method": { "type": "string" } } }, "NativeBalanceItem": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." } } }, "OhlcItem": { "type": "object", "properties": { "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." } } }, "PortfolioItem": { "type": "object", "properties": { "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "holdings": { "type": "array", "items": { "type": "object", "properties": { "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "timestamp": { "type": "string", "format": "date-time" }, "close": { "type": "object", "properties": { "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." } } }, "high": { "type": "object", "properties": {} }, "low": { "type": "object", "properties": {} }, "open": { "type": "object", "properties": {} } } } } } }, "PortfolioResponse": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "holdings": { "type": "array", "items": { "type": "object", "properties": { "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "timestamp": { "type": "string", "format": "date-time" }, "close": { "type": "object", "properties": { "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." } } }, "high": { "type": "object", "properties": {} }, "low": { "type": "object", "properties": {} }, "open": { "type": "object", "properties": {} } } } } } }, "description": "List of response items." } } }, "ProtocolMetadata": { "type": "object", "properties": { "protocol_name": { "type": "string", "description": "The name of the protocol." } } }, "TokenBalanceNativeResponse": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "pretty_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." } } }, "description": "List of response items." } } }, "TokenHolder": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "address": { "type": "string", "description": "The requested address." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "total_supply": { "type": "string", "description": "b;Total supply of this token." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." } } }, "TokenHoldersChangesResponse": { "type": "object", "properties": { "token_holder": { "type": "string", "description": "The token holder." }, "prev_balance": { "type": "string", "description": "The starting block balance." }, "prev_block_height": { "type": "integer", "format": "int64", "description": "The starting block height." }, "next_balance": { "type": "string", "description": "The ending block balance." }, "next_block_height": { "type": "integer", "format": "int64", "description": "The ending block height." }, "diff": { "type": "string", "description": "The difference of the balance." } } }, "TokenHoldersResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "address": { "type": "string", "description": "The requested address." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "total_supply": { "type": "string", "description": "b;Total supply of this token." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } }, "TokenTransferItem": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "transfer_type": { "type": "string", "description": "Categorizes token transactions as either `transfer-in` or `transfer-out`, indicating whether tokens are being received or sent from an account." }, "delta": { "type": "string", "description": "b;The delta attached to this transfer." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "delta_quote": { "type": "number", "format": "double", "description": "The current delta converted to fiat in `quote-currency`." }, "pretty_delta_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "balance_quote": { "type": "number", "format": "double", "description": "The current balance converted to fiat in `quote-currency`." }, "method_calls": { "type": "array", "items": { "type": "object", "properties": { "sender_address": { "type": "string", "description": "The address of the sender." }, "method": { "type": "string" } } }, "description": "Additional details on which transfer events were invoked. Defaults to `true`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." } } }, "AllChainsResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The chain name eg: `eth-mainnet`." }, "chain_id": { "type": "string", "description": "The requested chain ID eg: `1`." }, "is_testnet": { "type": "boolean", "description": "True if the chain is a testnet." }, "db_schema_name": { "type": "string", "description": "Schema name to use for direct SQL." }, "label": { "type": "string", "description": "The chains label eg: `Ethereum Mainnet`." }, "category_label": { "type": "string", "description": "The category label eg: `Ethereum`." }, "logo_url": { "type": "string", "description": "A png logo url for the chain." }, "black_logo_url": { "type": "string", "description": "A black png logo url for the chain." }, "white_logo_url": { "type": "string", "description": "A white png logo url for the chain." }, "color_theme": { "type": "object", "properties": { "red": { "type": "integer", "description": "The red color code." }, "green": { "type": "integer", "description": "The green color code." }, "blue": { "type": "integer", "description": "The blue color code." }, "alpha": { "type": "integer", "description": "The alpha color code." }, "hex": { "type": "string", "description": "The hexadecimal color code." }, "css_rgb": { "type": "string", "description": "The color represented in css rgb() functional notation." } }, "description": "The color theme for the chain." }, "is_appchain": { "type": "boolean", "description": "True if the chain is an AppChain." }, "appchain_of": { "type": "object", "properties": {}, "description": "The ChainItem the appchain is a part of." } } }, "description": "List of response items." } } }, "AllChainsStatusResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The chain name eg: `eth-mainnet`." }, "chain_id": { "type": "string", "description": "The requested chain ID eg: `1`." }, "is_testnet": { "type": "boolean", "description": "True if the chain is a testnet." }, "logo_url": { "type": "string", "description": "A png logo url for the chain." }, "black_logo_url": { "type": "string", "description": "A black png logo url for the chain." }, "white_logo_url": { "type": "string", "description": "A white png logo url for the chain." }, "is_appchain": { "type": "boolean", "description": "True if the chain is an AppChain." }, "chain_tip_height": { "type": "integer", "description": "The height of the lastest block available." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The signed timestamp of lastest block available." }, "has_data": { "type": "boolean", "description": "True if the chain has data and ready for querying." } } }, "description": "List of response items." } } }, "Block": { "type": "object", "properties": { "block_hash": { "type": "string", "description": "The hash of the block." }, "signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "height": { "type": "integer", "description": "The block height." }, "block_parent_hash": { "type": "string", "description": "The parent block hash." }, "extra_data": { "type": "string", "description": "Extra data written to the block." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "mining_cost": { "type": "integer", "format": "int64", "description": "The associated mining cost." }, "gas_used": { "type": "integer", "format": "int64", "description": "The associated gas used." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The associated gas limit." }, "transactions_link": { "type": "string", "description": "The link to the related tx by block endpoint." } } }, "BlockHeights": { "type": "object", "properties": { "block_hash": { "type": "string", "description": "The hash of the block." }, "signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "height": { "type": "integer", "description": "The block height." }, "block_parent_hash": { "type": "string", "description": "The parent block hash." }, "extra_data": { "type": "string", "description": "Extra data written to the block." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "mining_cost": { "type": "integer", "format": "int64", "description": "The associated mining cost." }, "gas_used": { "type": "integer", "format": "int64", "description": "The associated gas used." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The associated gas limit." }, "transactions_link": { "type": "string", "description": "The link to the related tx by block endpoint." } } }, "BlockHeightsResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_hash": { "type": "string", "description": "The hash of the block." }, "signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "height": { "type": "integer", "description": "The block height." }, "block_parent_hash": { "type": "string", "description": "The parent block hash." }, "extra_data": { "type": "string", "description": "Extra data written to the block." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "mining_cost": { "type": "integer", "format": "int64", "description": "The associated mining cost." }, "gas_used": { "type": "integer", "format": "int64", "description": "The associated gas used." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The associated gas limit." }, "transactions_link": { "type": "string", "description": "The link to the related tx by block endpoint." } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } }, "BlockResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_hash": { "type": "string", "description": "The hash of the block." }, "signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "height": { "type": "integer", "description": "The block height." }, "block_parent_hash": { "type": "string", "description": "The parent block hash." }, "extra_data": { "type": "string", "description": "Extra data written to the block." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "mining_cost": { "type": "integer", "format": "int64", "description": "The associated mining cost." }, "gas_used": { "type": "integer", "format": "int64", "description": "The associated gas used." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The associated gas limit." }, "transactions_link": { "type": "string", "description": "The link to the related tx by block endpoint." } } }, "description": "List of response items." } } }, "ChainActivityEvent": { "type": "object", "properties": { "extends": { "type": "object", "properties": { "name": { "type": "string", "description": "The chain name eg: `eth-mainnet`." }, "chain_id": { "type": "string", "description": "The requested chain ID eg: `1`." }, "is_testnet": { "type": "boolean", "description": "True if the chain is a testnet." }, "db_schema_name": { "type": "string", "description": "Schema name to use for direct SQL." }, "label": { "type": "string", "description": "The chains label eg: `Ethereum Mainnet`." }, "category_label": { "type": "string", "description": "The category label eg: `Ethereum`." }, "logo_url": { "type": "string", "description": "A png logo url for the chain." }, "black_logo_url": { "type": "string", "description": "A black png logo url for the chain." }, "white_logo_url": { "type": "string", "description": "A white png logo url for the chain." }, "color_theme": { "type": "object", "properties": { "red": { "type": "integer", "description": "The red color code." }, "green": { "type": "integer", "description": "The green color code." }, "blue": { "type": "integer", "description": "The blue color code." }, "alpha": { "type": "integer", "description": "The alpha color code." }, "hex": { "type": "string", "description": "The hexadecimal color code." }, "css_rgb": { "type": "string", "description": "The color represented in css rgb() functional notation." } }, "description": "The color theme for the chain." }, "is_appchain": { "type": "boolean", "description": "True if the chain is an AppChain." }, "appchain_of": { "type": "object", "properties": {}, "description": "The ChainItem the appchain is a part of." } } }, "first_seen_at": { "type": "string", "format": "date-time", "description": "The timestamp when the address was first seen on the chain." }, "last_seen_at": { "type": "string", "format": "date-time", "description": "The timestamp when the address was last seen on the chain." } } }, "ChainActivityResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "address": { "type": "string", "description": "The requested address." }, "items": { "type": "array", "items": { "type": "object", "properties": { "extends": { "type": "object", "properties": { "name": { "type": "string", "description": "The chain name eg: `eth-mainnet`." }, "chain_id": { "type": "string", "description": "The requested chain ID eg: `1`." }, "is_testnet": { "type": "boolean", "description": "True if the chain is a testnet." }, "db_schema_name": { "type": "string", "description": "Schema name to use for direct SQL." }, "label": { "type": "string", "description": "The chains label eg: `Ethereum Mainnet`." }, "category_label": { "type": "string", "description": "The category label eg: `Ethereum`." }, "logo_url": { "type": "string", "description": "A png logo url for the chain." }, "black_logo_url": { "type": "string", "description": "A black png logo url for the chain." }, "white_logo_url": { "type": "string", "description": "A white png logo url for the chain." }, "color_theme": { "type": "object", "properties": { "red": { "type": "integer", "description": "The red color code." }, "green": { "type": "integer", "description": "The green color code." }, "blue": { "type": "integer", "description": "The blue color code." }, "alpha": { "type": "integer", "description": "The alpha color code." }, "hex": { "type": "string", "description": "The hexadecimal color code." }, "css_rgb": { "type": "string", "description": "The color represented in css rgb() functional notation." } }, "description": "The color theme for the chain." }, "is_appchain": { "type": "boolean", "description": "True if the chain is an AppChain." }, "appchain_of": { "type": "object", "properties": {}, "description": "The ChainItem the appchain is a part of." } } }, "first_seen_at": { "type": "string", "format": "date-time", "description": "The timestamp when the address was first seen on the chain." }, "last_seen_at": { "type": "string", "format": "date-time", "description": "The timestamp when the address was last seen on the chain." } } }, "description": "List of response items." } } }, "ChainItem": { "type": "object", "properties": { "name": { "type": "string", "description": "The chain name eg: `eth-mainnet`." }, "chain_id": { "type": "string", "description": "The requested chain ID eg: `1`." }, "is_testnet": { "type": "boolean", "description": "True if the chain is a testnet." }, "db_schema_name": { "type": "string", "description": "Schema name to use for direct SQL." }, "label": { "type": "string", "description": "The chains label eg: `Ethereum Mainnet`." }, "category_label": { "type": "string", "description": "The category label eg: `Ethereum`." }, "logo_url": { "type": "string", "description": "A png logo url for the chain." }, "black_logo_url": { "type": "string", "description": "A black png logo url for the chain." }, "white_logo_url": { "type": "string", "description": "A white png logo url for the chain." }, "color_theme": { "type": "object", "properties": { "red": { "type": "integer", "description": "The red color code." }, "green": { "type": "integer", "description": "The green color code." }, "blue": { "type": "integer", "description": "The blue color code." }, "alpha": { "type": "integer", "description": "The alpha color code." }, "hex": { "type": "string", "description": "The hexadecimal color code." }, "css_rgb": { "type": "string", "description": "The color represented in css rgb() functional notation." } }, "description": "The color theme for the chain." }, "is_appchain": { "type": "boolean", "description": "True if the chain is an AppChain." }, "appchain_of": { "type": "object", "properties": { "name": { "type": "string", "description": "The chain name eg: `eth-mainnet`." }, "chain_id": { "type": "string", "description": "The requested chain ID eg: `1`." }, "is_testnet": { "type": "boolean", "description": "True if the chain is a testnet." }, "db_schema_name": { "type": "string", "description": "Schema name to use for direct SQL." }, "label": { "type": "string", "description": "The chains label eg: `Ethereum Mainnet`." }, "category_label": { "type": "string", "description": "The category label eg: `Ethereum`." }, "logo_url": { "type": "string", "description": "A png logo url for the chain." }, "black_logo_url": { "type": "string", "description": "A black png logo url for the chain." }, "white_logo_url": { "type": "string", "description": "A white png logo url for the chain." }, "color_theme": { "type": "object", "properties": {}, "description": "The color theme for the chain." }, "is_appchain": { "type": "boolean", "description": "True if the chain is an AppChain." }, "appchain_of": { "type": "object", "properties": {}, "description": "The ChainItem the appchain is a part of." } }, "description": "The ChainItem the appchain is a part of." } } }, "ChainStatusItem": { "type": "object", "properties": { "name": { "type": "string", "description": "The chain name eg: `eth-mainnet`." }, "chain_id": { "type": "string", "description": "The requested chain ID eg: `1`." }, "is_testnet": { "type": "boolean", "description": "True if the chain is a testnet." }, "logo_url": { "type": "string", "description": "A png logo url for the chain." }, "black_logo_url": { "type": "string", "description": "A black png logo url for the chain." }, "white_logo_url": { "type": "string", "description": "A white png logo url for the chain." }, "is_appchain": { "type": "boolean", "description": "True if the chain is an AppChain." }, "chain_tip_height": { "type": "integer", "description": "The height of the lastest block available." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The signed timestamp of lastest block available." }, "has_data": { "type": "boolean", "description": "True if the chain has data and ready for querying." } } }, "ColorTheme": { "type": "object", "properties": { "red": { "type": "integer", "description": "The red color code." }, "green": { "type": "integer", "description": "The green color code." }, "blue": { "type": "integer", "description": "The blue color code." }, "alpha": { "type": "integer", "description": "The alpha color code." }, "hex": { "type": "string", "description": "The hexadecimal color code." }, "css_rgb": { "type": "string", "description": "The color represented in css rgb() functional notation." } } }, "GasPricesResponse": { "type": "object", "properties": { "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "event_type": { "type": "string", "description": "The requested event type." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The exchange rate for the requested quote currency." }, "base_fee": { "type": "string", "description": "b;The lowest gas fee for the latest block height." }, "items": { "type": "array", "items": { "type": "object", "properties": { "gas_price": { "type": "string", "description": "The average gas price, in WEI, for the time interval." }, "gas_spent": { "type": "string", "description": "The average gas spent for the time interval." }, "gas_quote": { "type": "number", "format": "double", "description": "The average gas spent in `quote-currency` denomination for the time interval." }, "other_fees": { "type": "object", "properties": { "l_1_gas_quote": { "type": "number", "format": "double", "description": "The calculated L1 gas spent, when applicable, in quote-currency, for the specified time interval." } }, "description": "Other fees, when applicable. For example: OP chain L1 fees." }, "total_gas_quote": { "type": "number", "format": "double", "description": "The sum of the L1 and L2 gas spent, in quote-currency, for the specified time interval." }, "pretty_total_gas_quote": { "type": "string", "description": "A prettier version of the total average gas spent, in quote-currency, for the specified time interval, for rendering purposes." }, "interval": { "type": "string", "description": "The specified time interval." } } }, "description": "List of response items." } } }, "GetLogsEvent": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for the sender. This field is set by a developer and non-unique across a network." }, "sender_address": { "type": "string", "description": "The address of the sender." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "GetLogsResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for the sender. This field is set by a developer and non-unique across a network." }, "sender_address": { "type": "string", "description": "The address of the sender." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "List of response items." } } }, "LogEventsByAddressResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } }, "LogEventsByTopicHashResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } }, "OtherFees": { "type": "object", "properties": { "l_1_gas_quote": { "type": "number", "format": "double", "description": "The calculated L1 gas spent, when applicable, in quote-currency, for the specified time interval." } } }, "PriceItem": { "type": "object", "properties": { "gas_price": { "type": "string", "description": "The average gas price, in WEI, for the time interval." }, "gas_spent": { "type": "string", "description": "The average gas spent for the time interval." }, "gas_quote": { "type": "number", "format": "double", "description": "The average gas spent in `quote-currency` denomination for the time interval." }, "other_fees": { "type": "object", "properties": { "l_1_gas_quote": { "type": "number", "format": "double", "description": "The calculated L1 gas spent, when applicable, in quote-currency, for the specified time interval." } }, "description": "Other fees, when applicable. For example: OP chain L1 fees." }, "total_gas_quote": { "type": "number", "format": "double", "description": "The sum of the L1 and L2 gas spent, in quote-currency, for the specified time interval." }, "pretty_total_gas_quote": { "type": "string", "description": "A prettier version of the total average gas spent, in quote-currency, for the specified time interval, for rendering purposes." }, "interval": { "type": "string", "description": "The specified time interval." } } }, "ResolvedAddress": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "name": { "type": "string" } } }, "description": "List of response items." } } }, "ResolvedAddressItem": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "name": { "type": "string" } } }, "ChainCollectionItem": { "type": "object", "properties": { "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam. Supported on all Foundational Chains." }, "token_total_supply": { "type": "integer", "format": "int64" }, "cached_metadata_count": { "type": "integer", "format": "int64" }, "cached_asset_count": { "type": "integer", "format": "int64" }, "last_scraped_at": { "type": "string", "format": "date-time" } } }, "ChainCollectionResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam. Supported on all Foundational Chains." }, "token_total_supply": { "type": "integer", "format": "int64" }, "cached_metadata_count": { "type": "integer", "format": "int64" }, "cached_asset_count": { "type": "integer", "format": "int64" }, "last_scraped_at": { "type": "string", "format": "date-time" } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } }, "CollectionCacheItem": { "type": "object", "properties": { "requested_collection_address": { "type": "string", "description": "The requested NFT collection contract address." }, "requested_collection_name": { "type": "string", "description": "The requested NFT collection name." }, "token_total_supply_identified": { "type": "integer", "format": "int64", "description": "The number of NFTs identified making up the total supply for the requested collection." }, "cached_metadata_count": { "type": "integer", "format": "int64", "description": "The number of NFTs where the metadata (e.g. name, description, attributes) has been cached for the requested collection." }, "cached_asset_count": { "type": "integer", "format": "int64", "description": "The number of NFTs where the asset (e.g. image, video, audio) has been cached for the requested collection." }, "cached_thumbnail_count": { "type": "integer", "format": "int64", "description": "The number of NFTs where a set of thumbnails (e.g. different image sizes, open graph image, thumbhash) have been created and cached for the requested collection." }, "last_scraped_at": { "type": "string", "format": "date-time", "description": "The timestamp of any last cache event (metadata, asset or thumbnail) done for any NFTs in the requested collection." }, "requested_collection_queued": { "type": "boolean", "description": "Boolean to indicate if the cache request is in the queue or completed (i.e. `false`)." } } }, "CollectionCacheResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "requested_collection_address": { "type": "string", "description": "The requested NFT collection contract address." }, "requested_collection_name": { "type": "string", "description": "The requested NFT collection name." }, "token_total_supply_identified": { "type": "integer", "format": "int64", "description": "The number of NFTs identified making up the total supply for the requested collection." }, "cached_metadata_count": { "type": "integer", "format": "int64", "description": "The number of NFTs where the metadata (e.g. name, description, attributes) has been cached for the requested collection." }, "cached_asset_count": { "type": "integer", "format": "int64", "description": "The number of NFTs where the asset (e.g. image, video, audio) has been cached for the requested collection." }, "cached_thumbnail_count": { "type": "integer", "format": "int64", "description": "The number of NFTs where a set of thumbnails (e.g. different image sizes, open graph image, thumbhash) have been created and cached for the requested collection." }, "last_scraped_at": { "type": "string", "format": "date-time", "description": "The timestamp of any last cache event (metadata, asset or thumbnail) done for any NFTs in the requested collection." }, "requested_collection_queued": { "type": "boolean", "description": "Boolean to indicate if the cache request is in the queue or completed (i.e. `false`)." } } }, "description": "List of response items." } } }, "MarketFloorPriceItem": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The timestamp of the date of sale." }, "native_ticker_symbol": { "type": "string", "description": "The ticker symbol for the native currency." }, "native_name": { "type": "string", "description": "The contract name of the native currency." }, "floor_price_native_quote": { "type": "number", "format": "double", "description": "The current floor price in native currency." }, "floor_price_quote": { "type": "number", "format": "double", "description": "The current floor price converted to fiat in `quote-currency`." }, "pretty_floor_price_quote": { "type": "string", "description": "A prettier version of the floor price quote for rendering purposes." } } }, "MarketSaleCountItem": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The timestamp of the date of sale." }, "sale_count": { "type": "integer", "description": "The total amount of sales for the current day." } } }, "MarketVolumeItem": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The timestamp of the date of sale." }, "native_ticker_symbol": { "type": "string", "description": "The ticker symbol for the native currency." }, "native_name": { "type": "string", "description": "The contract name of the native currency." }, "volume_quote": { "type": "number", "format": "double", "description": "The current volume converted to fiat in `quote-currency`." }, "volume_native_quote": { "type": "number", "format": "double", "description": "The current volume in native currency." }, "pretty_volume_quote": { "type": "string", "description": "A prettier version of the volume quote for rendering purposes." } } }, "NftAddressBalanceNftResponse": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam. Supported on all Foundational Chains." }, "last_transfered_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was transferred." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "balance_24h": { "type": "string", "description": "b;The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "type": { "type": "string" }, "floor_price_quote": { "type": "number", "format": "double", "description": "The current floor price converted to fiat in `quote-currency`. The floor price is determined by the last minimum sale price within the last 30 days across all the supported markets where the collection is sold on." }, "pretty_floor_price_quote": { "type": "string", "description": "A prettier version of the floor price quote for rendering purposes." }, "floor_price_native_quote": { "type": "number", "format": "double", "description": "The current floor price in native currency. The floor price is determined by the last minimum sale price within the last 30 days across all the supported markets where the collection is sold on." }, "nft_data": { "type": "array", "items": { "type": "object", "properties": { "token_id": { "type": "string", "description": "b;The token's id." }, "token_url": { "type": "string" }, "original_owner": { "type": "string", "description": "The original minter." }, "current_owner": { "type": "string", "description": "The current holder of this NFT." }, "external_data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "asset_url": { "type": "string" }, "asset_file_extension": { "type": "string" }, "asset_mime_type": { "type": "string" }, "asset_size_bytes": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." } } }, "asset_cached": { "type": "boolean", "description": "If `true`, the asset data is available from the Covalent CDN." }, "image_cached": { "type": "boolean", "description": "If `true`, the image data is available from the Covalent CDN." } } } } } }, "description": "List of response items." } } }, "NftAssetProperties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } } }, "NftAssetThumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } } }, "NftAttribute": { "type": "object", "properties": { "value": { "type": "string" }, "count": { "type": "integer" } } }, "NftCollectionAttribute": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } }, "NftCollectionAttributesForTraitResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "count": { "type": "integer" } } } }, "unique_values": { "type": "integer" } } }, "description": "List of response items." } } }, "NftCollectionTraitSummaryResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Trait name" }, "value_type": { "type": "string", "description": "Type of the value of the trait." }, "value_numeric": { "type": "object", "properties": { "min": { "type": "number", "format": "double" }, "max": { "type": "number", "format": "double" } }, "description": "Populated for `numeric` traits." }, "value_string": { "type": "object", "properties": { "value": { "type": "string", "description": "String value" }, "token_count": { "type": "integer", "description": "Number of distinct tokens that have this trait value." }, "trait_percentage": { "type": "number", "format": "double", "description": "Percentage of tokens in the collection that have this trait." } }, "description": "Populated for `string` traits." }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "count": { "type": "integer" } } } }, "unique_values": { "type": "integer" } } } } } }, "description": "List of response items." } } }, "NftCollectionTraitsResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } } }, "description": "List of response items." } } }, "NftData": { "type": "object", "properties": { "token_id": { "type": "string", "description": "b;The token's id." }, "token_url": { "type": "string" }, "original_owner": { "type": "string", "description": "The original minter." }, "current_owner": { "type": "string", "description": "The current holder of this NFT." }, "external_data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "asset_url": { "type": "string" }, "asset_file_extension": { "type": "string" }, "asset_mime_type": { "type": "string" }, "asset_size_bytes": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." } } }, "asset_cached": { "type": "boolean", "description": "If `true`, the asset data is available from the Covalent CDN." }, "image_cached": { "type": "boolean", "description": "If `true`, the image data is available from the Covalent CDN." } } }, "NftDataV1": { "type": "object", "properties": { "token_id": { "type": "string", "description": "b;The token's id." }, "token_balance": { "type": "string", "description": "b;The NFT's token balance." }, "token_url": { "type": "string" }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "original_owner": { "type": "string", "description": "The original minter." }, "external_data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." }, "owner": { "type": "string" } } }, "owner": { "type": "string" }, "owner_address": { "type": "string", "description": "The owner address." }, "burned": { "type": "boolean" } } }, "NftExternalData": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "asset_url": { "type": "string" }, "asset_file_extension": { "type": "string" }, "asset_mime_type": { "type": "string" }, "asset_size_bytes": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." } } }, "NftExternalDataV1": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." }, "owner": { "type": "string" } } }, "NftMarketFloorPriceResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "address": { "type": "string", "description": "The requested address." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The timestamp of the date of sale." }, "native_ticker_symbol": { "type": "string", "description": "The ticker symbol for the native currency." }, "native_name": { "type": "string", "description": "The contract name of the native currency." }, "floor_price_native_quote": { "type": "number", "format": "double", "description": "The current floor price in native currency." }, "floor_price_quote": { "type": "number", "format": "double", "description": "The current floor price converted to fiat in `quote-currency`." }, "pretty_floor_price_quote": { "type": "string", "description": "A prettier version of the floor price quote for rendering purposes." } } }, "description": "List of response items." } } }, "NftMarketSaleCountResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "address": { "type": "string", "description": "The requested address." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The timestamp of the date of sale." }, "sale_count": { "type": "integer", "description": "The total amount of sales for the current day." } } }, "description": "List of response items." } } }, "NftMarketVolumeResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "address": { "type": "string", "description": "The requested address." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The timestamp of the date of sale." }, "native_ticker_symbol": { "type": "string", "description": "The ticker symbol for the native currency." }, "native_name": { "type": "string", "description": "The contract name of the native currency." }, "volume_quote": { "type": "number", "format": "double", "description": "The current volume converted to fiat in `quote-currency`." }, "volume_native_quote": { "type": "number", "format": "double", "description": "The current volume in native currency." }, "pretty_volume_quote": { "type": "string", "description": "A prettier version of the volume quote for rendering purposes." } } }, "description": "List of response items." } } }, "NftMetadataResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam. Supported on all Foundational Chains." }, "type": { "type": "string" }, "nft_data": { "type": "object", "properties": { "token_id": { "type": "string", "description": "b;The token's id." }, "token_url": { "type": "string" }, "original_owner": { "type": "string", "description": "The original minter." }, "current_owner": { "type": "string", "description": "The current holder of this NFT." }, "external_data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "asset_url": { "type": "string" }, "asset_file_extension": { "type": "string" }, "asset_mime_type": { "type": "string" }, "asset_size_bytes": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." } } }, "asset_cached": { "type": "boolean", "description": "If `true`, the asset data is available from the Covalent CDN." }, "image_cached": { "type": "boolean", "description": "If `true`, the image data is available from the Covalent CDN." } } } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } }, "NftMetadataResponseV1": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "type": { "type": "string" }, "nft_data": { "type": "object", "properties": { "token_id": { "type": "string", "description": "b;The token's id." }, "token_balance": { "type": "string", "description": "b;The NFT's token balance." }, "token_url": { "type": "string" }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "original_owner": { "type": "string", "description": "The original minter." }, "external_data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." }, "owner": { "type": "string" } } }, "owner": { "type": "string" }, "owner_address": { "type": "string", "description": "The owner address." }, "burned": { "type": "boolean" } } } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } }, "NftOwnershipForCollectionItem": { "type": "object", "properties": { "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "token_id": { "type": "string", "description": "b;The token's id." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "last_transfered_at": { "type": "string", "format": "date-time" }, "balance": { "type": "string", "description": "b;Nft balance." }, "balance_24h": { "type": "string" }, "type": { "type": "string" }, "nft_data": { "type": "object", "properties": { "token_id": { "type": "string", "description": "b;The token's id." }, "token_url": { "type": "string" }, "original_owner": { "type": "string", "description": "The original minter." }, "current_owner": { "type": "string", "description": "The current holder of this NFT." }, "external_data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "asset_url": { "type": "string" }, "asset_file_extension": { "type": "string" }, "asset_mime_type": { "type": "string" }, "asset_size_bytes": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." } } }, "asset_cached": { "type": "boolean", "description": "If `true`, the asset data is available from the Covalent CDN." }, "image_cached": { "type": "boolean", "description": "If `true`, the image data is available from the Covalent CDN." } } } } }, "NftOwnershipForCollectionResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "address": { "type": "string", "description": "The requested address." }, "collection": { "type": "string", "description": "The requested collection." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam. Supported on all Foundational Chains." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "token_id": { "type": "string", "description": "b;The token's id." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "last_transfered_at": { "type": "string", "format": "date-time" }, "balance": { "type": "string", "description": "b;Nft balance." }, "balance_24h": { "type": "string" }, "type": { "type": "string" }, "nft_data": { "type": "object", "properties": { "token_id": { "type": "string", "description": "b;The token's id." }, "token_url": { "type": "string" }, "original_owner": { "type": "string", "description": "The original minter." }, "current_owner": { "type": "string", "description": "The current holder of this NFT." }, "external_data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "asset_url": { "type": "string" }, "asset_file_extension": { "type": "string" }, "asset_mime_type": { "type": "string" }, "asset_size_bytes": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." } } }, "asset_cached": { "type": "boolean", "description": "If `true`, the asset data is available from the Covalent CDN." }, "image_cached": { "type": "boolean", "description": "If `true`, the image data is available from the Covalent CDN." } } } } }, "description": "List of response items." } } }, "NftSummaryAttribute": { "type": "object", "properties": { "trait_type": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "count": { "type": "integer" } } } }, "unique_values": { "type": "integer" } } }, "NftTokenContract": { "type": "object", "properties": { "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam. Supported on all Foundational Chains." }, "type": { "type": "string" }, "nft_data": { "type": "object", "properties": { "token_id": { "type": "string", "description": "b;The token's id." }, "token_url": { "type": "string" }, "original_owner": { "type": "string", "description": "The original minter." }, "current_owner": { "type": "string", "description": "The current holder of this NFT." }, "external_data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "asset_url": { "type": "string" }, "asset_file_extension": { "type": "string" }, "asset_mime_type": { "type": "string" }, "asset_size_bytes": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." } } }, "asset_cached": { "type": "boolean", "description": "If `true`, the asset data is available from the Covalent CDN." }, "image_cached": { "type": "boolean", "description": "If `true`, the image data is available from the Covalent CDN." } } } } }, "NftTokenContractBalanceItem": { "type": "object", "properties": { "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam. Supported on all Foundational Chains." }, "last_transfered_at": { "type": "string", "format": "date-time", "description": "The timestamp when the token was transferred." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "balance": { "type": "string", "description": "b;The asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "balance_24h": { "type": "string", "description": "b;The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes." }, "type": { "type": "string" }, "floor_price_quote": { "type": "number", "format": "double", "description": "The current floor price converted to fiat in `quote-currency`. The floor price is determined by the last minimum sale price within the last 30 days across all the supported markets where the collection is sold on." }, "pretty_floor_price_quote": { "type": "string", "description": "A prettier version of the floor price quote for rendering purposes." }, "floor_price_native_quote": { "type": "number", "format": "double", "description": "The current floor price in native currency. The floor price is determined by the last minimum sale price within the last 30 days across all the supported markets where the collection is sold on." }, "nft_data": { "type": "array", "items": { "type": "object", "properties": { "token_id": { "type": "string", "description": "b;The token's id." }, "token_url": { "type": "string" }, "original_owner": { "type": "string", "description": "The original minter." }, "current_owner": { "type": "string", "description": "The current holder of this NFT." }, "external_data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "asset_url": { "type": "string" }, "asset_file_extension": { "type": "string" }, "asset_mime_type": { "type": "string" }, "asset_size_bytes": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." } } }, "asset_cached": { "type": "boolean", "description": "If `true`, the asset data is available from the Covalent CDN." }, "image_cached": { "type": "boolean", "description": "If `true`, the image data is available from the Covalent CDN." } } } } } }, "NftTokenContractV1": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "type": { "type": "string" }, "nft_data": { "type": "object", "properties": { "token_id": { "type": "string", "description": "b;The token's id." }, "token_balance": { "type": "string", "description": "b;The NFT's token balance." }, "token_url": { "type": "string" }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "original_owner": { "type": "string", "description": "The original minter." }, "external_data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "image_256": { "type": "string" }, "image_512": { "type": "string" }, "image_1024": { "type": "string" }, "animation_url": { "type": "string" }, "external_url": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } }, "thumbnails": { "type": "object", "properties": { "image_256": { "type": "string", "description": "Resized 256x256 image of the asset." }, "image_512": { "type": "string", "description": "Resized 512x512 image of the asset." }, "image_1024": { "type": "string", "description": "Resized 1024x1024 image of the asset." }, "image_opengraph_url": { "type": "string", "description": "Resized image of the asset for OpenGraph." }, "thumbhash": { "type": "string", "description": "Base64 encoded hash of the thumbnail." } }, "description": "Various thumbnails of the asset." }, "image_preview": { "type": "string", "description": "The image preview URL." }, "asset_properties": { "type": "object", "properties": { "asset_width": { "type": "integer", "description": "The width of the asset." }, "asset_height": { "type": "integer", "description": "The height of the asset." }, "dominant_color": { "type": "string", "description": "The dominant color of the asset." } }, "description": "The asset properties." }, "owner": { "type": "string" } } }, "owner": { "type": "string" }, "owner_address": { "type": "string", "description": "The owner address." }, "burned": { "type": "boolean" } } } } }, "NftTrait": { "type": "object", "properties": { "name": { "type": "string" } } }, "NftTraitNumeric": { "type": "object", "properties": { "min": { "type": "number", "format": "double" }, "max": { "type": "number", "format": "double" } } }, "NftTraitString": { "type": "object", "properties": { "value": { "type": "string", "description": "String value" }, "token_count": { "type": "integer", "description": "Number of distinct tokens that have this trait value." }, "trait_percentage": { "type": "number", "format": "double", "description": "Percentage of tokens in the collection that have this trait." } } }, "NftTraitSummary": { "type": "object", "properties": { "name": { "type": "string", "description": "Trait name" }, "value_type": { "type": "string", "description": "Type of the value of the trait." }, "value_numeric": { "type": "object", "properties": { "min": { "type": "number", "format": "double" }, "max": { "type": "number", "format": "double" } }, "description": "Populated for `numeric` traits." }, "value_string": { "type": "object", "properties": { "value": { "type": "string", "description": "String value" }, "token_count": { "type": "integer", "description": "Number of distinct tokens that have this trait value." }, "trait_percentage": { "type": "number", "format": "double", "description": "Percentage of tokens in the collection that have this trait." } }, "description": "Populated for `string` traits." }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "count": { "type": "integer" } } } }, "unique_values": { "type": "integer" } } } } } }, "NftTransaction": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "nft_transactions": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Whether or not transaction is successful." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (gas_price * gas_spent) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double" }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." } } } }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam. Supported on all Foundational Chains." } } }, "NftTransactionsResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "logo_url": { "type": "string", "description": "The contract logo URL." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "nft_transactions": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Whether or not transaction is successful." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (gas_price * gas_spent) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double" }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." } } } }, "is_spam": { "type": "boolean", "description": "Denotes whether the token is suspected spam. Supported on all Foundational Chains." } } }, "description": "List of response items." } } }, "PoolSpotPricesResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated." }, "pool_address": { "type": "string", "description": "The deployed pool contract address." }, "token_0_address": { "type": "string", "description": "The deployed contract address of `token_0` in the token pair making up the pool." }, "token_0_name": { "type": "string", "description": "The deployed contract name of `token_0` in the token pair making up the pool." }, "token_0_ticker": { "type": "string", "description": "The deployed contract symbol of `token_0` in the token pair making up the pool." }, "token_0_price": { "type": "string", "description": "Price of `token_0` in units of `token_1`." }, "token_0_price_24h": { "type": "string", "description": "Price of `token_0` in units of `token_1` as of 24 hours ago." }, "token_0_price_quote": { "type": "string", "description": "Price of `token_0` in the selected quote currency (defaults to USD)." }, "token_0_price_24h_quote": { "type": "string", "description": "Price of `token_0` in the selected quote currency (defaults to USD) as of 24 hours ago." }, "token_1_address": { "type": "string", "description": "The deployed contract address of `token_1` in the token pair making up the pool." }, "token_1_name": { "type": "string", "description": "The deployed contract name of `token_1` in the token pair making up the pool." }, "token_1_ticker": { "type": "string", "description": "The deployed contract symbol of `token_1` in the token pair making up the pool." }, "token_1_price": { "type": "string", "description": "Price of `token_1` in units of `token_0`." }, "token_1_price_24h": { "type": "string", "description": "Price of `token_1` in units of `token_0` as of 24 hours ago." }, "token_1_price_quote": { "type": "string", "description": "Price of `token_1` in the selected quote currency (defaults to USD)." }, "token_1_price_24h_quote": { "type": "string", "description": "Price of `token_1` in the selected quote currency (defaults to USD) as of 24 hours ago." }, "quote_currency": { "type": "string", "description": "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, `GBP`, `BTC` and `ETH`." } } }, "Price": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date of the price capture." }, "price": { "type": "number", "format": "double", "description": "The price in the requested `quote-currency`." }, "pretty_price": { "type": "string", "description": "A prettier version of the price for rendering purposes." } } }, "TokenPricesResponse": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "update_at": { "type": "string", "format": "date-time" }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "logo_urls": { "type": "object", "properties": { "token_logo_url": { "type": "string", "description": "The token logo URL." }, "protocol_logo_url": { "type": "string", "description": "The protocol logo URL." }, "chain_logo_url": { "type": "string", "description": "The chain logo URL." } }, "description": "The contract logo URLs." }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date of the price capture." }, "price": { "type": "number", "format": "double", "description": "The price in the requested `quote-currency`." }, "pretty_price": { "type": "string", "description": "A prettier version of the price for rendering purposes." } } }, "description": "List of response items." } } }, "BtcTransactionItem": { "type": "object", "properties": { "chain_id": { "type": "integer", "description": "The requested chain ID eg: `20090103`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `btc-mainnet`." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_idx": { "type": "integer", "description": "The position index of the tx in the block." }, "type": { "type": "string", "description": "Either 'input' as the sender or 'output' as the receiver of btc." }, "address": { "type": "string", "description": "The wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx in satoshi." }, "quote": { "type": "number", "format": "double", "description": "The value attached to this tx in USD." }, "quote_rate": { "type": "number", "format": "double", "description": "The value token exchange rate in USD." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees denoted in satoshi." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in USD." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas token exchange rate in USD." }, "coinbase": { "type": "boolean", "description": "Indicates if this is a coinbase tx where btc is rewarded to a miner for validating the block." }, "locktime": { "type": "integer", "description": "The earliest Unix timestamp or block height at which the tx is valid and can be included. Is `0` if no restriction." }, "weight": { "type": "integer", "description": "A measure that reflects impact on the block size limit. Used to determine fees." } } }, "BtcTransactionsResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "items": { "type": "array", "items": { "type": "object", "properties": { "chain_id": { "type": "integer", "description": "The requested chain ID eg: `20090103`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `btc-mainnet`." }, "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_idx": { "type": "integer", "description": "The position index of the tx in the block." }, "type": { "type": "string", "description": "Either 'input' as the sender or 'output' as the receiver of btc." }, "address": { "type": "string", "description": "The wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx in satoshi." }, "quote": { "type": "number", "format": "double", "description": "The value attached to this tx in USD." }, "quote_rate": { "type": "number", "format": "double", "description": "The value token exchange rate in USD." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees denoted in satoshi." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in USD." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas token exchange rate in USD." }, "coinbase": { "type": "boolean", "description": "Indicates if this is a coinbase tx where btc is rewarded to a miner for validating the block." }, "locktime": { "type": "integer", "description": "The earliest Unix timestamp or block height at which the tx is valid and can be included. Is `0` if no restriction." }, "weight": { "type": "integer", "description": "A measure that reflects impact on the block size limit. Used to determine fees." } } }, "description": "List of response items." }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if there is another page." }, "page_number": { "type": "integer", "description": "The requested page number." }, "page_size": { "type": "integer", "description": "The requested number of items on the current page." }, "total_count": { "type": "integer", "description": "The total number of items across all pages for this request." } }, "description": "Pagination metadata." } } }, "GasSummary": { "type": "object", "properties": { "total_sent_count": { "type": "integer", "format": "int64", "description": "The total number of transactions sent by the address." }, "total_fees_paid": { "type": "string", "description": "b;The total transaction fees paid by the address, denoted in wei." }, "total_gas_quote": { "type": "number", "format": "double", "description": "The total transaction fees paid by the address, denoted in `quote-currency`." }, "pretty_total_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "average_gas_quote_per_tx": { "type": "number", "format": "double", "description": "The average gas quote per transaction." }, "pretty_average_gas_quote_per_tx": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." } } }, "InputData": { "type": "object", "properties": { "method_id": { "type": "string", "description": "The first 4 bytes of the invoked smart contract function signature. Used to identify the function being called in the contract." } } }, "InternalTransfer": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "NftTransactionItem": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Whether or not transaction is successful." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (gas_price * gas_spent) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double" }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." } } }, "RecentTransactionsResponse": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "current_page": { "type": "integer", "description": "The current page of the response." }, "links": { "type": "object", "properties": { "prev": { "type": "string", "description": "URL link to the next page." }, "next": { "type": "string", "description": "URL link to the previous page." } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "description": "List of response items." } } }, "StateChange": { "type": "object", "properties": { "address": { "type": "string" }, "balance_before": { "type": "string", "description": "b;The balance of the native token before the transaction in wei." }, "balance_after": { "type": "string", "description": "b;The balance of the native token after the transaction in wei." }, "storage_changes": { "type": "array", "items": { "type": "object", "properties": { "storage_address": { "type": "string", "description": "The specific storage slot in the contract's storage space." }, "value_before": { "type": "string", "description": "The hex value stored in the slot before the transaction." }, "value_after": { "type": "string", "description": "The hex value stored in the slot after the transaction." } } }, "description": "List of before and after values in the storage address." }, "nonce_before": { "type": "integer", "description": "The transaction count for this address before the transaction." }, "nonce_after": { "type": "integer", "description": "The transaction count for this address after the transaction." } } }, "StorageChange": { "type": "object", "properties": { "storage_address": { "type": "string", "description": "The specific storage slot in the contract's storage space." }, "value_before": { "type": "string", "description": "The hex value stored in the slot before the transaction." }, "value_after": { "type": "string", "description": "The hex value stored in the slot after the transaction." } } }, "Transaction": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "TransactionResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "description": "List of response items." } } }, "TransactionSummary": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_detail_link": { "type": "string", "description": "The link to the transaction details using the Covalent API." } } }, "TransactionV2": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "TransactionsBlockPageResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "links": { "type": "object", "properties": { "prev": { "type": "string", "description": "URL link to the next page." }, "next": { "type": "string", "description": "URL link to the previous page." } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "description": "List of response items." } } }, "TransactionsBlockResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "description": "List of response items." } } }, "TransactionsResponse": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "current_page": { "type": "integer", "description": "The current page of the response." }, "links": { "type": "object", "properties": { "prev": { "type": "string", "description": "URL link to the next page." }, "next": { "type": "string", "description": "URL link to the previous page." } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "description": "List of response items." } } }, "TransactionsSummary": { "type": "object", "properties": { "total_count": { "type": "integer", "format": "int64", "description": "The total number of transactions." }, "transfer_count": { "type": "integer", "format": "int64", "description": "Represents the total count of ERC-20 token movement events, including `Transfer`, `Deposit` and `Withdraw`." }, "earliest_transaction": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_detail_link": { "type": "string", "description": "The link to the transaction details using the Covalent API." } }, "description": "The earliest transaction detected." }, "latest_transaction": { "type": "object", "properties": {}, "description": "The latest transaction detected." }, "gas_summary": { "type": "object", "properties": { "total_sent_count": { "type": "integer", "format": "int64", "description": "The total number of transactions sent by the address." }, "total_fees_paid": { "type": "string", "description": "b;The total transaction fees paid by the address, denoted in wei." }, "total_gas_quote": { "type": "number", "format": "double", "description": "The total transaction fees paid by the address, denoted in `quote-currency`." }, "pretty_total_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "average_gas_quote_per_tx": { "type": "number", "format": "double", "description": "The average gas quote per transaction." }, "pretty_average_gas_quote_per_tx": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." } }, "description": "The gas summary for the transactions." } } }, "TransactionsSummaryResponse": { "type": "object", "properties": { "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "address": { "type": "string", "description": "The requested address." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "total_count": { "type": "integer", "format": "int64", "description": "The total number of transactions." }, "transfer_count": { "type": "integer", "format": "int64", "description": "Represents the total count of ERC-20 token movement events, including `Transfer`, `Deposit` and `Withdraw`." }, "earliest_transaction": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_detail_link": { "type": "string", "description": "The link to the transaction details using the Covalent API." } }, "description": "The earliest transaction detected." }, "latest_transaction": { "type": "object", "properties": {}, "description": "The latest transaction detected." }, "gas_summary": { "type": "object", "properties": { "total_sent_count": { "type": "integer", "format": "int64", "description": "The total number of transactions sent by the address." }, "total_fees_paid": { "type": "string", "description": "b;The total transaction fees paid by the address, denoted in wei." }, "total_gas_quote": { "type": "number", "format": "double", "description": "The total transaction fees paid by the address, denoted in `quote-currency`." }, "pretty_total_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "average_gas_quote_per_tx": { "type": "number", "format": "double", "description": "The average gas quote per transaction." }, "pretty_average_gas_quote_per_tx": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." } }, "description": "The gas summary for the transactions." } } }, "description": "List of response items." } } }, "TransactionsTimeBucketResponse": { "type": "object", "properties": { "address": { "type": "string", "description": "The requested address." }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the response was generated. Useful to show data staleness to users." }, "quote_currency": { "type": "string", "description": "The requested quote currency eg: `USD`." }, "chain_id": { "type": "integer", "description": "The requested chain ID eg: `1`." }, "chain_name": { "type": "string", "description": "The requested chain name eg: `eth-mainnet`." }, "chain_tip_height": { "type": "integer", "description": "The latest block height of the blockchain at the time this response was provided." }, "chain_tip_signed_at": { "type": "string", "format": "date-time", "description": "The timestamp of the latest signed block at the time this response was provided." }, "complete": { "type": "boolean" }, "current_bucket": { "type": "integer", "description": "The current bucket of the response." }, "links": { "type": "object", "properties": { "prev": { "type": "string", "description": "URL link to the next page." }, "next": { "type": "string", "description": "URL link to the previous page." } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "description": "The height of the block." }, "block_hash": { "type": "string", "description": "The hash of the block. Use it to remove transactions from re-org-ed blocks." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "tx_offset": { "type": "integer", "description": "The offset is the position of the tx in the block." }, "successful": { "type": "boolean", "description": "Indicates whether a transaction failed or succeeded." }, "from_address": { "type": "string", "description": "The sender's wallet address." }, "miner_address": { "type": "string", "description": "The address of the miner." }, "to_address": { "type": "string", "description": "The receiver's wallet address." }, "value": { "type": "string", "description": "b;The value attached to this tx." }, "value_quote": { "type": "number", "format": "double", "description": "The value attached in `quote-currency` to this tx." }, "pretty_value_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_metadata": { "type": "object", "properties": { "contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "contract_name": { "type": "string", "description": "The string returned by the `name()` method." }, "contract_ticker_symbol": { "type": "string", "description": "The ticker symbol for this contract. This field is set by a developer and non-unique across a network." }, "contract_address": { "type": "string", "description": "Use the relevant `contract_address` to lookup prices, logos, token transfers, etc." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "logo_url": { "type": "string", "description": "The contract logo URL." } }, "description": "The requested chain native gas token metadata." }, "gas_offered": { "type": "integer", "format": "int64" }, "gas_spent": { "type": "integer", "format": "int64", "description": "The gas spent for this tx." }, "gas_price": { "type": "integer", "format": "int64", "description": "The gas price at the time of this tx." }, "fees_paid": { "type": "string", "description": "b;The total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei." }, "gas_quote": { "type": "number", "format": "double", "description": "The gas spent in `quote-currency` denomination." }, "pretty_gas_quote": { "type": "string", "description": "A prettier version of the quote for rendering purposes." }, "gas_quote_rate": { "type": "number", "format": "double", "description": "The native gas exchange rate for the requested `quote-currency`." }, "explorers": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the explorer." }, "url": { "type": "string", "description": "The URL of the explorer." } } }, "description": "The explorer links for this transaction." }, "log_events": { "type": "array", "items": { "type": "object", "properties": { "block_signed_at": { "type": "string", "format": "date-time", "description": "The block signed timestamp in UTC." }, "block_height": { "type": "integer", "format": "int64", "description": "The height of the block." }, "tx_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the tx in the block." }, "log_offset": { "type": "integer", "format": "int64", "description": "The offset is the position of the log entry within an event log." }, "tx_hash": { "type": "string", "description": "The requested transaction hash." }, "raw_log_topics": { "type": "array", "items": { "type": "string" }, "description": "The log topics in raw data." }, "sender_contract_decimals": { "type": "integer", "description": "Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`." }, "sender_name": { "type": "string", "description": "The name of the sender." }, "sender_contract_ticker_symbol": { "type": "string" }, "sender_address": { "type": "string", "description": "The address of the sender." }, "sender_logo_url": { "type": "string", "description": "The contract logo URL." }, "supports_erc": { "type": "array", "items": { "type": "string" }, "description": "A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`." }, "sender_factory_address": { "type": "string", "description": "The address of the deployed UniswapV2 like factory contract for this DEX." }, "raw_log_data": { "type": "string", "description": "The log events in raw." }, "decoded": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "indexed": { "type": "boolean" }, "decoded": { "type": "boolean" }, "value": { "type": "string" } } } } }, "description": "The decoded item." } } }, "description": "The log events." }, "internal_transfers": { "type": "array", "items": { "type": "object", "properties": { "from_address": { "type": "string", "description": "The contract address sending the native token." }, "to_address": { "type": "string", "description": "The internal transfer recipient wallet address." }, "value": { "type": "string", "description": "b;The value of the internal transfer in wei." }, "gas_limit": { "type": "integer", "format": "int64", "description": "The gas available from the parent transaction or contract call." } } }, "description": "List of internal transfers/transactions associated with the wallet address." } } }, "description": "List of response items." } } } } } }