# Open API

> 2 mirrored Tatum OpenAPI schemas with 126 operations. Fetch the JSON locally or filter the operations table by method, path, tag, or summary.

- canonical: <https://ai.tatum.io/openapi>
- html: <https://ai.tatum.io/openapi>

## Schemas

| id | title | version | openapi | paths | operations | tags | source |
| --- | --- | --- | --- | --- | --- | --- | --- |
| `blockchain-data` | Blockchain Data | 1.2 | 3.1.0 | 106 | 107 | 15 | <https://docs.tatum.io/openapi/blockchain-data-1.json> |
| `notifications` | Blockchain Notifications | 3.7.3 | 3.1.0 | 11 | 19 | 3 | <https://docs.tatum.io/openapi/notifications-1.json> |

## Blockchain Data - operations

- Tags: Blockchains API, DeFi API, Exchange rate, Fee Estimation API, Malicious address, Marketplace, Mining API, NFT API, Prediction API, Staking, Storage API, Token API, Transactions API, Wallet API, Web3 Name Service
- Source: <https://docs.tatum.io/openapi/blockchain-data-1.json>

| method | path | operationId | tags | summary |
| --- | --- | --- | --- | --- |
| GET | `/v4/data/defi/swaps/quote` | GetV4DataDefiSwapsQuote | DeFi API | Get best swap rate |
| GET | `/v4/data/defi/swaps/quotes` | GetV4DataDefiSwapsQuotes | DeFi API | Get multi-protocol rates |
| GET | `/v4/data/collections` | GetCollectionsV4 | NFT API | Get tokens from a collection |
| GET | `/v4/data/metadata` | GetMetadataV4 | NFT API | Get token metadata |
| GET | `/v4/data/wallet/portfolio` | GetWalletPortfolioV4 | Wallet API | Get wallet portfolio |
| GET | `/v4/data/wallet/balance/time` | GetWalletBalanceByTimeV4 | Wallet API | Get balances by time of addresses |
| GET | `/v4/data/wallet/reputation` | GetWalletReputationV4 | Wallet API | Get wallet reputation |
| GET | `/v4/data/wallet/reputation/portfolio` |  | Wallet API | Get wallet reputation portfolio |
| GET | `/v4/data/wallet/reputation/tokens` | GetWalletReputationTokensV4 | Wallet API | Get wallet reputation by tokens |
| GET | `/v4/data/ns/name` | NameToAddressV4 | Web3 Name Service | Resolve address by domain |
| GET | `/v4/data/owners` | GetOwnersV4 | NFT API | Get owners of a token |
| GET | `/v4/data/owners/address` | CheckOwnerV4 | NFT API | Check owner of token |
| GET | `/v4/data/nft/balances` | GetNftBalancesV4 | NFT API | Get NFT balance of a wallet address |
| GET | `/v4/data/multitoken/balances` | GetMultiTokenBalanceV4 | NFT API | Get Multi Token balances of a wallet address |
| GET | `/v4/data/transaction/history` | GetTransactionHistoryV4 | Transactions API | Get transaction history |
| GET | `/v4/data/transactions/hash` | GetTransactionsByHashV4 | Transactions API | Get transactions by hash |
| GET | `/v4/data/defi/events` | GetDefiEventsV4 | DeFi API | Get specified events |
| GET | `/v4/data/defi/blocks` | GetDefiBlocksV4 | DeFi API | Get specified blocks |
| GET | `/v4/data/defi/blocks/latest` | GetLatestDefiBlockV4 | DeFi API | Get latest block |
| GET | `/v4/data/block/time` | GetBlockByTimeV4 | DeFi API | Get block by time |
| GET | `/v4/data/blockchains/block/current` | GetCurrentBlockBlockchainsApi | Blockchains API | Get current block height |
| GET | `/v4/data/blockchains/block` | GetBlockBlockchainsApi | Blockchains API | Get block by hash or height |
| GET | `/v4/data/blockchains/block/hash` | GetBlockHashBlockchainsApi | Blockchains API | Get block hash by block number |
| GET | `/v4/data/blockchains/utxo/info` | GetUtxoInfoBlockchainsApi | Blockchains API | Get UTXO info by tx hash and index |
| GET | `/v4/data/blockchains/mempool` | GetMempoolBlockchainsApi | Blockchains API | Get mempool transaction hashes |
| GET | `/v4/data/blockchains/transaction` | GetTransactionBlockchainsApi | Blockchains API | Get transaction by hash |
| GET | `/v4/data/blockchains/transaction/internal` | GetInternalTransactionsBlockchainsApi | Blockchains API | Get internal transactions by address |
| GET | `/v4/data/blockchains/balance` | GetBalanceBlockchainsApi | Blockchains API | Get native balance |
| GET | `/v4/data/blockchains/balance/batch` | GetBalanceBatchBlockchainsApi | Blockchains API | Get native balance (batch) |
| GET | `/v4/data/blockchains/transaction/count` | GetTransactionCountBlockchainsApi | Blockchains API | Get outgoing transaction count |
| GET | `/v4/data/blockchains/transaction/history/utxos` | GetTransactionHistoryUtxosBlockchainsApi | Blockchains API | Get transaction history (UTXO) |
| POST | `/v4/data/blockchains/transaction/history/utxos/batch` | GetTransactionHistoryUtxosBatchBlockchainsApi | Blockchains API | Get transaction history (UTXO) batch |
| GET | `/v4/data/tokens` | GetTokensV4 | Token API | Get information about collection or token |
| GET | `/v4/data/tokens/trending` | GetTrendingTokensV4 | Token API | Get trending tokens |
| GET | `/v4/data/tokens/newest` | GetNewestTokensV4 | Token API | Get newest tokens |
| GET | `/v4/data/tokens/popular` | GetPopularTokensV4 | Token API | Get popular tokens |
| GET | `/v4/data/tokens/popular/history` | GetPopularTokensHistoryV4 | Token API | Get popular tokens history |
| GET | `/v4/data/transactions/dna` | GetTransfersDnaV4 | Token API | Get transactions DNA |
| GET | `/v4/data/rate/history` | getExchangeRateHistoryBySymbol | Token API | Get Exchange Rate History by Symbol |
| GET | `/v4/data/utxos` | GetUtxosByAddressV4 | Wallet API | Get unspent UTXOs for an address |
| POST | `/v4/data/utxos/batch` | GetUtxosByAddressBatchV4 | Wallet API | Get unspent UTXOs for a batch of addresses |
| GET | `/v3/security/address/{address}` | CheckMalicousAddress | Malicious address | Check malicous address |
| GET | `/v4/data/rate/symbol` | getExchangeRateBySymbol | Exchange rate | Get Exchange Rate by Symbol |
| POST | `/v4/data/rate/symbol/batch` | getExchangeRatesBySymbol | Exchange rate | Get Exchange Rate by Symbol - Batch |
| GET | `/v4/data/rate/symbol/OHLCV` | getSymbolOHLCV | Exchange rate | Get OHLCV by Symbol |
| GET | `/v4/data/rate/symbol/OHLCV/batch` | getSymbolOHLCVBatch | Exchange rate | Get OHLCV by Symbol - Batch |
| GET | `/v4/data/rate/price-change` | getPriceChange | Exchange rate | Get Price Change by Symbol |
| POST | `/v4/data/rate/price-change/batch` | getPriceChangeBatch | Exchange rate | Get Price Change by Symbol - Batch |
| GET | `/v4/data/rate/contract` | getExchangeRateByContractAddress | Exchange rate | Get Exchange Rate by Contract |
| POST | `/v4/data/rate/contract/batch` | getExchangeRatesByContractAddress | Exchange rate | Get Exchange Rate by Contract - Batch |
| GET | `/v4/data/staking/native/current-assets` | GetCurrentStakedAssetsV4 | Staking | Get current staked assets |
| GET | `/v4/data/staking/native/current-assets-by-validator` | GetCurrentStakedAssetsByValidatorV4 | Staking | Get current staked assets by validator |
| GET | `/v4/data/staking/native/rewards` | GetStakedAccountRewardsV4 | Staking | Get staked account rewards |
| POST | `/v4/data/staking/native/rewards/batch` | GetStakedAccountRewardsBatchV4 | Staking | Get staked account rewards - Batch |
| GET | `/v4/data/staking/native/transactions` | GetStakingTransactionsV4 | Staking | Get staking transactions |
| GET | `/v4/data/staking/native/pools` | GetStakingPoolsV4 | Staking | Get staking pools |
| GET | `/v4/data/staking/liquid/current-assets` | GetLiquidStakingCurrentAssetsV4 | Staking | Get liquid staking current assets |
| GET | `/v4/data/staking/liquid/pools` | GetLiquidStakingPoolsV4 | Staking | Get liquid staking pools |
| GET | `/v4/data/mining/rewards` | GetMiningRewardsV4 | Mining API | Get mining rewards |
| GET | `/v4/data/mining/totalRewards` | GetTotalMiningRewardsV4 | Mining API | Get total mining rewards |
| POST | `/v4/blockchainOperations/gas` | estimateGas | Fee Estimation API | Estimate gas for a transfer |
| GET | `/v3/blockchain/fee/{chain}` | getBlockchainFee | Fee Estimation API | Get recommended base fee for a chain |
| POST | `/v3/blockchain/estimate` | EstimateFeeBlockchain | Fee Estimation API | Estimate gas for a transaction |
| POST | `/v3/ethereum/gas/batch` | EthEstimateGasBatch | Fee Estimation API | Estimate the fee for multiple Ethereum transactions |
| POST | `/v3/xdc/gas` | XdcEstimateGas | Fee Estimation API | Estimate the fee for a XinFin transaction |
| POST | `/v3/vet/transaction/gas` | VetEstimateGas | Fee Estimation API | Estimate the gas needed for a VeChain transaction |
| GET | `/v4/data/marketplace/cryptoslam/token/trending` | GetCryptoslamTrendingTokens | Marketplace | Get trending tokens from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/token/price` | GetCryptoslamTokenPrice | Marketplace | Get token prices from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/token/price/history` | GetCryptoslamTokenPriceHistory | Marketplace | Get token price history from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/token/price/exotic` | GetCryptoslamTokenPriceExotic | Marketplace | Get exotic token prices from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/token/price/exotic/history` | GetCryptoslamTokenPriceExoticHistory | Marketplace | Get exotic token price history from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/token/trades` | GetCryptoslamTokenTrades | Marketplace | Get token trades from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/token/transfers` | GetCryptoslamTokenTransfers | Marketplace | Get token transfers from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/token/transfers/dna` | GetCryptoslamTokenTransfersDna | Marketplace | Get token transfers with DNA from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/token/holder/reputation` | GetCryptoslamTokenHolderReputation | Marketplace | Get token holder reputation from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/chain/trades` | GetCryptoslamChainTrades | Marketplace | Get chain trades from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/chain/trades/dna` | GetCryptoslamChainTradesDna | Marketplace | Get chain trades DNA from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/chain/transfers` | GetCryptoslamChainTransfers | Marketplace | Get chain transfers from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/chain/transfers/dna` | GetCryptoslamChainTransfersDna | Marketplace | Get chain transfers DNA from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/wallet/trades` | GetCryptoslamWalletTrades | Marketplace | Get wallet trades from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/wallet/trades/dna` | GetCryptoslamWalletTradesDna | Marketplace | Get wallet trades DNA from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/wallet/transfers` | GetCryptoslamWalletTransfers | Marketplace | Get wallet transfers from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/wallet/transfers/dna` | GetCryptoslamWalletTransfersDna | Marketplace | Get wallet transfers DNA from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/pair/trades` | GetCryptoslamPairTrades | Marketplace | Get pair trades from Cryptoslam |
| GET | `/v4/data/marketplace/cryptoslam/pair/trades/dna` | GetCryptoslamPairTradesDna | Marketplace | Get pair trades DNA from Cryptoslam |
| POST | `/v4/data/storage/upload` | StorageUpload | Storage API | Upload a file to Walrus storage |
| GET | `/v4/data/storage/uploads` | StorageListUploads | Storage API | List Walrus storage uploads |
| GET | `/v4/data/storage/upload/{jobId}` | StorageGetUploadStatus | Storage API | Get Walrus storage upload status |
| DELETE | `/v4/data/storage/upload/{jobId}` | StorageCancelRenewal | Storage API | Cancel Walrus storage renewal |
| GET | `/v4/data/prediction/events` | GetPredictionEventsV4 | Prediction API | List prediction-market events |
| GET | `/v4/data/prediction/events/{id}` | GetPredictionEventByIdV4 | Prediction API | Get a prediction-market event by ID |
| GET | `/v4/data/prediction/markets` | GetPredictionMarketsV4 | Prediction API | List prediction markets |
| GET | `/v4/data/prediction/markets/{id}` | GetPredictionMarketByIdV4 | Prediction API | Get a prediction market by ID |
| GET | `/v4/data/prediction/markets/{id}/price` | GetPredictionMarketPriceV4 | Prediction API | Get current market price |
| GET | `/v4/data/prediction/markets/{id}/orderbook` | GetPredictionMarketOrderbookV4 | Prediction API | Get current market orderbook |
| GET | `/v4/data/prediction/markets/{id}/history` | GetPredictionMarketPriceHistoryV4 | Prediction API | Get market price history |
| GET | `/v4/data/prediction/markets/{id}/trades` | GetPredictionMarketTradesV4 | Prediction API | Get recent market trades |
| GET | `/v4/data/prediction/markets/{id}/positions` | GetPredictionMarketPositionsV4 | Prediction API | Get top holders of a market |
| GET | `/v4/data/prediction/wallets/{address}/portfolio` | GetPredictionWalletPortfolioV4 | Prediction API | Get wallet portfolio summary |
| GET | `/v4/data/prediction/wallets/{address}/positions` | GetPredictionWalletPositionsV4 | Prediction API | Get wallet open positions |
| GET | `/v4/data/prediction/wallets/{address}/history` | GetPredictionWalletHistoryV4 | Prediction API | Get wallet closed positions |
| GET | `/v4/data/prediction/wallets/{address}/trades` | GetPredictionWalletTradesV4 | Prediction API | Get wallet trade history |
| GET | `/v4/data/prediction/wallets/{address}/activity` | GetPredictionWalletActivityV4 | Prediction API | Get wallet activity feed |
| GET | `/v4/data/prediction/wallets/{address}/value` | GetPredictionWalletValueV4 | Prediction API | Get wallet open-position notional |
| GET | `/v4/data/prediction/wallets/{address}/markets-traded` | GetPredictionWalletMarketsTradedV4 | Prediction API | Get wallet markets-traded count |
| GET | `/v4/data/prediction/top-traders` | GetPredictionTopTradersV4 | Prediction API | Get top traders leaderboard |
| GET | `/v4/data/prediction/search` | GetPredictionSearchV4 | Prediction API | Unified search (events / tags / profiles) |

## Blockchain Notifications - operations

- Tags: Notifications, Subscriptions, Templates
- Source: <https://docs.tatum.io/openapi/notifications-1.json>

| method | path | operationId | tags | summary |
| --- | --- | --- | --- | --- |
| GET | `/v4/subscription` | getSubscriptionsV4 | Subscriptions | List all active subscriptions |
| POST | `/v4/subscription` | createSubscriptionV4 | Subscriptions | Create a subscription |
| PUT | `/v4/subscription` | enableWebHookHmac | Notifications | Enable HMAC webhook digest |
| DELETE | `/v4/subscription` | disableWebHookHmac | Notifications | Disable HMAC webhook digest |
| GET | `/v4/subscription/count` | getSubscriptionsCount | Subscriptions | Count of subscriptions |
| GET | `/v4/subscription/{id}` | getSubscriptionV4 | Subscriptions | Get subscription by ID |
| PUT | `/v4/subscription/{id}` | updateSubscription | Subscriptions | Update subscription |
| DELETE | `/v4/subscription/{id}` | deleteSubscription | Subscriptions | Cancel existing subscription |
| PUT | `/v4/subscription/batch` | updateSubscriptionsByChain | Subscriptions | Update subscriptions by chain |
| GET | `/v4/subscription/webhook` | getAllWebhooksV4 | Notifications | List all executed webhooks |
| GET | `/v4/subscription/webhook/count` | getAllWebhooksCount | Notifications | Count of found entities for get webhook request |
| POST | `/v4/subscription/webhook/{id}/retry` | retryWebhookV4 | Notifications | Retry a failed webhook |
| GET | `/v4/subscription/template` | getNotificationTemplates | Templates | List all notification templates (V4) |
| POST | `/v4/subscription/template` | createNotificationTemplate | Templates | Create a notification template (V4) |
| GET | `/v4/subscription/template/default` | getDefaultNotificationTemplate | Templates | Get the default notification template |
| PUT | `/v4/subscription/template/default` | updateDefaultNotificationTemplate | Templates | Update the default notification template |
| PUT | `/v4/subscription/template/{id}` | updateNotificationTemplate | Templates | Update notification template (V4) |
| DELETE | `/v4/subscription/template/{id}` | deleteNotificationTemplate | Templates | Delete notification template (V4) |
| POST | `/v3/subscription` | createSubscription | Subscriptions | Create a subscription |

## Machine-readable

- Index: `/api/openapi-index` - <https://ai.tatum.io/api/openapi-index>
- Raw schema: `/openapi/blockchain-data.json` - <https://ai.tatum.io/openapi/blockchain-data.json>
- Raw schema: `/openapi/notifications.json` - <https://ai.tatum.io/openapi/notifications.json>
