20 credits per API call
\n\nGet the single best swap rate across all supported protocols.\nCompares all protocols and returns the one with the best price:\nsell orders — highest buyAmount, buy orders — lowest sellAmount.\nUse this when you just want the best deal without thinking about protocols.\nFor comparing all options, use GET /swaps/quotes instead.\n\n**Quotes are cached for up to 15 seconds** (less than one Ethereum block).\nEach response includes an `expiresAt` field (Unix timestamp) indicating\nwhen the underlying quote was originally fetched from the protocol.\nAlways check `expiresAt` against the current time before displaying or\nacting on a quote — if less than ~10 seconds remain, re-query to get a\nfresh price.","tags":["DeFi API"],"parameters":[{"name":"sellToken","in":"query","schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"required":true,"description":"ERC-20 token contract address to sell."},{"name":"buyToken","in":"query","schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"required":true,"description":"ERC-20 token contract address to buy."},{"name":"amount","in":"query","schema":{"type":"string","pattern":"^[0-9]+$"},"required":true,"description":"Fixed-side amount in base units.\nsell order: exact amount of sellToken to spend.\nbuy order: exact amount of buyToken to receive."},{"name":"fromAddress","in":"query","schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"required":true,"description":"Wallet address initiating the swap. Used for CoW fee estimation."},{"name":"chain","in":"query","schema":{"type":"string","enum":["ethereum-mainnet","ethereum-sepolia","bsc-mainnet","gnosis-mainnet","polygon-mainnet","base-mainnet","plasma-mainnet","arbitrum-one-mainnet","avalanche-mainnet"]},"required":true,"description":"Tatum network slug (e.g. `ethereum-mainnet`, `bsc-mainnet`,\n`polygon-mainnet`). Matches the `networks[].id` field in\nhttps://blockchains.tatum.io/blockchains2.json."},{"name":"kind","in":"query","schema":{"type":"string","enum":["sell","buy"]},"required":false,"description":"Whether this is exact-input (sell) or exact-output (buy)."},{"name":"slippageBps","in":"query","schema":{"type":"number","minimum":0,"maximum":10000},"required":false,"description":"Slippage tolerance in basis points (1 bps = 0.01%).\nApplied to the quoted amount to compute limitAmount."}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BestQuoteResult"}}}},"400":{"description":"Bad request — invalid or missing query parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}},"401":{"description":"Missing or invalid Tatum API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}},"402":{"description":"Insufficient credits or expired account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}},"403":{"description":"API key blocked or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}},"5XX":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}}},"security":[{"X-API-Key":[]}],"operationId":"GetV4DataDefiSwapsQuote"}},"/v4/data/defi/swaps/quotes":{"get":{"summary":"Get multi-protocol rates","description":"\n20 credits per API call
\n\nCompare swap rates across all supported protocols.\nResults are sorted by best price: highest buyAmount for sell orders,\nlowest sellAmount for buy orders.\n\n**Quotes are cached for up to 15 seconds** (less than one Ethereum block).\nEach result includes an `expiresAt` field (Unix timestamp) indicating\nwhen the underlying quote was originally fetched from the protocol.\nAlways check `expiresAt` against the current time before displaying or\nacting on a quote — if less than ~10 seconds remain, re-query to get a\nfresh price.","tags":["DeFi API"],"parameters":[{"name":"sellToken","in":"query","schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"required":true,"description":"ERC-20 token contract address to sell."},{"name":"buyToken","in":"query","schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"required":true,"description":"ERC-20 token contract address to buy."},{"name":"amount","in":"query","schema":{"type":"string","pattern":"^[0-9]+$"},"required":true,"description":"Fixed-side amount in base units.\nsell order (kind='sell'): exact amount of sellToken to spend.\nbuy order (kind='buy'): exact amount of buyToken to receive."},{"name":"fromAddress","in":"query","schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"required":true,"description":"Wallet address initiating the swap. Used for CoW fee estimation and quote context."},{"name":"chain","in":"query","schema":{"type":"string","enum":["ethereum-mainnet","ethereum-sepolia","bsc-mainnet","gnosis-mainnet","polygon-mainnet","base-mainnet","plasma-mainnet","arbitrum-one-mainnet","avalanche-mainnet"]},"required":true,"description":"Tatum network slug (e.g. `ethereum-mainnet`, `bsc-mainnet`,\n`polygon-mainnet`). Matches the `networks[].id` field in\nhttps://blockchains.tatum.io/blockchains2.json."},{"name":"kind","in":"query","schema":{"type":"string","enum":["sell","buy"]},"required":false,"description":"Whether this is exact-input (sell) or exact-output (buy)."},{"name":"slippageBps","in":"query","schema":{"type":"number","minimum":0,"maximum":10000},"required":false,"description":"Slippage tolerance in basis points (1 bps = 0.01%).\nApplied to the quoted amount to compute limitAmount."},{"name":"mevFilter","in":"query","schema":{"type":"string","enum":["protected","unprotected"]},"required":false,"description":"Filter quotes by MEV protection status.\n\nprotected — only MEV-safe protocols (CoW Protocol).\nunprotected — only non-MEV protocols (Uniswap, PancakeSwap).\nomitted — all protocols, no filter."}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SwapRate"}}}}},"400":{"description":"Bad request — invalid or missing query parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}},"401":{"description":"Missing or invalid Tatum API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}},"402":{"description":"Insufficient credits or expired account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}},"403":{"description":"API key blocked or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}},"5XX":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}}},"security":[{"X-API-Key":[]}],"operationId":"GetV4DataDefiSwapsQuotes"}},"/v4/data/collections":{"get":{"description":"\n20 credits per API call
\n\n> 📘 **Note for v3 API users:**\n>\n> As part of our documentation consolidation, we removed the dedicated page for GET /v3/data/collections. Users can refer to GET /v4/data/collections for the latest documentation, as both endpoints function the same—simply replace v4 with v3 in the API URL if using the v3 version.\n\nGet all NFTs (ERC-721 and ERC-1155) and multitokens (ERC-1155 only) of your favorite collections! Our API lets you search for all tokens on:
\nTo get started:
\nexcludeMetadata to true).tokenType.excludeMetadata and tokenType won't have any effect on filtering data.10 credits per API call
\n\n> 📘 **Note for v3 API users:** \n>\n> As part of our documentation consolidation, we removed the dedicated page for GET /v3/data/metadata. Users can refer to GET /v4/data/metadata for the latest documentation, as both endpoints function the same—simply replace v4 with v3 in the API URL if using the v3 version.\n\nGet metadata of NFTs (ERC-721 and ERC-1155) or multitokens (ERC-1155 only) by IDs for a given token address! Our API lets you search for all tokens on:
\nTo get started:
\n50 credits per API call
\nGet portfolio balances of native, fungible tokens (ERC-20) or NFTs (ERC-721 and ERC-1155) for a specific wallet address on the following blockchains:
\nTo get started:
\nexcludeMetadata to true).tokenTypes parameter to indicate which types of tokens to fetch balances for. Supported values include [native], [fungible] and [nft,multitoken].excludeMetadata.100 credits per API call
\nGet native balances for a specific wallet addresses by time on the following blockchains:
\nTo get started, provide a chain name, comma-separated list of addresses and specify one of the filters listed below (combination of the filters is not allowed):
\nIf you pass a block number that is in the future (beyond the current latest block), the system will return the balance for the latest block.
\nIf you pass a time or Unix timestamp that is in the future, the system will also return the balance for the latest block.
\nIf you pass a time or Unix timestamp in the past (dating back to or earlier than the blockchain's genesis block), the system will return the balance for the first block (genesis block).
\n","operationId":"GetWalletBalanceByTimeV4","parameters":[{"description":"The blockchain to work with.","in":"query","name":"chain","required":true,"schema":{"$ref":"#/components/schemas/ChainEnumForBalanceByTime"}},{"description":"The blockchain public wallet addresses.\nIt is possible to enter list of up to 10 addresses as a comma separated string.\n","in":"query","name":"addresses","required":true,"schema":{"type":"string","description":"Wallet address","example":"0x80d8bac9a6901698b3749fe336bbd1385c1f98f2,0xAe680Ed83baF08a8028118Bd19859F8a0E744cc6"}},{"description":"Block number. You must either use \"blockNumber\" or \"time\" or \"unix\" params in your requests.","in":"query","name":"blockNumber","schema":{"$ref":"#/components/schemas/BlockNumber"}},{"description":"Time when block is processed. You must either use \"blockNumber\" or \"time\" or \"unix\" params in your requests.","in":"query","name":"time","schema":{"type":"string","example":"2022-12-24T00:20"}},{"description":"Unix timestamp when block is processed. You must either use \"blockNumber\" or \"time\" or \"unix\" params in your requests.","in":"query","name":"unix","schema":{"type":"number","example":1587390414}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/NativeTokenBalance"},"description":"List of all balances for all selected tokens.","example":[{"chain":"ethereum-mainnet","address":"0xae680ed83baf08a8028118bd19859f8a0e744cc6","balance":"2.881012674896012762","denominatedBalance":"2881012674896012762","decimals":18,"type":"native"}]},"prevPage":{"type":"string","description":"Cursor pagination, used to get previous page of results (work in progress, not used right now).","example":""},"nextPage":{"type":"string","description":"Cursor pagination, used to get next page of results (work in progress, not used right now).","example":""}}}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get balances by time of addresses","tags":["Wallet API"]}},"/v4/data/wallet/reputation":{"get":{"description":"\n5000 credits per API call per address
\n\nReturns reputation scores for one or more wallets using on-chain behavioral analysis across their token portfolio.
\nSupported blockchains:
\n10000 credits per API call per address
\n\n> 📘 Note for Free Users\n>\n> 1000 credits per API call per address\n>\n> As a free user, your data is cached on a 1-day refresh cycle, and wallet queries run through tatumio.eth. This setup helps lower costs so you can easily try out the API. For real-time data, faster syncs, and the full capability of our platform, we recommend upgrading to a paid plan.\n\nReturns composite reputation scores along with per-token scores for all tokens held in each wallet.
\nSupported blockchains:
\n1500 credits per API call per address
\n\nReturns reputation scores for a wallet across one or more specific tokens.
\nSupported blockchains:
\n20 credits per API call
\nResolve a human-readable blockchain domain name into its corresponding wallet address for supported blockchains:
\nTo get started:
\n50 credits per API call
\n\n> 📘 **Note for v3 API users:** \n>\n> As part of our documentation consolidation, we removed the dedicated page for GET /v3/data/owners. Users can refer to GET /v4/data/owners for the latest documentation, as both endpoints function the same—simply replace v4 with v3 in the API URL if using the v3 version.\n\nGet all addresses that own your favorite token (ERC-20, ERC-721 or ERC-1155)! Our API lets you search for all token owners on:
\nTo get started:
\ntokenId. In case of multitoken, result is an array of addresses.50 credit per API call
\n\n> 📘 **Note for v3 API users:** \n>\n> As part of our documentation consolidation, we removed the dedicated page for GET /v3/data/owners/address. Users can refer to GET /v4/data/owners/address for the latest documentation, as both endpoints function the same—simply replace v4 with v3 in the API URL if using the v3 version.\n\nCheck if wallet address owns any specified token (ERC-20, ERC-721 or ERC-1155) on the following blockchains:
\nTo get started:
\ntrue if provided wallet address owns them.false and status code is 200.tokenId./v4/data/nft/balances
\n50 credits per API call
\nGet all NFTs that a blockchain address holds. The NFTs are returned grouped by the smart contracts they were minted on.
\nThis API is supported for the following blockchains:
\nOn Solana and Algorand, if a blockchain address holds fewer than 50 NFTs, the API also returns each NFT's metadata. If the metadata is not returned, you can obtain it using the API for getting NFT metadata.
\n","operationId":"GetNftBalancesV4","parameters":[{"description":"The blockchain to work with.","in":"query","name":"chain","required":true,"schema":{"$ref":"#/components/schemas/ChainEnumForNftBalances"}},{"description":"The blockchain address that you want to get the token balance of","in":"query","name":"address","required":true,"schema":{"type":"string","example":"0x2474a7227877f2b65185f09468af7c6577fa207c"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NftBalanceByAddressErc721"}}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get NFT balance of a wallet address","tags":["NFT API"]}},"/v4/data/multitoken/balances":{"get":{"description":"/v4/data/multitoken/balances
\n50 credits per API call
\nGet Multi Token balances of a wallet address. The Multi Tokens are returned grouped by the smart contracts they were minted on.
\nThis API is supported for the following blockchains:
\n20 credits per API call
\n\nGet transaction history on the following blockchains:
\nTo get started:
\ntransactionTypes and even transactionSubtype (incoming, outgoing, zero-transfer).addresses query parameter. Following query parameters won't have any effect on filtering data: transactionTypes, transactionSubtype, tokenId, blockTo.pageSize and offset query parameters. \ncursor query parameter, by filling in the value from prevPage or nextPage field in the response body.10 credits per API call
\n\n> 📘 **Note for v3 API users:** \n>\n> As part of our documentation consolidation, we deprecated the endpoint for GET /v3/data/transactions/hash. Users can refer to GET /v4/data/transactions/hash for the latest documentation, as both endpoints function the same.\n\nGet transactions by hash on the following blockchains:
\nTo get started:
\n50 credits per API call
\n\nGet all events on given addresses and / or in the requested block range on the following blockchains:
\nTo get started:
\nAs noted above, aside from general info and hashed event data, the API also decodes them for you in case you filter by one of the following supported event types:
\ntokenTransfer: All transfers of fungible tokens (including stablecoins) and NFTs as per ERC-20 and ERC-721 standard.multitokenTransfer: All transfers of multitokens (both single transfers and batch transfers) as per ERC-1155 standard.stablecoinTransfer: Refers to the transfer of specific stablecoins on the mainnet. Typically, the top 10 to 16 stablecoins on each chain according to CoinMarketCap are included. If the contractAddresses parameter is also used in the filter combination, any tokens specified in it will also be included in the list.uniswapTrade: Provides all swap events that occur on both Uniswap V2 and V3. In some cases, it may not be possible to map the swapped amounts to specific tokens. As a result, certain decoded data such as token amounts might be missing or in the original big number format. This will be indicated by the response parameter partiallyRaw: true.10 credits per API call
\n\nGet information about blocks (when they were added, block hashes and list of transaction hashes that were processed within them) on the following blockchains:
\nTo get started, provide a chain and specify one of the filters listed below (combination of these filters is not allowed):
\n10 credit per API call
\n\nGet information about latest added block on the following blockchains:
\nTo get started, you can just provide a chain.
\n","operationId":"GetLatestDefiBlockV4","parameters":[{"description":"The blockchain to work with.","in":"query","name":"chain","required":true,"schema":{"$ref":"#/components/schemas/ChainEnumForBlocksAndEvents"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefiBlockItem","description":"Latest block added to a blockchain.","example":{"blockNumber":25987956,"blockTimestamp":1677372871000,"hash":"0x047a6ab09f86c760c145dc09b7a43b74d6ad957133ba4462a5530c642d4d9f17","txHashes":["0x01a7983d1391b74305840e4960ba6c61417a9398cb938c3522d0a4a9cedf488f","0x0478fdae7e5e6f1eb522e6f43ba760c924b1f72d16e4dadc332f150829d09cbe","0x05d00f08ae523e445c3b1e7bbabec1896091234643d50e8bcdb76ddd3ff3827a","0x0b644c19257cf34ab98c509c7901af5a4ad8c6f537b625b46ee771a45f1940dc","0x0c1016bf317946d9997588ee3b932bc8ba6033cfcb83eca4b5ebcc4f5eaa076d"]}}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get latest block","tags":["DeFi API"]}},"/v4/data/block/time":{"get":{"description":"\n20 credits per API call
\nGet block number by time on the following blockchains:
\nTo get started, provide a chain name and specify one of the filters listed below (combination of the filters is not allowed):
\nIf you pass a time or Unix timestamp that is in the future, the system will return the number for the latest block.
\nIf you pass a time or Unix timestamp in the past (dating back to or earlier than the blockchain's genesis block), the system will return 0.
\n","operationId":"GetBlockByTimeV4","parameters":[{"description":"The blockchain to work with.","in":"query","name":"chain","required":true,"schema":{"$ref":"#/components/schemas/ChainEnumForBlockByTime"}},{"description":"Time when block is processed.","in":"query","name":"time","schema":{"type":"string","example":"2022-12-24T00:20"}},{"description":"Unix timestamp when block is processed.","in":"query","name":"unix","schema":{"type":"number","example":1587390414}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"number","example":22838895}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get block by time","tags":["DeFi API"]}},"/v4/data/blockchains/block/current":{"get":{"description":"\n10 credits per API call
\n\nGet the latest block height for supported blockchains. The response is a block number (height) for most chains.
\n","operationId":"GetCurrentBlockBlockchainsApi","parameters":[{"description":"Blockchain to query.","in":"query","name":"chain","required":true,"schema":{"$ref":"#/components/schemas/ChainEnumBlockchainsApiBlock"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"number","example":52034123}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get current block height","tags":["Blockchains API"]}},"/v4/data/blockchains/block":{"get":{"description":"\n50 credits per API call
\n\nGet block details by hash or height for supported blockchains. Response shape differs by chain (EVM-style vs UTXO-style). Bitcoin Cash (bch-mainnet, bch-testnet) returns the raw node block format (see UtxoRawBlock).
\n","operationId":"GetBlockBlockchainsApi","parameters":[{"description":"Blockchain to query.","in":"query","name":"chain","required":true,"schema":{"$ref":"#/components/schemas/ChainEnumBlockchainsApiBlock"}},{"description":"Block hash or height (depending on chain).","in":"query","name":"hashOrHeight","required":true,"schema":{"type":"string","example":"0x1049095"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/EVMBlock"},{"$ref":"#/components/schemas/UtxoBlock"},{"$ref":"#/components/schemas/UtxoRawBlock"}]}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get block by hash or height","tags":["Blockchains API"]}},"/v4/data/blockchains/block/hash":{"get":{"description":"\n10 credits per API call
\n\nGet the block hash for a given block height (block number) for supported blockchains. Use block number only (e.g. ledger index for Ripple, sequence for Stellar).
\n","operationId":"GetBlockHashBlockchainsApi","parameters":[{"description":"Blockchain to query.","in":"query","name":"chain","required":true,"schema":{"$ref":"#/components/schemas/ChainEnumBlockchainsApiBlock"}},{"description":"Block height (block number). For Ripple use ledger index; for Stellar use sequence.","in":"query","name":"blockNumber","required":true,"schema":{"type":"integer","minimum":0,"example":481863047}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["hash"],"properties":{"hash":{"type":"string","description":"Block hash (hex or chain-specific format)."}}}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get block hash by block number","tags":["Blockchains API"]}},"/v4/data/blockchains/utxo/info":{"get":{"description":"\n10 credits per API call
\n\nGet information about a transaction output (UTXO) by transaction hash and output index. Supported for Bitcoin, Litecoin, Dogecoin, and Bitcoin Cash. Response is normalized: value in smallest unit (satoshis), address, script, hash, index, and height (block height; for mempool/unconfirmed UTXOs, height is -1). If the output is spent, the API returns 403.
20 credits per API call
\n\nGet mempool (unconfirmed) transaction hashes for a UTXO chain. Supported chains: Bitcoin, Litecoin, Dogecoin, BCH (mainnet and testnet). Response is an array of transaction hashes (strings).
\n","operationId":"GetMempoolBlockchainsApi","parameters":[{"description":"UTXO blockchain (bitcoin-mainnet, bitcoin-testnet, litecoin-mainnet, litecoin-testnet, dogecoin-mainnet, dogecoin-testnet, bch-mainnet, bch-testnet).","in":"query","name":"chain","required":true,"schema":{"$ref":"#/components/schemas/ChainEnumBlockchainsApiMempool"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"description":"Mempool transaction hashes."}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get mempool transaction hashes","tags":["Blockchains API"]}},"/v4/data/blockchains/transaction":{"get":{"description":"\n10 credits per API call
\n\nGet a transaction by hash. Response shape differs by chain (EVM-style vs UTXO-style). Bitcoin Cash (bch-mainnet, bch-testnet) returns the raw node transaction format (see UtxoRawTransaction).
\n","operationId":"GetTransactionBlockchainsApi","parameters":[{"description":"Blockchain to query.","in":"query","name":"chain","required":true,"schema":{"$ref":"#/components/schemas/ChainEnumBlockchainsApiTxByHash"}},{"description":"Transaction hash.","in":"query","name":"hash","required":true,"schema":{"type":"string","example":"0x7b3b0b..."}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/EVMTransaction"},{"$ref":"#/components/schemas/UTXOTransaction"},{"$ref":"#/components/schemas/UtxoRawTransaction"}]}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get transaction by hash","tags":["Blockchains API"]}},"/v4/data/blockchains/transaction/internal":{"get":{"description":"\n20 credits per API call
\n\nGet internal transactions by address for EVM chains (Ethereum, BSC, Polygon, Celo, Base, Arbitrum, Optimism, Bera, Unichain, Monad).
\n","operationId":"GetInternalTransactionsBlockchainsApi","parameters":[{"description":"EVM chain to query (ethereum, bsc, polygon, celo, base, arb-one, optimism, bera, uni, monad and their testnets).","in":"query","name":"chain","required":true,"schema":{"$ref":"#/components/schemas/ChainEnumBlockchainsApiInternalTx"}},{"description":"Address to get internal transactions for.","in":"query","name":"address","required":true,"schema":{"type":"string","example":"0x278d858f05b94576C1E6f73285886876ff6eF8D2"}},{"description":"Number of items per page (1-100).","in":"query","name":"pageSize","required":true,"schema":{"type":"integer","minimum":1,"maximum":100,"example":20}},{"description":"Offset for pagination (0-based).","in":"query","name":"offset","schema":{"type":"integer","minimum":0,"example":0}},{"description":"Optional block height to start from (inclusive).","in":"query","name":"blockFrom","schema":{"type":"integer","minimum":0}},{"description":"Optional block height to end at (inclusive); must be >= blockFrom if set.","in":"query","name":"blockTo","schema":{"type":"integer","minimum":0}},{"description":"Sort order - desc for latest first, asc for oldest first.","in":"query","name":"sort","schema":{"type":"string","enum":["asc","desc"],"default":"desc"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InternalTransaction"}}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get internal transactions by address","tags":["Blockchains API"]}},"/v4/data/blockchains/balance":{"get":{"description":"\n10 credits per API call
\n\nGet native balance for an address. UTXO chains return additional aggregated fields.
\n","operationId":"GetBalanceBlockchainsApi","parameters":[{"description":"Blockchain to query.","in":"query","name":"chain","required":true,"schema":{"$ref":"#/components/schemas/ChainEnumBlockchainsApiBalance"}},{"description":"Address to check.","in":"query","name":"address","required":true,"schema":{"type":"string","example":"0x8ba1f109551bd432803012645ac136ddd64dba72"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BalanceSimple"},{"$ref":"#/components/schemas/BalanceUtxo"}]}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get native balance","tags":["Blockchains API"]}},"/v4/data/blockchains/balance/batch":{"get":{"description":"\n10 credits per address (e.g. 3 addresses = 30 credits)
\n\nGet native balance for multiple addresses in one request. Supports up to 30 comma-separated addresses (up to 10 for Tron). UTXO chains (Bitcoin, Litecoin, Dogecoin) return additional aggregated fields per address.
\n","operationId":"GetBalanceBatchBlockchainsApi","parameters":[{"description":"Blockchain to query.","in":"query","name":"chain","required":true,"schema":{"$ref":"#/components/schemas/ChainEnumBlockchainsApiBalance"}},{"description":"Comma-separated list of addresses (max 30, max 10 for Tron).","in":"query","name":"addresses","required":true,"schema":{"type":"string","example":"0x8ba1f109551bd432803012645ac136ddd64dba72,0xd6A7AC86DF3017A164d7d3991Fe76c9fdc8a4A61"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/BalanceBatchItemSimple"},{"$ref":"#/components/schemas/BalanceBatchItemUtxo"}]}}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get native balance (batch)","tags":["Blockchains API"]}},"/v4/data/blockchains/transaction/count":{"get":{"description":"\n10 credits per API call
\n\nGet the count of outgoing transactions (including pending) for the given address.
\n","operationId":"GetTransactionCountBlockchainsApi","parameters":[{"description":"Blockchain to query.","in":"query","name":"chain","required":true,"schema":{"$ref":"#/components/schemas/ChainEnumBlockchainsApiTxCount"}},{"description":"Address to inspect.","in":"query","name":"address","required":true,"schema":{"type":"string","example":"0x8ba1f109551bd432803012645ac136ddd64dba72"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"integer","example":42}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get outgoing transaction count","tags":["Blockchains API"]}},"/v4/data/blockchains/transaction/history/utxos":{"get":{"description":"\n20 credits per API call
\n\nGet transaction history by address for UTXO chains (Bitcoin, Litecoin, Dogecoin, Cardano) with pagination and optional block range and tx type filter.
\n\nCardano (ADA): Only address, pageSize, and offset are supported. Filters blockFrom, blockTo, and txType are not available for Cardano.
20 credits per address (e.g. 5 addresses = 100 credits)
\n\nGet transaction history by address for multiple addresses in one request (UTXO chains: Bitcoin, Litecoin, Dogecoin, Cardano). Max 30 addresses. Optional txType filter (incoming/outgoing) for BTC/LTC/DOGE.
Cardano (ADA): Only addresses are used. Filter txType is not available for Cardano. Returns ADA format (see example).
20 credit per API call
\n\n> 📘 **Note for v3 API users:** \n>\n> As part of our documentation consolidation, we removed the dedicated page for GET /v3/data/tokens. Users can refer to GET /v4/data/tokens for the latest documentation, as both endpoints function the same—simply replace v4 with v3 in the API URL if using the v3 version.\n\nGet information about your favorite token! Our API lets you search for all tokens on:
\nTo get started:
\ntokenId as a query parameter.'native' keyword in the tokenAddress parameter. It is supported only for the mainnet of the following chains:\n 250 credits per API call
\n\nReturns the top trending tokens on the specified blockchain, ranked by recent trading activity, volume, liquidity, and holder growth. Each entry includes price, market cap, liquidity, holder count, and per-timeframe (1h/4h/12h/24h) statistics for price change, volume, transactions, buyers, and sellers.
\nSupported blockchains:
\n400 credits per API call
\n\nReturns the newest tokens minted on the blockchain based on mint timestamp, filtered by an activity window and optional category.
\nSupported blockchains:
\n150 credits per API call
\n\nReturns the most popular tokens across the entire blockchain for a specified activity window and optional category. Popularity is determined by the token's number of active wallets during the activity window.
\nSupported blockchains:
\n150 credits per API call
\n\nReturns the most popular tokens across the entire blockchain for a specified date in time and optional category. Popularity is determined by the token's number of active wallets during the specified calendar date.
\nSupported blockchains:
\n5000 credits per API call
\n\nThis endpoint retrieves trade data across the entire blockchain enriched with WalletDNA metrics. Developers can filter trades by size, side, or wallet behavior (IQ, Reputation, Flow, Mass, Epoch, Maker Presence). Responses include detailed trade, token, and wallet profiles, enabling advanced segmentation, smart-money tracking, and high-signal on-chain analytics in real time.
\nSupported blockchains:
\n/v4/data/rate/history
\n50 credits per API call
\nRetrieves token prices, FDV, and liquidity at any block or timestamp, including percentage change for specified lookback periods.
\nSupported blockchains:
\n100 credits per API call
\n\n> 📘 **Note for v3 API users:** \n>\n> As part of our documentation consolidation, we removed the dedicated page for GET /v3/data/utxos. Users can refer to GET /v4/data/utxos for the latest documentation, as both endpoints function the same—simply replace v4 with v3 in the API URL if using the v3 version.\n\nGet unspent UTXOs for a specific address up to a specific total amount.\nIf you want to prepare a transaction on UTXO-based chains like Bitcoin, you need to enter unspent UTXOs to be able to perform a transaction. By providing ```totalValue``` as a total, our API will return a list of UTXOs that will be enough to cover the transaction.
\nOur API lets you get the unpenst UTXOs for a specific address on:\nTo get started:
\n100 credits per address for each API call.
\n\n> 📘 **Note for v3 API users:** \n>\n> As part of our documentation consolidation, we removed the dedicated page for POST /v3/data/utxos/batch. Users can refer to POST /v4/data/utxos/batch for the latest documentation, as both endpoints function the same—simply replace v4 with v3 in the API URL if using the v3 version.\n\nRetrieve unspent UTXOs for each provided address, up to a specified total amount.\nIf you want to prepare a transaction on UTXO-based chains like Bitcoin, you need to enter unspent UTXOs to be able to perform a transaction. By providing ```totalValue``` as a total, our API will return a list of UTXOs that will be enough to cover the transaction.
\nOur API lets you get the unpenst UTXOs for a specific address on:\nTo get started:
\n/v3/security/address/{address}
\nCheck, if the blockchain address is malicous. Malicous address can contain assets from the DarkWeb, is connected to the scam projects or contains stolen funds.
We use malicious address data from standard on-chain analytics providers for this endpoint. The API response includes the sources used.
Supported Chains: ETH, BTC, LTC, SOLANA, TRON
\n","operationId":"CheckMalicousAddress","parameters":[{"description":"Blockchain Address to check","in":"path","name":"address","required":true,"schema":{"example":"0x002Bf459dC58584D58886169EA0E80f3Ca95FFAF","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Whether address is malicous or not","example":"valid","enum":["valid","invalid"]},"address":{"type":"string","description":"Wallet address","example":"0x002Bf459dC58584D58886169EA0E80f3Ca95FFAF"},"source":{"type":"string","description":"Source of the data","example":"CryptoScamDB"},"description":{"type":"string","description":"Why this address is malicious","example":"Trust trading scam site"}}}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Check malicous address","tags":["Malicious address"]}},"/v4/data/rate/symbol":{"get":{"description":"/v4/data/rate/symbol
\nCredit cost: 20 credits when basePair is a fiat currency or USDT / USDC; 50 credits when basePair is any other crypto symbol.
Get the current exchange rate for exchanging fiat/crypto assets.
\nWe support the top 1000+ token symbols by market cap.
\nTokens are made available as soon as they’re published to CEXes or DEXes.
\nWe pull from 10+ CEXes & 100+ DEXes.
\nBy default, the base pair (the target asset) is EUR. When obtaining the exchange rate for an asset (for example, BTC), the value returned by the API expresses the amount of EUR that can be currently exchanged into 1 BTC.
\nAccepted base pairs depend on the plan:
\nUSDT and USDC./v4/data/rate/symbol/batch
\nCredit cost (per pair): 20 credits when basePair is a fiat currency or USDT / USDC; 50 credits when basePair is any other crypto symbol. The total cost is the sum across all pairs in the batch.
Get the current exchange rates for exchanging fiat/crypto assets.
\nWe support the top 1000+ token symbols by market cap.
\nTokens are made available as soon as they’re published to CEXes or DEXes.
\nWe pull from 10+ CEXes & 100+ DEXes.
\nWhen obtaining the exchange rate for an asset (for example, BTC), the value returned by the API expresses the amount of EUR that can be currently exchanged into 1 BTC.
\nAccepted base pairs depend on the plan:
\nUSDT and USDC./v4/data/rate/symbol/OHLCV
\n50 credits per API call
\nGet historical exchange rate in USD for a symbol at a specific point in time.
\nThis endpoint retrieves the closest available price record for a given symbol and timestamp. The data includes OHLCV (Open, High, Low, Close, Volume). By default returns 1-minute candles; use the interval parameter to aggregate into 5m, 15m, 1h, 1d, etc.
Supported symbols: We support 439+ trading pairs. The symbol parameter accepts the base currency (e.g., \"BTC\", \"ETH\").
\nTime handling:
\nopenTime ≤ time < closeTime), or the closest available record if no exact match is found.Time format: You can provide time either as a Unix timestamp in milliseconds (using the unix parameter) or as a Date object (using the time parameter). You must provide exactly one of these parameters.
Interval: Candle interval. Supported values: 1m, 5m, 15m, 30m, 45m, 1h, 2h, 4h, 1d, 1w, 1M. Defaults to 1m.
\n","operationId":"getSymbolOHLCV","parameters":[{"description":"The base symbol of the trading pair (e.g., \"BTC\", \"ETH\").","in":"query","name":"symbol","required":true,"schema":{"$ref":"#/components/schemas/HistoricalPriceSymbol"},"example":"BTC"},{"description":"Unix timestamp in milliseconds. Eitherunix or time must be provided, but not both.","in":"query","name":"unix","required":false,"schema":{"type":"integer","minimum":0,"example":1609459200000}},{"description":"Date object in ISO 8601 format. Either unix or time must be provided, but not both.","in":"query","name":"time","required":false,"schema":{"type":"string","format":"date-time","example":"2021-01-01T00:00:00Z"}},{"description":"Candle interval. Supported values: 1m, 5m, 15m, 30m, 45m, 1h, 2h, 4h, 1d, 1w, 1M. Defaults to 1m.","in":"query","name":"interval","required":false,"schema":{"type":"string","enum":["1m","5m","15m","30m","45m","1h","2h","4h","1d","1w","1M"]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoricalPrice"}}},"description":"OK - Returns the closest available historical price record for the requested symbol and time."},"400":{"description":"Bad Request - Invalid parameters (e.g., both unix and time provided, or neither provided, or invalid symbol)."},"401":{"$ref":"#/components/responses/Error401"},"403":{"description":"Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions."},"404":{"description":"Not Found - No historical price data found for the requested symbol."},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get OHLCV by Symbol","tags":["Exchange rate"]}},"/v4/data/rate/symbol/OHLCV/batch":{"get":{"description":"/v4/data/rate/symbol/OHLCV/batch
\n500 credits per API call
\nGet multiple historical OHLCV (Open, High, Low, Close, Volume) candles for a symbol starting from a given time.
\nReturns up to numberOfCandles (max 50) OHLCV candles with openTime ≥ the provided start time, ordered by openTime ascending. The optional interval query parameter sets the candle size (same values as GET /v4/data/rate/symbol/OHLCV); it defaults to 1m.
Supported symbols: We support 439+ trading pairs. The symbol parameter accepts the base currency (e.g., \"BTC\", \"ETH\").
\nTime format: Provide the start of the range either as a Unix timestamp in milliseconds (unixFrom) or as a Date in ISO 8601 format (timeFrom). You must provide exactly one of these parameters.
unixFrom or timeFrom must be provided, but not both.","in":"query","name":"unixFrom","required":false,"schema":{"type":"integer","minimum":0,"example":1609459200000}},{"description":"Start time in ISO 8601 format. Either unixFrom or timeFrom must be provided, but not both.","in":"query","name":"timeFrom","required":false,"schema":{"type":"string","format":"date-time","example":"2021-01-01T00:00:00Z"}},{"description":"Number of candles to return (1 to 50).","in":"query","name":"numberOfCandles","required":true,"schema":{"type":"integer","minimum":1,"maximum":50,"example":10}},{"description":"Candle interval. Supported values: 1m, 5m, 15m, 30m, 45m, 1h, 2h, 4h, 1d, 1w, 1M. Defaults to 1m.","in":"query","name":"interval","required":false,"schema":{"type":"string","enum":["1m","5m","15m","30m","45m","1h","2h","4h","1d","1w","1M"]}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HistoricalPrice"}}}},"description":"OK - Returns up to numberOfCandles OHLCV records starting from the given time."},"400":{"description":"Bad Request - Invalid parameters (e.g., both unixFrom and timeFrom provided, or neither provided, or invalid symbol, or numberOfCandles out of range)."},"401":{"$ref":"#/components/responses/Error401"},"403":{"description":"Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions."},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get OHLCV by Symbol - Batch","tags":["Exchange rate"]}},"/v4/data/rate/price-change":{"get":{"description":"/v4/data/rate/price-change
\n200 credits per API call
\nGet price change data for a symbol over a specified time range or interval.
\nThis endpoint calculates the price change (both absolute and percentage) for a given symbol between two points in time. You can either specify an explicit time range using timeFrom and timeTo, or use a predefined interval that computes the change from the last fully closed candle.
Supported symbols: We support 439+ trading pairs. The symbol parameter accepts the base currency (e.g., \"BTC\", \"ETH\").
\nBase pair: By default, the base pair is \"USDT\". You can specify a different quote asset (e.g., \"ETH\", \"USDC\") using the basePair parameter.
Time range options:
\ntimeFrom and timeTo to calculate price change over a specific period. Both parameters must be in ISO 8601 date-time format.interval parameter (e.g., \"1h\", \"1d\", \"1w\", \"1M\") to calculate price change from the last fully closed candle of that interval. Supported intervals: 1m, 5m, 15m, 30m, 45m, 1h, 2h, 4h, 1d, 1w, 1M, 1y.Important: You must provide either (timeFrom + timeTo) OR interval, but not both.
timeTo if not using interval.","in":"query","name":"timeFrom","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-01-01T00:00:00Z"},{"description":"Range end (ISO 8601 date-time). Must be provided together with timeFrom if not using interval. Must be greater than timeFrom.","in":"query","name":"timeTo","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-01-02T00:00:00Z"},{"description":"Interval computed from the last fully closed candle (e.g. \"1h\", \"1d\", \"1w\", \"1M\"). Must be provided if not using timeFrom and timeTo.","in":"query","name":"interval","required":false,"schema":{"type":"string","enum":["1m","5m","15m","30m","45m","1h","2h","4h","1d","1w","1M","1y"]},"example":"1d"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceChangeResponse"}}},"description":"OK - Returns price change data for the requested symbol and time range/interval."},"400":{"description":"Bad Request - Invalid parameters (e.g., both time range and interval provided, or neither provided, or invalid symbol, or timeTo not greater than timeFrom)."},"401":{"$ref":"#/components/responses/Error401"},"403":{"description":"Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions."},"404":{"description":"Not Found - No price data found for the requested symbol and time range/interval."},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get Price Change by Symbol","tags":["Exchange rate"]}},"/v4/data/rate/price-change/batch":{"post":{"description":"/v4/data/rate/price-change/batch
\n200 credits per API call
\nGet price change data for multiple symbols in a single request. Each item may specify a time range (timeFrom + timeTo) or an interval. Maximum 10 items per request.
Request body must be an array of objects (or { \"body\": [ ... ] }). Each object must include symbol, batchId, and either (timeFrom + timeTo) or interval.
batchId."},"400":{"description":"Bad Request - Invalid parameters (e.g., invalid time range/interval, or more than 10 items)."},"401":{"$ref":"#/components/responses/Error401"},"403":{"description":"Forbidden."},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get Price Change by Symbol - Batch","tags":["Exchange rate"]}},"/v4/data/rate/contract":{"get":{"description":"/v4/data/rate/contract
\n20 credit per API call
\nGet the current exchange rate by chain & contract address.
\nBy default, the base pair (the target asset) is EUR. When obtaining the exchange rate for an contract address for chain (for example, 0xdAC17F958D2ee523a2206206994597C13D831ec7 on ethereum-mainnet), the value returned by the API expresses the amount of EUR that can be currently exchanged into 1 0xdAC17F958D2ee523a2206206994597C13D831ec7 (USDT).
\n","operationId":"getExchangeRateByContractAddress","parameters":[{"description":"The blockchain to work with.","in":"query","name":"chain","required":true,"schema":{"$ref":"#/components/schemas/ChainEnumForExchangeRateByContract"}},{"description":"The blockchain contract address of the smart contract.","in":"query","name":"contractAddress","required":true,"schema":{"type":"string","example":"0xdac17f958d2ee523a2206206994597c13d831ec7"}},{"description":"The target fiat asset to get the exchange rate for","in":"query","name":"basePair","schema":{"$ref":"#/components/schemas/FiatCurrency","default":"EUR","example":"USD"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeRateByContract"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Error401"},"403":{"description":"Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions."},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get Exchange Rate by Contract","tags":["Exchange rate"]}},"/v4/data/rate/contract/batch":{"post":{"description":"/v4/data/rate/contract/batch
\n20 credits per pair per API call
\nGet the current exchange rates by chain and contract address for multiple pairs in one request.
\nBy default, the base pair (the target asset) is EUR. When obtaining the exchange rate for a contract address on a chain, the value returned expresses the amount of the base pair that can be currently exchanged into 1 unit of the token.
\nLimits: Maximum 25 pairs per request. Maximum 3 different chains per request. Duplicate (chain, contractAddress) pairs are allowed and return the same price for each occurrence.
\nWhen a token price is not available, the response item includes value and timestamp as null and an error object with message \"Token not found\". Successful and failed items are returned together in the same response.
\n","operationId":"getExchangeRatesByContractAddress","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RateByContractAddressQuery"},"maxItems":25}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExchangeRateByContractBatchItem"}}}},"description":"OK"},"400":{"description":"Bad Request - Invalid parameters (e.g. more than 25 pairs, more than 3 different chains, or unsupported chain)."},"401":{"$ref":"#/components/responses/Error401"},"403":{"description":"Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions."},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get Exchange Rate by Contract - Batch","tags":["Exchange rate"]}},"/v4/data/staking/native/current-assets":{"get":{"description":"\n100 credits per API call
\n\nGet current staked assets for a wallet address. This endpoint returns information about all stake accounts/validators owned by the address, including their state, delegated amount, active amount, and associated validators.
\nSupported blockchains:
\nTo get started:
\nstakeAddresses with stake account data.validators with validator index and validator pubkey.100 credits per API call
\n\nGet current staked assets grouped by validator for a wallet address.
\nSupported blockchains:
\nTo get started:
\nvalidatorAddresses grouped by validator with arrays of stake accounts./staking/native/current-assets and contains validators.100 credits per API call
\n\nGet historical staking rewards for a stake account. Returns detailed reward information including epoch, block number, reward amount, and post-balance for each reward period.
\nSupported blockchains:
\nTo get started:
\nepochFrom and epochTo parameters.blockFrom and blockTo parameters.timeFrom and timeTo parameters (ISO 8601 format).unixFrom and unixTo parameters.100 credits per stake address per API call
\n\nGet historical staking rewards for up to 50 stake accounts in a single request. Returns the same per-address shape as /staking/native/rewards, one entry per input address, in input order.
Supported blockchains:
\nTo get started:
\nchain, an array of 1–50 unique stakeAddresses, and (optionally) shared filters.stakeAddress, totalAmount, rewards[]). Rewards inside each item are sorted by epoch descending.100 credits per API call
\n\nGet staking-related transactions for a Solana stake account or Ethereum withdrawal address. Returns deposits, topups, withdrawals, and credential changes.
\nResponse shape differs by chain: Solana returns stakeAddress and transactions with stakeAddress/validatorAddress; Ethereum returns withdrawalAddress and transactions with withdrawalAddress/validatorIndex/validatorPubkey.
Supported blockchains:
\nEthereum-specific: For beacon-only events (withdrawals, credential_change), txHash is a synthetic reference ID, not an on-chain execution transaction hash. blockNumber for credential_change is the consensus slot. amount is in ETH. Results are limited to 100,000 transactions per request; use type, timeFrom/timeTo, or epochFrom/epochTo filters for addresses with more history.
To get started:
\ntype parameter. Chain-specific: Solana supports create, stake, unstake, withdraw, split (not credential_change); Ethereum supports create, stake, withdraw, credential_change (not unstake, split). Using an unsupported type for a chain returns 400.epochFrom and epochTo parameters.blockFrom and blockTo parameters.timeFrom and timeTo parameters (ISO 8601 format).unixFrom and unixTo parameters.50 credits per API call
\n\nGet all available staking pools (validators) on Solana. This endpoint returns comprehensive information about all validators including their address, identity, commission, stake amounts, APY, and additional metadata such as name, website, and location.
\nSupported blockchains:
\nTo get started:
\n100 credits per API call
\n\nGet liquid staked assets for a wallet address. Returns all liquid staking token balances held by the address from top pools (Lido, Rocket Pool, Marinade, Jito, etc.).
\nSupported blockchains:
\nTo get started:
\n50 credits per API call
\n\nGet the top liquid staking pools for a blockchain. Returns all supported liquid staking tokens (protocol, symbol, token address) that can be used with /staking/liquid/current-assets.
Supported blockchains:
\nTo get started:
\n50 credits per API call
\n\nGet mining rewards (coinbase outputs) for a UTXO address. This endpoint returns all coinbase rewards received by the address when it successfully mined blocks.
\nSupported blockchains:
\nTo get started:
\npageSize (max 500) and offset parameters.100 credits per API call
\n\nGet total mining rewards (sum of all coinbase outputs) earned by a UTXO address till date.
\nSupported blockchains:
\n10 credits per API call
\nGet an estimated gas price (wei) and the number of gas units needed for a transaction.
\nNew endpoint which is unifying all supported chains for gas estimation into the one. List of supported chains is bellow.
\n1 credit per API call
\nGet the recommended fee/gas price for a blockchain.
\nFee is in satoshis(meaning currency(BTC, DOGE,... / 100 000 000) per byte\n
This API is supported for the following blockchains:
\n10 credits per API call
\nEstimate the current fee for different types of transactions.
\nThis API is supported for the following blockchains:
\n10 credits per API call + 10 credits per each gas estimation
\nGet an estimated gas price and the number of gas units needed for multiple Ethereum transactions. The gas price is obtained from multiple sources and calculated based on the latest N blocks and the current mempool state.
\nThe estimations are returned in the same order as the transactions were submitted in the request.
\nThe fast gas price is used by default.
NOTE: The estimated gas price is returned in wei. However, when making a transaction itself and providing the custom fee, you have to provide the gas price in Gwei. Make sure to convert the estimated gas price from wei to Gwei before submitting your transaction.
\n\n","operationId":"EthEstimateGasBatch","parameters":[{"description":"Type of Ethereum testnet. Defaults to ethereum-sepolia.","in":"header","name":"x-testnet-type","required":false,"schema":{"default":"ethereum-sepolia","type":"string","enum":["ethereum-sepolia"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EthEstimateGasArray"}}},"required":true},"responses":{"200":{"headers":{"x-current-block":{"schema":{"type":"number"},"description":"Current block of the blockchain."},"x-current-block-time":{"schema":{"type":"string","format":"date-time","example":"2021-11-11T11:54:49.000Z"},"description":"Current block time."}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EthGasEstimationBatch"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"description":"Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error403EthTxBody"},{"$ref":"#/components/schemas/Error403EthGasCalculation"}]}}}},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Estimate the fee for multiple Ethereum transactions","tags":["Fee Estimation API"]}},"/v3/xdc/gas":{"post":{"description":"2 credits per API call
\nGet an estimated gas price and the number of gas units needed for a XinFin transaction. The gas price is obtained from https://rpc.xinfin.network/gasPrice.
\nNOTE: The estimated gas price is returned in wei. However, when making the transaction itself and providing the custom fee, you have to provide the gas price in Gwei. Make sure to convert the estimated gas price from wei to Gwei before submitting your transaction.
\n","operationId":"XdcEstimateGas","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XdcEstimateGas"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GasEstimated"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"description":"Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error403XdcGasCalculation"}]}}}},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Estimate the fee for a XinFin transaction","tags":["Fee Estimation API"]}},"/v3/vet/transaction/gas":{"post":{"description":"5 credits per API call
\nGet an estimated amount of gas needed for a VeChain transaction.
\n","operationId":"VetEstimateGas","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VetEstimateGas"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"number","example":21000}}},"description":"OK"},"403":{"description":"Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403VetFailed"}}}},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Estimate the gas needed for a VeChain transaction","tags":["Fee Estimation API"]}},"/v4/data/marketplace/cryptoslam/token/trending":{"get":{"description":"\n250 credits per API call per address
\n\nReturns trending tokens across the entire blockchain for a specified activity window and optional category. The size of the increase in active wallets over the activity window determines the token's trending rank.
\nSupported blockchains:
\n40 credits per API call
\n\nReturns current token prices with FDV, liquidity, and 24h price change, quoted in USD, ETH, or BTC.
\n\nRules:
\nSupported blockchains:
\n45 credits per API call
\n\nRetrieves token prices, FDV, and liquidity at any block or timestamp, including percentage change for specified lookback periods.
\n\nRules:
\nSupported blockchains:
\n50 credits per API call
\n\nRetrieves token price details including FDV, liquidity, and 24-hour change, quoted in any ERC20 or major blockchain token.
\n\nRules:
\nSupported blockchains:
\n50 credits per API call
\n\nReturns token prices, FDV, liquidity and lookback percentage change quoted in any token at a historical block or timestamp.
\n\nRules:
\nSupported blockchains:
\n80 credits per API call
\n\nReturns trades for a specified token address, with optional filtering by side, trader, maker, paired token, block range, or timestamp range.
\n\nSupported blockchains:
\n25 credits per API call
\n\nReturns token transfers for a specific token address, with optional filters by participant address, direction, block/timestamp range, and pagination.
\n\nSupported blockchains:
\n100 credits per API call
\n\nReturns token transfer records for a given token address, enriched with WalletDNA analytics—including sender and receiver wallet tiers (\"size\"), labels, current balances (token & USD), and each address's share of supply. Each record includes FDV and live token pricing. Supports filtering by participant address, direction, block range, or timestamp. Longer response times should be expected due to the richness of the data.
\n\nSupported blockchains:
\n1500 credits per API call
\n\nReturns reputation scores for one or more wallets holding a token, at the current or historical block/timestamp.
\n\nRules:
\nSupported blockchains:
\n100 credits per API call
\n\nReturns trades across the entire blockchain, with optional filtering by block range or timestamp range.
\n\nSupported blockchains:
\n5000 credits per API call
\n\nThis endpoint retrieves trade data across the entire blockchain enriched with WalletDNA metrics. Developers can filter trades by size, side, or wallet behavior (IQ, Reputation, Flow, Mass, Epoch, Maker Presence). Responses include detailed trade, token, and wallet profiles, enabling advanced segmentation, smart-money tracking, and high-signal on-chain analytics in real time.
\n\nSupported blockchains:
\n30 credits per API call
\n\nReturns token transfers across the entire blockchain, with optional filtering by block range or timestamp range.
\n\nSupported blockchains:
\n100 credits per API call
\n\nReturns token transfers across the entire blockchain, enriched with WalletDNA analytics—including sender and receiver wallet tiers (\"size\"), labels, current balances (token & USD), and each address's share of supply. Each record includes FDV and live token pricing. Supports filtering by block range or timestamp. Longer response times should be expected due to the richness of the data.
\n\nSupported blockchains:
\n80 credits per API call
\n\nReturns trades for a specified wallet address as the trader (default) or maker, with optional filtering by token, paired token, pair, side, block range, or timestamp range.
\n\nSupported blockchains:
\n4000 credits per API call
\n\nThe Wallet Trades DNA endpoint returns all trades for a specific wallet, enriched with HolderDNA metrics calculated at the time of each swap. Supports DNA-based filters, allowing segmentation across different tokens. This lets you track how wallet intelligence, reputation, and other behavioral signals evolve per token throughout trading history.
\n\nSupported blockchains:
\n25 credits per API call
\n\nReturns token transfers for a specified wallet address, with optional filtering by token address, participant address, direction, block range, or timestamp range. You may filter by either tokenAddress or address, but not both.
\n\nSupported blockchains:
\n4000 credits per API call
\n\nReturns token transfer records for a given wallet address, enriched with WalletDNA analytics—including sender and receiver wallet tiers (\"size\"), labels, current balances (token & USD), and each address's share of supply. Each record includes FDV and live token pricing. Supports filtering by participant address, direction, block range, or timestamp. Longer response times should be expected due to the richness of the data.
\n\nSupported blockchains:
\n80 credits per API call
\n\nReturns trades for a specified liquidity pool, with optional filtering by side, trader, maker, block range, or timestamp range.
\n\nSupported blockchains:
\n4000 credits per API call
\n\nThis endpoint retrieves trade data for a specified liquidity pool enriched with WalletDNA metrics. Developers can filter trades by size, side, or wallet behavior (IQ, Reputation, Flow, Mass, Epoch, Maker Presence). Responses include detailed trade, token, and wallet profiles, enabling advanced segmentation, smart-money tracking, and high-signal on-chain analytics in real time.
\n\nSupported blockchains:
\nBilled via Walrus on-chain storage fees — no standard API credits consumed per call.
\n\nUpload a file to Walrus decentralized storage.\nFiles are staged in GCS and then certified on-chain by the Walrus worker asynchronously.\nThe response immediately returns a jobId and a pre-computed blobId;\npoll GET /v4/data/storage/upload/{jobId} to track certification progress.
Epochs and renewals: Walrus storage is divided into epochs (approximately 2 weeks each).\nFiles are stored for the platform default of ~4 epochs (~8 weeks) and are automatically renewed\nby Tatum before each epoch window closes. Renewal fees (SUI/WAL on-chain costs × your plan rate)\nare charged to your Walrus storage balance. To stop automatic renewal, call\nDELETE /v4/data/storage/upload/{jobId}.
report (1).pdf) to avoid blob-id collisions on-chain.multipart/form-data field named file.0 credits per API call
\n\nList all upload jobs for the current API key, ordered by most recently created.\nUse limit and offset to paginate through results.
0 credits per API call
\n\nGet the current status of a Walrus storage upload job. Poll this endpoint after\nPOST /v4/data/storage/upload to track progress through the lifecycle:\nPENDING → UPLOADING → CERTIFIED.
Once status is CERTIFIED, the response includes downloadUrlByQuiltId\nand downloadUrlByQuiltPatchId which can be used to retrieve the file from any\nWalrus aggregator node. The walrusStartEpoch and walrusEndEpoch fields\nindicate the active storage window (one epoch ≈ 2 weeks).
If status is FAILED, the errorMessage field contains the reason.\nFailed jobs are not retried automatically — submit a new upload request to try again.
POST /v4/data/storage/upload.","schema":{"type":"string","example":"68000000000000000000abcd"}}],"responses":{"200":{"description":"Upload job status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalrusStorageJobStatusResponse"},"example":{"jobId":"68000000000000000000abcd","status":"CERTIFIED","filename":"report.pdf","mimeType":"application/pdf","sizeBytes":1048576,"blobId":"mAlStJ4PAJaBuuHEUHotGheikLiTXpQagboGF43bY4s","quiltPatchId":"mAlStJ4PAJaBuuHEUHotGheikLiTXpQagboGF43bY4sBAQCaAg","suiObjectId":"0x1b520353e191083dccad671db585525365e6f5bf70fcf63c7dd8e088ec5c57b6","walrusStartEpoch":29,"walrusEndEpoch":33,"renewalBillingStatus":"active","noRenewal":false,"storageEvents":[{"type":"registered","txDigest":"4ywoqKo35fVadBsXZQEqQkLr4mY6mHS9MykZU3HmzUKX","at":1777304790823,"epochs":4},{"type":"certified","txDigest":"8fkmBPjuGUkYaca1nAVnACoVNeMp6GcV6QVZKHTaDh3K","at":1777304809955}],"downloadUrlByQuiltId":"https://aggregator.walrus-mainnet.walrus.space/v1/blobs/by-quilt-id/mAlStJ4PAJaBuuHEUHotGheikLiTXpQagboGF43bY4s/report.pdf","downloadUrlByQuiltPatchId":"https://aggregator.walrus-mainnet.walrus.space/v1/blobs/by-quilt-patch-id/mAlStJ4PAJaBuuHEUHotGheikLiTXpQagboGF43bY4sBAQCaAg","createdAt":1777304790000,"updatedAt":1777304809955}}}},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"description":"Upload job not found or does not belong to this API key."},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Get Walrus storage upload status","tags":["Storage API"]},"delete":{"description":"\nSoft cancel: 0 credits. Instant delete: billed via Walrus on-chain storage fees (same credit check as upload).
\n\nCancel renewal for a certified Walrus storage upload. Two modes are available:
\n\ninstant=false): marks the blob as noRenewal=true.\nThe file remains on-chain until its current storage epoch expires (walrusEndEpoch),\nthen decommissions naturally. No additional fee is incurred — the remaining prepaid epochs are simply not renewed.instant=true): queues an immediate on-chain delete transaction.\nRequires sufficient Walrus storage credits (same check as upload). The Walrus worker executes the delete tx\nand the on-chain delete fee is charged to your Walrus storage balance afterward.\nCan be applied even if soft cancel was already set — it upgrades to instant.Both modes are idempotent. The job must be in CERTIFIED status and not already\ndecommissioned.
POST /v4/data/storage/upload.","schema":{"type":"string","example":"68000000000000000000abcd"}},{"name":"instant","in":"query","required":false,"description":"Set to true to queue an immediate on-chain delete (costs Walrus storage credits).\nOmit or set to false (default) for a free soft cancel — blob stays on-chain until its epoch expires.\n","schema":{"type":"boolean","default":false,"example":true}}],"responses":{"200":{"description":"Renewal cancelled successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalrusStorageCancelRenewalResponse"},"examples":{"softCancel":{"summary":"Soft cancel (noRenewal)","value":{"jobId":"68000000000000000000abcd","noRenewal":true,"renewalBillingStatus":"active","walrusEndEpoch":33}},"instantDelete":{"summary":"Instant delete queued","value":{"jobId":"68000000000000000000abcd","noRenewal":true,"pendingInstantDelete":true,"renewalBillingStatus":"pending_instant_delete","walrusEndEpoch":33}}}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"description":"Upload job not found or does not belong to this API key."},"500":{"$ref":"#/components/responses/Error500"}},"security":[{"X-API-Key":[]}],"x-codeSamples":[],"summary":"Cancel Walrus storage renewal","tags":["Storage API"]}},"/v4/data/prediction/events":{"get":{"description":"\n100 credits per API call
\n\nList prediction-market events across supported platforms. An event is a top-level\ngrouping of one or more markets that share a common question or outcome set\n(e.g. \"2028 US Presidential Election\"). Each event row includes a roll-up of nested\nmarket counts, total volume, and total liquidity, with an opt-in to embed the full\nlist of nested markets via includeMarkets=true.
Supported platforms (filter via platform or omit for a cross-platform\nfeed):
polymarketkalshiFiltering, sorting and pagination
\nstatus, category, tag and\nsearch filters are only honoured by Polymarket. To use any of them\nyou must also pin platform=polymarket — calling them without that\npin returns 400 so the response is honest about what was filtered.sort accepts volume_desc, liquidity_desc,\nendingSoon, newest. When omitted on a cross-platform feed,\nresults are interleaved so neither platform dominates the first page.pagination.cursor; pass that value verbatim as ?cursor=…\non the next call. Cursors are opaque, fingerprint-bound to the filter set, and\nexpire when filters change — never construct or modify them by hand. The cursor\nfield is omitted from pagination on the last page.Other notes
\nvolumeUnit is usd on Polymarket events\n(dollar-denominated volume) and contracts on Kalshi events (number of\ncontracts traded, not USD).totalLiquidity is null on Kalshi — quoted liquidity\nis not exposed at the event level on Kalshi; compute from per-market orderbook\ndepth if you need it.status in the response is the verbatim upstream status string\n(richer than the status filter enum) — values can include\npaused, archived, settled, etc.markets is populated only when includeMarkets=true is\npassed; otherwise it is null. When populated, every nested market is\nreturned (no internal cap).100 credits per API call
\n\nRetrieve a single prediction-market event by its platform-native identifier.\nUseful for hydrating event detail pages or following links from a listing.
\n\nAccepted id formats:
12345).KXELONMARS). Tickers are\nuppercase alphanumeric with optional - and _\nseparators.Other notes
\n404 when the event does not exist on either platform.400 when the id does not match either\naccepted format.markets is populated only when includeMarkets=true\nis passed; otherwise it is null.volumeUnit and totalLiquidity follow the same\nper-platform rules as the listing endpoint.100 credits per API call
\n\nList prediction markets across supported platforms. A market is a single\nbinary or multi-outcome question (e.g. \"Will candidate X win?\"); it belongs to\na parent event when one is defined upstream. Each row carries pricing-friendly\nroll-ups (volume, liquidity), the current outcome set, and on-chain references\non platforms where they exist.
\n\nSupported platforms (filter via platform or omit for a cross-platform\nfeed):
polymarketkalshiFiltering, sorting and pagination
\nstatus, category, tag,\nsearch and minVolume filters are only honoured by\nPolymarket. To use any of them you must also pin\nplatform=polymarket — calling them without that pin returns\n400.eventId accepts either a Polymarket numeric event id or a\nKalshi event ticker. When omitted, results span all events on the targeted\nplatform(s).endingBefore is an ISO-8601 timestamp; markets closing on or\nafter that timestamp are excluded.sort accepts volume_desc, liquidity_desc,\nendingSoon, newest. When omitted on a cross-platform\nfeed, results are interleaved between the two platforms.pagination.cursor; pass it back verbatim as ?cursor=…\non the next call. Cursors are opaque, fingerprint-bound, and expire when filters\nchange — never construct or modify them by hand.Other notes
\nvolumeUnit is usd on Polymarket (dollar-denominated\nnotional) and contracts on Kalshi (contract count — not USD).liquidity is null on Kalshi — quoted liquidity is\nnot exposed by the upstream markets feed; aggregate orderbook depth\nclient-side if you need it.chain is populated for Polymarket markets (Polygon CTF) and\nnull on Kalshi which has no on-chain footprint.status in the response is the verbatim upstream status string\n(richer than the ?status= filter enum) — values can include\npaused, archived, settled, etc.100 credits per API call
\n\nRetrieve a single prediction market by its platform-native identifier.
\n\nAccepted id formats:
0x + 64 hex characters).KXELONMARS-99). Tickers are\nuppercase alphanumeric with optional - and _\nseparators.Other notes
\n404 when the market does not exist on either platform.400 when the id does not match either\naccepted format.volumeUnit, liquidity and chain follow\nthe same per-platform rules as the listing endpoint.100 credits per API call
\n\nCurrent price snapshot for a single market. Returns per-outcome quotes\n(best bid / best ask / sizes), the implied midpoint, spread, last trade price\nand rolling 24-hour volume. Useful for ticker-style dashboards and pre-trade\npreviews.
\n\nOther notes
\nid formats as GET /markets/{id}\n(Polymarket condition id or Kalshi market ticker).volume24h is reported in the market's volumeUnit —\nusd on Polymarket, contracts on Kalshi.volume24h and volumeUnit are null when\nthe upstream does not expose a 24-hour figure.midPrice and spread are null when\neither side of the book is empty.100 credits per API call
\n\nCurrent orderbook snapshot for one side of a market. The orderbook is\nper-outcome — pass side=yes or side=no to choose which\noutcome's book you want. Returns top-of-book through to depth levels\nof bids and asks, with a computed quoted-liquidity figure within 1% and 5% of the\nmidpoint.
Other notes
\nside is required.hash is a content fingerprint of the book snapshot useful for\nETag-style change detection on poll. Populated on Polymarket; null\non Kalshi (no equivalent upstream field).404 when the market does not exist on either platform.200 credits per API call
\n\nHistorical OHLC price candles for a market over a time window. Used to power\nchart views — every candle includes open / high / low / close prices plus the\nin-bucket trade volume.
\n\nFiltering
\ninterval is required. Accepted values: 1m,\n5m, 15m, 1h, 4h,\n1d, 1w. Each interval has a maximum allowed range\n(e.g. 1m can be queried for ~1 day at a time, 1d for\n~1 year). Requests exceeding the range cap return 400.start and end are required ISO-8601 timestamps.\nend must be after start.source selects the underlying data feed. Defaults to\ncandlesticks (trade-based OHLC with real volume). Pass\nmidpoint to switch to a midpoint-quote feed with broader range\ncoverage at the cost of volume = 0 on every candle.\nsource=midpoint is supported on Polymarket only — passing it\nagainst a Kalshi market returns 400.Other notes
\npartial: true indicates the requested range was truncated by an\nupstream availability limit. This only happens on Polymarket with\nsource=candlesticks (the trade-based feed exposes a finite window\nof historical fills); Kalshi candles cover the full requested range, and\nsource=midpoint on Polymarket also covers the full range.partial is true, availableFrom\ncontains the earliest timestamp the response actually covers — data before that\npoint is unavailable from the trade-based feed. To recover the missing range on\nPolymarket, repeat the call with source=midpoint; the response\nspans the full window at the cost of volume = 0 on every candle\n(the midpoint feed carries quotes, not fills).availableFrom is null when no trades exist in the\nentire requested range.interval=1h\nresponse has timestamps on the hour).100 credits per API call
\n\nRecent trades feed for a single market. Each row is one fill — outcome side,\nbuy/sell direction, price, size and notional value — with the taker wallet\nattribution when the upstream exposes it.
\n\nFiltering and pagination
\nafter and before are ISO-8601 timestamps that\ndefine an inclusive time window. They are honoured by Kalshi natively. On\nPolymarket the upstream /trades feed has no time-window filter, so\npassing after or before against a Polymarket market\nreturns 400 — set the platform via the path id rather than\nattempting cross-platform time queries.pagination.cursor; pass it back verbatim as ?cursor=…\non the next call. Cursors are fingerprint-bound to the time-window filter set.Other notes
\ntaker is the wallet that crossed the spread on this fill.\nPopulated on Polymarket; null on Kalshi (the public trades feed\ndoes not expose per-trade wallet attribution there).txHash is the on-chain settlement transaction hash where one\nexists. Populated on Polymarket and null on Kalshi.side is the outcome side (yes / no);\ndirection is the order side (buy / sell)\n— both are surfaced because they answer different questions.100 credits per API call
\n\nTop holders of a market grouped by outcome token. Each top-level row in the\nresponse is one outcome (e.g. YES, NO); under it sits the list of wallets\ncurrently holding that outcome, ordered by the chosen sortBy\nmetric. Useful for \"who's on each side of this bet\" leaderboards on a\nmarket-detail page.
Platform support
\n400.Filtering, sorting and pagination
\nuser narrows the response to a single wallet — useful for\n\"does this user have a position in this market\" checks.status filters holders by their position state:\nOPEN (size > 0.01), CLOSED (size ≤ 0.01),\nALL (default).sortBy chooses the metric used to order holders inside each\noutcome group: TOKENS, CASH_PNL,\nREALIZED_PNL, TOTAL_PNL. Combine with\nsortDirection (ASC or DESC).limit and offset apply\nper outcome group — e.g. on a binary market with limit=50\nthe response carries up to 100 holders total (50 YES + 50 NO).200 credits per API call
\n\nAggregated portfolio summary for a single wallet. Returns position counts\n(open, redeemable, closed), unrealised and realised PnL, total cost basis,\nactive notional, win rate and ROI — all computed over the requested\nperiod. Useful as the headline KPI block on a wallet detail page.
Platform support
\n400.Filtering
\nperiod selects the lookback window for closed-position\naggregates: 24h, 7d, 30d or\nall. Defaults to all.activeNotional are always live (the\nperiod only affects closed-position roll-ups).Other notes
\naddress is normalised to lowercase before being echoed back\nin the response.winRate is a percentage in [0, 100] (e.g.\n42.5 = 42.5%). It is null when\nclosedPositions is zero — the ratio is undefined, not zero.roi is realised ROI as a percentage (e.g. 23.45\n= 23.45%). Computed from realised PnL over total cost basis of closed\npositions only — unrealised PnL is excluded. null when\ntotalCostBasis is zero.redeemablePositions is the count of positions on a resolved\nmarket that the wallet has won but has not yet redeemed. Disjoint from both\nopenPositions and closedPositions — tracked\nseparately so the count of currently actionable positions is visible.100 credits per API call
\n\nCurrent open positions held by a wallet — one row per outcome token, with\nunrealised PnL, current value, lifetime cost basis, and the parent market's\nquestion, slug and outcome metadata. Useful for \"what's in my portfolio right\nnow\" views and per-market drill-downs.
\n\nPlatform support
\n400.Filtering, sorting and pagination
\nmarket scopes the response to a comma-separated list of\ncondition ids (0x + 64 hex), up to 50 entries.eventId scopes the response to a comma-separated list of\nPolymarket numeric event ids, up to 50 entries. Mutually exclusive with\nmarket — passing both returns 400.sizeThreshold filters out positions smaller than the given\nsize. Defaults to 1; pass 0 to include dust.redeemable=true returns positions on resolved markets that\nthe wallet has won but has not yet redeemed. mergeable=true\nreturns positions eligible for merging back to USDC. Both default to\nfalse.sortBy accepts CURRENT, INITIAL,\nTOKENS, CASHPNL, PERCENTPNL,\nTITLE, RESOLVING, PRICE,\nAVGPRICE. Defaults to TOKENS. Combine with\nsortDirection (ASC / DESC, defaults to\nDESC).title filters by a substring of the market question.limit (1..500, default 100) and\noffset (0..10000, default 0).Other notes
\naddress is normalised to lowercase before being echoed in the\nresponse (every row's proxyWallet).negativeRisk indicates whether the parent market is part of\nPolymarket's negative-risk grouping (e.g. multi-candidate winner-take-all\nmarkets).100 credits per API call
\n\nClosed and resolved positions for a wallet — one row per settled position\n(winning or losing), with the realised PnL, lifetime cost basis, settlement\nprice, and the parent market's question and outcome metadata. Useful for\nbacktest-style P&L drill-downs and tax exports.
\n\nPlatform support
\n400.Filtering, sorting and pagination
\nmarket scopes the response to a comma-separated list of\ncondition ids (0x + 64 hex), up to 50 entries.eventId scopes the response to a comma-separated list of\nPolymarket numeric event ids, up to 50 entries. Mutually exclusive with\nmarket — passing both returns 400.title filters by a substring of the market question.sortBy accepts REALIZEDPNL, TITLE,\nPRICE, AVGPRICE, TIMESTAMP. Defaults\nto REALIZEDPNL. Combine with sortDirection\n(ASC / DESC, defaults to DESC).limit (1..50, default 10) and\noffset (0..100000, default 0).Other notes
\naddress is normalised to lowercase before being echoed in the\nresponse (every row's proxyWallet).timestamp is unix-seconds (not milliseconds) — the settlement\ntime of the position.curPrice is the resolution price (0 or 1 for binary markets);\navgPrice is the volume-weighted entry price.100 credits per API call
\n\nTrade-only fills for a wallet — one row per trade, with the buy/sell side,\noutcome metadata, size, price, transaction hash, and the trader's profile\nfields (display name, profile image). Trade-only — does not include\nnon-trade events like splits, merges, redemptions or rewards (use\n/wallets/{address}/activity for the full feed).
Platform support
\n400.Filtering and pagination
\nmarket / eventId scope the response (mutually\nexclusive, up to 50 entries each).side filters to BUY or SELL trades.takerOnly defaults to true — set to\nfalse to include maker-side fills.filterType and filterAmount set a minimum trade\nsize threshold. filterType=CASH filters by USDC notional;\nfilterType=TOKENS filters by outcome-token count. Both must be\nprovided together — passing one without the other returns 400.limit (1..10000, default 100) and\noffset (0..10000, default 0). The upstream feed enforces a hard\ncap at offset = 3000; calls past that point return an empty page\nrather than an error.Other notes
\naddress is normalised to lowercase before being echoed in the\nresponse (every row's proxyWallet).timestamp is unix-seconds (not milliseconds).side uses the trade-direction vocabulary\n(BUY / SELL) — distinct from the outcome-side\nvocabulary (yes / no) used by\n/markets/{id}/trades.100 credits per API call
\n\nFull wallet event feed — covers every event type the upstream emits:\nTRADE, SPLIT, MERGE, REDEEM,\nREWARD, CONVERSION, MAKER_REBATE and\nREFERRAL_REWARD. Unlike /wallets/{address}/trades,\nthis endpoint includes non-trade events and supports a native time-range\nfilter — useful for activity logs, audit trails and tax exports.
Platform support
\n400.Filtering, sorting and pagination
\nmarket / eventId scope the response (mutually\nexclusive, up to 50 entries each).type is a comma-separated list of event types — up to 8\nentries from the enum.side filters to BUY or SELL\n(relevant for trade-type rows; null on non-trade rows).start / end are unix-seconds\n(not milliseconds) — values that look like millisecond timestamps\n(~13 digits) are rejected with 400. end must be\ngreater than or equal to start.sortBy accepts TIMESTAMP, TOKENS,\nCASH. Defaults to TIMESTAMP. Combine with\nsortDirection (defaults to DESC).limit (1..500, default 100) and\noffset (0..10000, default 0).Other notes
\nside is null on non-trade rows (e.g.\nREWARD, SPLIT, MERGE,\nREDEEM) — direction is undefined there.outcomeIndex can be null for rows that don't map\nto a position side. A sentinel value of 999 is occasionally\nemitted by the upstream for the same case.conditionId and asset can be null on\nrows that aren't market-scoped (e.g. some reward / referral rows).address is normalised to lowercase before being echoed in the\nresponse.50 credits per API call
\n\nTotal USD notional of a wallet's currently open positions. A single-number\nendpoint — useful for sparkline-style summaries and headline KPIs without\npaying the cost of pulling the full positions list.
\n\nPlatform support
\n400.Filtering
\nmarket scopes the total to a comma-separated list of condition\nids (0x + 64 hex), up to 50 entries. Omit for the wallet-wide\ntotal.Other notes
\nvalue is rounded to 2 decimal places.user is the lowercased address.50 credits per API call
\n\nCount of distinct markets a wallet has ever traded. Lifetime metric —\nuseful as a quick activity signal alongside /wallets/{address}/value\nwithout paying the cost of pulling the full trade history.
Platform support
\n400.Other notes
\ntraded is an integer count — the number of distinct markets,\nnot the number of trades.user is the lowercased address.200 credits per API call
\n\nRanked leaderboard of top traders, scoped by category and time period.\nEach row carries the trader's wallet, display fields (username, X handle,\nprofile image), verified-badge status, and the metrics used for ranking\n(volume and PnL within the requested window).
\n\nPlatform support
\nFiltering, sorting and pagination
\ncategory selects the leaderboard slice — one of\nOVERALL, POLITICS, SPORTS,\nCRYPTO, CULTURE, MENTIONS,\nWEATHER, ECONOMICS, TECH,\nFINANCE. Defaults to OVERALL.timePeriod sets the lookback window —\nDAY, WEEK, MONTH, ALL.\nDefaults to DAY.orderBy chooses the ranking metric: PNL\n(realised + unrealised profit) or VOL (trading volume).\nDefaults to PNL.user filters the leaderboard to a single wallet — useful\nfor \"where does this trader rank\" lookups. userName filters\nby trader display name (substring match).limit (1..50, default 25)\nand offset (0..1000, default 0). Higher offsets are not\nsupported by the upstream leaderboard.Other notes
\nrank is the continuous 1-indexed position given the\nrequested filters — rank = 1 is the leader for the chosen\ncategory and time period.proxyWallet is returned lowercased.vol and pnl are USD figures, scoped to the\nrequested category and timePeriod.50 credits per API call
\n\nUnified search across events, tags and trader profiles. One query returns\nall three result types in a single response — pick the branches you care\nabout with searchTags and searchProfiles.\nDesigned for discovery surfaces (autocomplete, top-of-page search) where a\nsingle query needs to surface the most relevant entities of any kind.
Platform support
\nFiltering and pagination
\nq is the required search string — 2..128 characters.\nSingle-character queries are rejected with 400 because they\nmatch an unhelpfully wide slice of the dataset.limitPerType caps the number of results returned per\nbranch (events, tags, profiles) — defaults to 10.searchTags toggles the tags branch — defaults\nto true. searchProfiles toggles the\nprofiles branch — defaults to false because most\ncallers don't need it.eventsStatus narrows the events branch by a free-text\nstatus (e.g. active); eventsTag is a\ncomma-separated list of tag slugs (up to 50 entries).\nkeepClosedMarkets overrides the default behaviour of hiding\nclosed markets from the events branch.sort is a free-text sort key forwarded to the upstream;\nascending sets sort direction.?page=N+1. The response body carries\ndata.pagination.hasMore and data.pagination.totalResults\nfor paging decisions.Other notes
\ntags array\nmeans no tag matches were found, not that the search failed.events share the same shape as the /events\nlisting endpoint, so the same client-side rendering can be reused.profiles rows include only proxyWallet,\nname and pseudonym — additional profile fields\n(image, bio) are not exposed here.type=TRANSFER_ERC20) The blockchain address of the sender address"},"recipient":{"description":"(Only if type=TRANSFER_ERC20) The blockchain address of the recipient address","example":"0x687422eEA2cB73B5d3e242bA5456b782919AFc85","maxLength":42,"minLength":42,"type":"string"},"contractAddress":{"description":"(Only if type=TRANSFER_ERC20) The blockchain address of the smart address of the fungible token","example":"0x687422eEA2cB73B5d3e242bA5456b782919AFc85","maxLength":42,"minLength":42,"type":"string"},"amount":{"description":"(Only if type=TRANSFER_ERC20) The amount of the fungible token to be sent","example":"100000","pattern":"^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$","type":"string"}}},"EstimateFeeBatchMintNft":{"type":"object","required":["chain","type","sender","recipients","tokenIds","urls","contractAddress"],"properties":{"chain":{"type":"string","description":"Blockchain to estimate fee for.","enum":["CELO","ETH","BSC","XDC","ONE","MATIC","KLAY"]},"type":{"type":"string","description":"Type of transaction","enum":["MINT_NFT_BATCH"]},"sender":{"type":"string","maxLength":42,"minLength":43,"example":"0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef","description":"Address of the minter"},"recipients":{"type":"array","description":"Blockchain addresses to mint tokens to","items":{"example":"0x687422eEA2cB73B5d3e242bA5456b782919AFc85","maxLength":42,"minLength":43,"type":"string"}},"contractAddress":{"description":"Contract address of NFT token","example":"0x687422eEA2cB73B5d3e242bA5456b782919AFc85","maxLength":42,"minLength":43,"type":"string"},"tokenIds":{"type":"array","description":"Token IDs","items":{"example":"100000","pattern":"^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$","type":"string"}},"urls":{"type":"array","description":"Metadata URLs","items":{"example":"ipfs://QmXJJ6UF5WkF4WTJvsdhiA1etGwBLfpva7Vr9AudGMe3pj","pattern":"^[+]?((\\d+(\\.\\d*)?)|(\\.\\d+))$","type":"string"}}}},"EstimateFeeDeployCustodialWallet":{"type":"object","required":["chain","type","batchCount"],"properties":{"chain":{"type":"string","description":"Blockchain to estimate fee for.","enum":["CELO","ETH","BSC","XDC","ONE","MATIC","KLAY"]},"type":{"type":"string","description":"Type of transaction","enum":["DEPLOY_CUSTODIAL_WALLET_BATCH"]},"batchCount":{"description":"Number of addresses to create","example":10,"minimum":1,"maximum":300,"type":"number"}}},"EstimateFeeTransferFromCustodial":{"type":"object","required":["chain","type","sender","recipient","custodialAddress","amount","tokenType"],"properties":{"chain":{"type":"string","description":"The blockchain to estimate the fee for","enum":["CELO","ETH","BSC","XDC","KLAY","ONE","MATIC"]},"type":{"type":"string","description":"The type of the transaction","enum":["TRANSFER_CUSTODIAL"]},"sender":{"type":"string","maxLength":42,"example":"0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef","minLength":42,"description":"The blockchain address of the sender"},"recipient":{"description":"The blockchain address of the recipient","example":"0x687422eEA2cB73B5d3e242bA5456b782919AFc85","maxLength":42,"minLength":42,"type":"string"},"contractAddress":{"description":"Contract address of the token","example":"0x687422eEA2cB73B5d3e242bA5456b782919AFc85","maxLength":42,"minLength":42,"type":"string"},"custodialAddress":{"description":"The blockchain address of the custodial wallet contract","example":"0x687422eEA2cB73B5d3e242bA5456b782919AFc85","maxLength":42,"minLength":42,"type":"string"},"tokenType":{"description":"The type of the asset to transfer. Set 0 for fungible tokens (ERC-20 or equivalent), 1 for NFTs (ERC-721 or equivalent), 2 for Multi Tokens (ERC-1155 or equivalent), or 3 for native blockchain currencies.","example":0,"type":"number","minimum":0,"maximum":3,"enum":[0,1,2,3]},"amount":{"description":"1.