{ "openapi": "3.0.3", "servers": [ { "url": "https://rest.cryptoapis.io", "description": "REST API" } ], "components": { "securitySchemes": { "ApiKey": { "name": "x-api-key", "description": "API Key", "type": "apiKey", "in": "header" } }, "schemas": { "SyncHDWalletXPubYPubZPubRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": {} } }, "required": [ "item" ] } }, "required": [ "data" ] }, "ActivateHDWalletXPubYPubZPubRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": {} } }, "required": [ "item" ] } }, "required": [ "data" ] }, "NewUnconfirmedCoinsTransactionsRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address of the transaction, per which the result is returned.", "example": "mho4jHBcrNCncKt38trJahXakuaBnS7LK5" }, "allowDuplicates": { "type": "boolean", "description": "Specifies a flag that permits or denies the creation of duplicate addresses.", "example": false, "default": false }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs 2.0. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2021-03-20-111/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" } }, "required": [ "address", "callbackUrl" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "NewConfirmedCoinsTransactionsRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address of the transaction, per which the result is returned.", "example": "mho4jHBcrNCncKt38trJahXakuaBnS7LK5" }, "allowDuplicates": { "type": "boolean", "description": "Specifies a flag that permits or denies the creation of duplicate addresses.", "example": false, "default": false }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "receiveCallbackOn": { "type": "integer", "description": "Represents the exact confirmation, on which the user wants to receive callback.", "example": 3 } }, "required": [ "address", "callbackUrl" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "NewConfirmedTokensTransactionsRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address of the transaction, per which the result is returned.", "example": "0x6890303Cfca4f2571c3A5A5982b44c0Ca82b124A" }, "allowDuplicates": { "type": "boolean", "description": "Specifies a flag that permits or denies the creation of duplicate addresses.", "example": false, "default": false }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "receiveCallbackOn": { "type": "integer", "description": "Defines the exact confirmation, on which user can receive a callback.", "example": 3 } }, "required": [ "address", "callbackUrl" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "NewConfirmedTokensTransactionsAndEachConfirmationRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address of the transaction, per which the result is returned.", "example": "0x033ef6db9fbd0ee60e2931906b987fe0280471a0" }, "allowDuplicates": { "type": "boolean", "description": "Specifies a flag that permits or denies the creation of duplicate addresses.", "example": false, "default": false }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "confirmationsCount": { "type": "integer", "description": "Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.", "example": 3 } }, "required": [ "address", "callbackUrl" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "NewConfirmedCoinsTransactionsAndEachConfirmationRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address of the transaction, per which the result is returned.", "example": "mho4jHBcrNCncKt38trJahXakuaBnS7LK5" }, "allowDuplicates": { "type": "boolean", "description": "Specifies a flag that permits or denies the creation of duplicate addresses.", "example": false, "default": false }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "confirmationsCount": { "type": "integer", "description": "Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.", "example": 3 } }, "required": [ "address", "callbackUrl", "confirmationsCount" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "NewBlockRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "allowDuplicates": { "type": "boolean", "description": "Specifies a flag that permits or denies the creation of duplicate addresses.", "example": false, "default": false }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" } }, "required": [ "callbackUrl" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "ActivateBlockchainEventSubscriptionRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": {} } }, "required": [ "item" ] } }, "required": [ "data" ] }, "NewConfirmedInternalTransactionsRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "address": { "type": "string", "description": "Defines the specific address of the internal transaction.", "example": "0xbcc817f057950b0df41206c5d7125e6225cae18e" }, "allowDuplicates": { "type": "boolean", "description": "Flag that permits or denies creation of duplicates", "example": false, "default": false }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2021-03-20-111/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "receiveCallbackOn": { "type": "integer", "description": "Represents the exact confirmation, on which the user wants to receive callback.", "example": 3 } }, "required": [ "address", "callbackUrl" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "NewConfirmedInternalTransactionsAndEachConfirmationRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "address": { "type": "string", "description": "Defines the specific address of the internal transaction.", "example": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2" }, "allowDuplicates": { "type": "boolean", "description": "Specifies a flag that permits or denies the creation of duplicate addresses.", "example": false, "default": false }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2021-03-20-111/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretString" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "confirmationsCount": { "type": "integer", "description": "Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.", "example": 3 } }, "required": [ "address", "allowDuplicates", "callbackSecretKey", "callbackUrl", "confirmationsCount" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "ListSupportedAssetsRISC": { "type": "object", "properties": { "1HourPriceChangeInPercentage": { "type": "string", "description": "Represents the percentage of the asset's current price against the its price from 1 hour ago.", "example": "-0.4277852328344024" }, "1WeekPriceChangeInPercentage": { "type": "string", "description": "Represents the percentage of the asset's current price against the its price from 1 week ago.", "example": "1.6572304104646762" }, "24HoursPriceChangeInPercentage": { "type": "string", "description": "Represents the percentage of the asset's current price against the its price from 24 hours ago.", "example": "-0.059688916478600924" }, "24HoursTradingVolume": { "type": "string", "description": "Represents the trading volume of the asset for the time frame of 24 hours.", "example": "3116834672.508857" }, "circulatingSupply": { "type": "string", "description": "Represents the amount of the asset that is circulating on the market and in public hands.", "example": "18562881" }, "marketCapInUSD": { "type": "string", "description": "Defines the total market value of the asset's circulating supply in USD.", "example": "1146119021006.8835" }, "maxSupply": { "type": "string", "description": "Represents the maximum amount of all coins of a specific asset that will ever exist in its lifetime.", "example": "21000000" }, "type": { "type": "string", "description": "Represent a subtype of the crypto assets. Could be COIN or TOKEN.", "example": "coin", "enum": [ "coin", "token" ] } }, "description": "Crypto Type Data", "required": [ "1HourPriceChangeInPercentage", "1WeekPriceChangeInPercentage", "24HoursPriceChangeInPercentage", "24HoursTradingVolume", "circulatingSupply", "marketCapInUSD", "maxSupply", "type" ] }, "ListSupportedAssetsRIS": { "type": "object", "description": "Represents a specific asset's data depending on its type (whether it is \"crypto\" or \"fiat\").", "oneOf": [ { "$ref": "#/components/schemas/ListSupportedAssetsRISC" } ] }, "SyncAddressRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "address": { "type": "string", "example": "0x3d0b25fe09e2cd92f06ba776391a122519936e90" }, "callbackUrl": { "type": "string", "example": "https://example.com" } }, "required": [ "address" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "GetAssetDetailsByAssetIDRISC": { "type": "object", "properties": { "1HourPriceChangeInPercentage": { "type": "string", "description": "Represents the percentage of the asset's current price against the its price from 1 hour ago.", "example": "-0.4277852328344024" }, "1WeekPriceChangeInPercentage": { "type": "string", "description": "Represents the percentage of the asset's current price against the its price from 1 week ago.", "example": "1.6572304104646762" }, "24HoursPriceChangeInPercentage": { "type": "string", "description": "Represents the percentage of the asset's current price against the its price from 24 hours ago.", "example": "-0.059688916478600924" }, "24HoursTradingVolume": { "type": "string", "description": "Represents the trading volume of the asset for the time frame of 24 hours.", "example": "3116834672.508857" }, "circulatingSupply": { "type": "string", "description": "Represents the amount of the asset that is circulating on the market and in public hands.", "example": "18562881" }, "marketCapInUSD": { "type": "string", "description": "Defines the total market value of the asset's circulating supply in USD.", "example": "1146119021006.8835" }, "maxSupply": { "type": "string", "description": "Represents the maximum amount of all coins of a specific asset that will ever exist in its lifetime.", "example": "21000000" }, "type": { "type": "string", "description": "Represent a subtype of the crypto assets. Could be COIN or TOKEN.", "example": "coin", "enum": [ "coin", "token" ] } }, "description": "Crypto Type Data", "required": [ "1HourPriceChangeInPercentage", "1WeekPriceChangeInPercentage", "24HoursPriceChangeInPercentage", "24HoursTradingVolume", "circulatingSupply", "marketCapInUSD", "maxSupply", "type" ] }, "GetAssetDetailsByAssetIDRIS": { "type": "object", "description": "Represents a specific asset's data depending on its type (whether it is \"crypto\" or \"fiat\").", "oneOf": [ { "$ref": "#/components/schemas/GetAssetDetailsByAssetIDRISC" } ] }, "GetAssetDetailsByAssetSymbolRISC": { "type": "object", "properties": { "1HourPriceChangeInPercentage": { "type": "string", "description": "Represents the percentage of the asset's current price against the its price from 1 hour ago.", "example": "-0.4277852328344024" }, "1WeekPriceChangeInPercentage": { "type": "string", "description": "Represents the percentage of the asset's current price against the its price from 1 week ago.", "example": "1.6572304104646762" }, "24HoursPriceChangeInPercentage": { "type": "string", "description": "Represents the percentage of the asset's current price against the its price from 24 hours ago.", "example": "-0.059688916478600924" }, "24HoursTradingVolume": { "type": "string", "description": "Represents the trading volume of the asset for the time frame of 24 hours.", "example": "3116834672.508857" }, "circulatingSupply": { "type": "string", "description": "Represents the amount of the asset that is circulating on the market and in public hands.", "example": "18562881" }, "marketCapInUSD": { "type": "string", "description": "Defines the total market value of the asset's circulating supply in USD.", "example": "1146119021006.8835" }, "maxSupply": { "type": "string", "description": "Represents the maximum amount of all coins of a specific asset that will ever exist in its lifetime.", "example": "21000000" }, "type": { "type": "string", "description": "Defines the type of the supported asset. This could be either \"crypto\" or \"fiat\".", "example": "coin", "enum": [ "coin", "token" ] } }, "description": "Crypto Type Data", "required": [ "1HourPriceChangeInPercentage", "1WeekPriceChangeInPercentage", "24HoursPriceChangeInPercentage", "24HoursTradingVolume", "circulatingSupply", "marketCapInUSD", "maxSupply", "type" ] }, "GetAssetDetailsByAssetSymbolRIS": { "type": "object", "description": "Represents a specific asset's data depending on its type (whether it is \"crypto\" or \"fiat\").", "oneOf": [ { "$ref": "#/components/schemas/GetAssetDetailsByAssetSymbolRISC" } ] }, "ActivateSyncedAddressRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": {} } }, "required": [ "item" ] } }, "required": [ "data" ] }, "SimulateEthereumTransactionsRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount being transferred in ETH", "example": "0.123" }, "gasLimit": { "type": "integer", "description": "String representation of the gas limit for the transactions", "example": 84000 }, "gasPrice": { "type": "string", "description": "String representation of the gas price for LEGACY transactions in WEI", "example": "47125353" }, "inputData": { "type": "string", "description": "String representation of hex data for contract interactions", "example": "0xa9059cbb000000000000000000000000392214d9de6aaafe32f8ce1e166c2b3ac8ce04c700000000000000000000000000000000000000000000000000000000000001F4" }, "maxFeePerGas": { "type": "string", "description": "String representation of the max fee per gas for EIP-1559 transactions in WEI", "example": "60000000000" }, "maxPriorityFeePerGas": { "type": "string", "description": "String representation of the max priority fee for EIP-1559 transactions in WEI", "example": "1000000000" }, "recipient": { "type": "string", "description": "String representation of the to address", "example": "0xc01efdde68290f5a107c9ede6ce3200bba47d375" }, "sender": { "type": "string", "description": "String representation of the from address", "example": "0xc01efdde68290f5a107c9ede6ce3200bba47d375" } }, "required": [ "amount", "gasLimit", "recipient", "sender" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "ConvertBitcoinCashAddressRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "bchtest:qpcgz3zt5zp5dj7vd9ms24xquamncvhnxvlz97eee8" } }, "required": [ "address" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "PrepareATransactionFromAnAddressInHDWalletXPubYPubZPubEVMRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "additionalData": { "type": "string", "description": "Representation of the additional data.", "example": "yourAdditionalDataHere" }, "amount": { "type": "string", "description": "Representation of the amount of the transaction", "example": "0.000003" }, "nonce": { "type": "string", "description": "Representation of the nonce value", "example": "0" }, "recipient": { "type": "string", "description": "Represents a list of recipient addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.", "example": "0x041c594a0cc194e826bef5411b29c7f27001b7e3" }, "sender": { "type": "string", "description": "Represents a sender address with the respective amount. In account-based protocols like Ethereum there is only one address in this list.", "example": "0x03654A9E78771442CAdf8DB37ae60D6a12bAEa9f" }, "fee": { "type": "object", "description": "When isConfirmed is True - Defines the amount of the transaction fee When isConfirmed is False - For ETH-based blockchains this attribute represents the max fee value.", "properties": { "exactAmount": { "type": "string", "description": "Representation of the exact amount value", "example": "0.00045" }, "priority": { "type": "string", "description": "Represents the fee priority", "example": "standard", "enum": [ "slow", "standard", "fast" ] } } }, "transactionType": { "type": "string", "description": "Representation of the transaction type", "example": "legacy-transaction", "default": "gas-fee-market-transaction", "enum": [ "legacy-transaction", "access-list-transaction", "gas-fee-market-transaction" ] } }, "required": [ "amount", "recipient", "sender", "fee" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "DeriveAndSyncNewChangeAddressesUTXORB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": {} } }, "required": [ "item" ] } }, "required": [ "data" ] }, "DeriveAndSyncNewReceivingAddressesEVMRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": {} } }, "required": [ "item" ] } }, "required": [ "data" ] }, "DecodeRawTransactionHexEVMRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "rawTransactionHex": { "type": "string", "description": "Represents the raw transaction Hex that has to be decoded.", "example": "0100000001f3f6a909f8521adb57d898d2985834e632374e770fd9e2b98656f1bf1fdfd427010000006b48304502203a776322ebf8eb8b58cc6ced4f2574f4c73aa664edce0b0022690f2f6f47c521022100b82353305988cb0ebd443089a173ceec93fe4dbfe98d74419ecc84a6a698e31d012103c5c1bc61f60ce3d6223a63cedbece03b12ef9f0068f2f3c4a7e7f06c523c3664ffffffff0260e31600000000001976a914977ae6e32349b99b72196cb62b5ef37329ed81b488ac063d1000000000001976a914f76bc4190f3d8e2315e5c11c59cfc8be9df747e388ac00000000" } }, "required": [ "rawTransactionHex" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "EstimateNativeCoinTransferGasLimitEVMRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "additionalData": { "type": "string", "description": "Represents an optional field to add additonal data.", "example": "yourAdditionalString" }, "amount": { "type": "string", "description": "Represents transactions' amount.", "example": "0.002" }, "recipient": { "type": "string", "description": "The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.", "example": "0xc065b539490f81b6c297c37b1925c3be2f190738" }, "sender": { "type": "string", "description": "Represents the address which sends this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one sender.", "example": "0x6f61e3c2fbb8c8be698bd0907ba6c04b62800fe5" } }, "required": [ "amount", "recipient", "sender" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "ValidateAddressUTXORB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the specific address that will be checked if it's valid or not.", "example": "bc1qa2n5l96vh9df4zq7g3epvx3en3647zgchc4np3" } }, "required": [ "address" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "PrepareANonFungibleTokenTransferFromAddressEVMRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "contract": { "type": "string", "description": "Represents the contract address of the token, which controls its logic. It is not the address that holds the tokens.", "example": "0x5668213c59ab2612ecd948f98371d1d291098b5e" }, "nonce": { "type": "string", "description": "Represents the sequential running number for an address, starting from 0 for the first transaction. E.g., if the nonce of a transaction is 10, it would be the 11th transaction sent from the sender's address.", "example": "1" }, "recipient": { "type": "string", "description": "The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, "sender": { "type": "string", "description": "Represents the address which sends this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one sende", "example": "0xc6d46aba0c6e2eb6358c4e24804158cc4d847922" }, "tokenId": { "type": "string", "description": "Represents the unique token identifier.", "example": "14" }, "fee": { "type": "object", "description": "Defines the amount of the transaction fee.", "properties": { "exactAmount": { "type": "string", "description": "Representation of the exact amount to be transfered.", "example": "0.00045" }, "priority": { "type": "string", "description": "Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\".", "example": "standard", "enum": [ "slow", "standard", "fast" ] } }, "required": [ "priority", "priority" ] }, "type": { "type": "string", "description": "Representation of the transaction type. For Ethereum-Classic and Binance Smart Chain there is no need to provide \"type\" in the request.", "example": "access-list-transaction", "enum": [ "legacy-transaction", "access-list-transaction", "gas-fee-market-transaction" ] } }, "required": [ "contract", "recipient", "sender", "tokenId", "fee" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "EstimateTokenTransferGasLimitEVMRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents transactions' amount.", "example": "0.12" }, "contract": { "type": "string", "description": "Defines the specific token identifier. For Ethereum-based transactions it is the contract.", "example": "0x092de782a7e1e0a92991ad829a0a33aef3c7545e" }, "contractType": { "type": "string", "description": "Represents the ERC contract type. It can be ERC20 or ERC721", "example": "ERC-20" }, "recipient": { "type": "string", "description": "The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.", "example": "0xc065b539490f81b6c297c37b1925c3be2f190738" }, "sender": { "type": "string", "description": "Represents the address which sends this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one sender.", "example": "0x6f61e3c2fbb8c8be698bd0907ba6c04b62800fe5" } }, "required": [ "amount", "contract", "contractType", "recipient", "sender" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "DeriveAndSyncNewReceivingAddressesXRPRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": {} } }, "required": [ "item" ] } }, "required": [ "data" ] }, "DeriveAndSyncNewReceivingAddressesUTXORB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": {} } }, "required": [ "item" ] } }, "required": [ "data" ] }, "PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "additionalData": { "type": "string", "description": "Representation of the additional data.", "example": "yourAdditionalDataHere" }, "locktime": { "type": "integer", "description": "Represents the time at which a particular transaction can be added to the blockchain.", "example": 1659001055 }, "fee": { "type": "object", "description": "When isConfirmed is True - Defines the amount of the transaction fee When isConfirmed is False - For ETH-based blockchains this attribute represents the max fee value.", "properties": { "address": { "type": "string", "description": "Representation of the address", "example": "tmG2WnrxrpfXxPf5Phk6yPZffqQhezhcUsz" }, "exactAmount": { "type": "string", "description": "Representation of the exact amount", "example": "0.00458" }, "priority": { "type": "string", "description": "Representation of the fee priority", "example": "standard", "enum": [ "slow", "standard", "fast" ] } } }, "prepareStrategy": { "type": "string", "description": "Representation of the transaction's strategy type", "example": "minimize-dust", "enum": [ "none", "minimize-dust", "optimize-size" ] }, "recipients": { "type": "array", "description": "Object Array representation of transaction receivers", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Representation of the receiver address", "example": "tmHb1bHWAvK6hHDZEq57cbEz2wgxYEMqdbd" }, "amount": { "type": "string", "description": "Representation of the amount", "example": "0.00458" } }, "required": [ "address", "amount" ] } }, "replaceable": { "type": "boolean", "description": "Representation of whether the transaction is replaceable. This is an Optional attribute that is not supported for Dogecoin, Dash and Bitcoin-Cash.", "example": true } }, "required": [ "fee", "recipients" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "EstimateContractInteractionGasLimitEVMRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents transactions' amount. Should be 0 for non-payable functions.", "example": "0.12" }, "inputData": { "type": "string", "description": "ABI encoded value hex value of function name and parameters, e.g. \"balanceOf(0x66a9893cc07d91d95644aedd05d03f95e1dba8af)\" should be represented as \"0x70a0823100000000000000000000000066a9893cc07d91d95644aedd05d03f95e1dba8af\"", "example": "0x70a0823100000000000000000000000066a9893cc07d91d95644aedd05d03f95e1dba8af" }, "recipient": { "type": "string", "description": "Represents the address which receives this transaction.", "example": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831" }, "sender": { "type": "string", "description": "Represents the address which sends this transaction.", "example": "0x4337006f33e2940FcbEbD899bF2396117E65dF9B" } }, "required": [ "amount", "inputData", "recipient", "sender" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "ValidateAddressEVMRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the specific address that will be checked if it's valid or not.", "example": "mho4jHBcrNCncKt38trJahXakuaBnS7LK5" } }, "required": [ "address" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "ValidateAddressXRPRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the specific address that will be checked if it's valid or not.", "example": "rGuhZqkVANWyHQUSWQzCLPKnho9gzVUPng" } }, "required": [ "address" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "BroadcastLocallySignedTransactionRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://developers.cryptoapis.io/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretString" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "signedTransactionHex": { "type": "string", "description": "Represents the signed transaction's specific hex.", "example": "0xf86a22827d00831e8480941b85a43e2e7f52e766ddfdfa2b901c42cb1201be8801b27f33b807c0008029a084ccbf02b27e0842fb1eda7a187a5589c3759be0e969e0ca989dc469a5e5e394a02e111e1156b197f1de4c1d9ba4af26e50665ea6d617d05b3e4047da12b915e69" } }, "required": [ "signedTransactionHex" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "DecodeRawTransactionHexUTXORB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "rawTransactionHex": { "type": "string", "example": "0100000001f3f6a909f8521adb57d898d2985834e632374e770fd9e2b98656f1bf1fdfd427010000006b48304502203a776322ebf8eb8b58cc6ced4f2574f4c73aa664edce0b0022690f2f6f47c521022100b82353305988cb0ebd443089a173ceec93fe4dbfe98d74419ecc84a6a698e31d012103c5c1bc61f60ce3d6223a63cedbece03b12ef9f0068f2f3c4a7e7f06c523c3664ffffffff0260e31600000000001976a914977ae6e32349b99b72196cb62b5ef37329ed81b488ac063d1000000000001976a914f76bc4190f3d8e2315e5c11c59cfc8be9df747e388ac00000000" } }, "required": [ "rawTransactionHex" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "PrepareTransactionFromAddressEVMRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "additionalData": { "type": "string", "description": "Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request.", "example": "yourAdditionalStriingHere" }, "amount": { "type": "string", "description": "Representation of the transacted amount", "example": "2000000009340" }, "nonce": { "type": "string", "description": "Represents the sequential running number for an address, starting from 0 for the first transaction. E.g., if the nonce of a transaction is 10, it would be the 11th transaction sent from the sender's address.", "example": "0" }, "recipient": { "type": "string", "description": "The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, "sender": { "type": "string", "description": "Represents the address which sends this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one sender.", "example": "0x1d107b75353229768dff96051262ce0088a3e26b" }, "fee": { "type": "object", "description": "Defines the amount of the transaction fee.", "properties": { "exactAmount": { "type": "string", "description": "Representation of the exact amount", "example": "0.00001" }, "priority": { "type": "string", "description": "Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\"", "example": "standard", "enum": [ "slow", "standard", "fast" ] }, "substractFromAmount": { "type": "boolean", "description": "Boolean representation of the subtract from amount", "example": true } }, "required": [ "priority", "priority" ] }, "type": { "type": "string", "description": "Representation of the transaction type. For Ethereum-Classic and Binance Smart Chain there is no need to provide \"transactionType\" in the request.", "example": "access-list-transaction", "default": "gas-fee-market-transaction", "enum": [ "legacy-transaction", "access-list-transaction", "gas-fee-market-transaction" ] } }, "required": [ "amount", "recipient", "sender", "fee" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "PrepareAFungibleTokenTransferFromAddressEVMRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "amount": { "type": "string", "description": "Representation of the amount to be transferred", "example": "1.09340" }, "contract": { "type": "string", "description": "Represents the contract address of the token, which controls its logic. It is not the address that holds the tokens.", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7" }, "nonce": { "type": "string", "description": "Represents the sequential running number for an address, starting from 0 for the first transaction. E.g., if the nonce of a transaction is 10, it would be the 11th transaction sent from the sender's address.", "example": "0" }, "recipient": { "type": "string", "description": "The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.", "example": "0x534bd102153ef199abae8296a2fae4599fc44cdc" }, "sender": { "type": "string", "description": "Represents the address which sends this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one sender.", "example": "0x1d107b75353229768dff96051262ce0088a3e26b" }, "fee": { "type": "object", "description": "Defines the amount of the transaction fee.", "properties": { "exactAmount": { "type": "string", "description": "Representation of the exact amount to be transfered.", "example": "0.00045" }, "priority": { "type": "string", "description": "Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\".", "example": "standard", "enum": [ "slow", "standard", "fast" ] } }, "required": [ "exactAmount", "priority", "priority", "priority" ] }, "type": { "type": "string", "description": "Representation of the transaction type. For Ethereum-Classic and Binance Smart Chain there is no need to provide \"type\" in the request.", "example": "access-list-transaction", "enum": [ "legacy-transaction", "access-list-transaction", "gas-fee-market-transaction" ] } }, "required": [ "amount", "contract", "recipient", "sender", "fee" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "SyncHDWalletXPubYPubZPubRI": { "type": "object", "properties": { "extendedPublicKey": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" } }, "required": [ "extendedPublicKey" ] }, "SyncHDWalletXPubYPubZPubR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/SyncHDWalletXPubYPubZPubRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "BannedIpAddress": { "type": "object", "description": "banned_ip_address", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "banned_ip_address" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "This IP address has been banned. To check the reason for that, please contact our team via email." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "UriNotFound": { "type": "object", "description": "uri_not_found", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "uri_not_found" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The specified URI has not been found. Check the URI and try again." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "UnexpectedServerError": { "type": "object", "description": "unexpected_server_error", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "unexpected_server_error" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "MissingApiKey": { "type": "object", "description": "missing_api_key", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "missing_api_key" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "UnsupportedMediaType": { "type": "object", "description": "unsupported_media_type", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "unsupported_media_type" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "RequestLimitReached": { "type": "object", "description": "request_limit_reached", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "request_limit_reached" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "InvalidApiKey": { "type": "object", "description": "invalid_api_key", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "invalid_api_key" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The provided API key is invalid. Please, generate a new one from your Dashboard." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "SyncHDWalletXPubYPubZPubE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "InsufficientCredits": { "type": "object", "description": "insufficient_credits", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "insufficient_credits" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "InvalidData": { "type": "object", "description": "invalid_data", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "invalid_data" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The data provided seems to be invalid." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "LimitGreaterThanAllowed": { "type": "object", "description": "limit_greater_than_allowed", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "limit_greater_than_allowed" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "SyncHDWalletXPubYPubZPubE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidBlockchain" }, { "$ref": "#/components/schemas/InvalidNetwork" }, { "$ref": "#/components/schemas/XpubNotSynced" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "InvalidPagination": { "type": "object", "description": "invalid_pagination", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "invalid_pagination" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "EndpointNotAllowedForPlan": { "type": "object", "description": "endpoint_not_allowed_for_plan", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "endpoint_not_allowed_for_plan" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "SyncHDWalletXPubYPubZPubE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "EndpointNotAllowedForApiKey": { "type": "object", "description": "endpoint_not_allowed_for_api_key", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "endpoint_not_allowed_for_api_key" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "This endpoint is not available for your API key." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "FeatureMainnetsNotAllowedForPlan": { "type": "object", "description": "feature_mainnets_not_allowed_for_plan", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "feature_mainnets_not_allowed_for_plan" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "InvalidRequestBodyStructure": { "type": "object", "description": "invalid_request_body_structure", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "invalid_request_body_structure" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }" }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "InvalidBlockchain": { "type": "object", "description": "invalid_blockchain", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "invalid_blockchain" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The provided blockchain is invalid. The blockchain **must** be a supported one. For the full list of supported blockchains please see our Documentation." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "InvalidNetwork": { "type": "object", "description": "invalid_network", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "invalid_network" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The provided network is invalid. The network **must** be a supported one. For the full list of supported networks please see our Documentation." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "XpubNotSynced": { "type": "object", "description": "xpub_not_synced", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "xpub_not_synced" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "This xPub is not yet synced, please first use endpoint “Sync HD (xPub, yPub, zPub) wallet” to synchronize it." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "XpubSyncInProgress": { "type": "object", "description": "xpub_sync_in_progress", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "xpub_sync_in_progress" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Your wallet (xPub, yPub, zPub) is still syncing, it should take few seconds depending on how many transactions it has." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "SyncHDWalletXPubYPubZPubE422": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestBodyStructure" }, { "$ref": "#/components/schemas/XpubSyncInProgress" } ] }, "AlreadyExists": { "type": "object", "description": "already_exists", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "already_exists" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The specified resource already exists." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "SyncHDWalletXPubYPubZPubE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/AlreadyExists" } ] }, "InvalidXpub": { "type": "object", "description": "invalid_xpub", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "invalid_xpub" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The provided Xpub is invalid." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "ListSyncedHDWalletsXPubYPubZPubRI": { "type": "object", "properties": { "extendedPublicKey": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub6C25R29GcNuxTsDMDmkfBXi2eqg6PyAJtSX8EVMK7scsSVrLfHCLK3LtR3GvAgoGe8vJF7R85BbTxGsSSertPTXzJy2EyJWhHvWTrJmZpHa" }, "isActive": { "type": "boolean", "description": "Defines the activation status of the hd wallet - if it is active or not.", "example": true }, "syncStatus": { "type": "string", "description": "Defines the sync status of the hd wallet - if it is synced or not.", "example": "DONE" } }, "required": [ "extendedPublicKey", "isActive", "syncStatus" ] }, "ListSyncedHDWalletsXPubYPubZPubR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListSyncedHDWalletsXPubYPubZPubRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListSyncedHDWalletsXPubYPubZPubE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListSyncedHDWalletsXPubYPubZPubE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidBlockchain" }, { "$ref": "#/components/schemas/InvalidNetwork" } ] }, "ListSyncedHDWalletsXPubYPubZPubE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetHDWalletStatusXPubYPubZPubRI": { "type": "object", "properties": { "extendedPublicKey": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, "isActive": { "type": "boolean", "description": "Defines the activation status of the hd wallet - if it is active or not.", "example": true }, "syncStatus": { "type": "string", "description": "Defines the sync status of the hd wallet - if it is synced or not.", "example": "DONE" } }, "required": [ "extendedPublicKey", "isActive", "syncStatus" ] }, "GetHDWalletStatusXPubYPubZPubR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetHDWalletStatusXPubYPubZPubRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetHDWalletStatusXPubYPubZPubE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetHDWalletStatusXPubYPubZPubE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidBlockchain" }, { "$ref": "#/components/schemas/InvalidNetwork" }, { "$ref": "#/components/schemas/XpubNotSynced" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "GetHDWalletStatusXPubYPubZPubE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ActivateHDWalletXPubYPubZPubRI": { "type": "object", "properties": { "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, "extendedPublicKey": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub6C25R29GcNuxTsDMDmkfBXi2eqg6PyAJtSX8EVMK7scsSVrLfHCLK3LtR3GvAgoGe8vJF7R85BbTxGsSSertPTXzJy2EyJWhHvWTrJmZpHa" }, "isActive": { "type": "boolean", "description": "Define the activity status of the hd wallet - if it is active or not", "example": true }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, "syncStatus": { "type": "string", "description": "Defines the sync status of the hd wallet - if it is synced or not", "example": "DONE" } }, "required": [ "blockchain", "extendedPublicKey", "isActive", "network", "syncStatus" ] }, "ActivateHDWalletXPubYPubZPubR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ActivateHDWalletXPubYPubZPubRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ActivateHDWalletXPubYPubZPubE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ActivateHDWalletXPubYPubZPubE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidBlockchain" }, { "$ref": "#/components/schemas/InvalidNetwork" }, { "$ref": "#/components/schemas/XpubNotSynced" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "ActivateHDWalletXPubYPubZPubE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/XpubsLimitReached" } ] }, "XpubsLimitReached": { "type": "object", "description": "xpubs_limit_reached", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "xpubs_limit_reached" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "You have reached the maximum Xpub count. Please, upgrade your plan in order to have a higher Xpub count." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "XpubAlreadyActive": { "type": "object", "description": "xpub_already_active", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "xpub_already_active" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "This xpub is already activated." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "ActivateHDWalletXPubYPubZPubE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/XpubAlreadyActive" } ] }, "DeleteSyncedHDWalletXPubYPubZPubRI": { "type": "object", "properties": { "extendedPublicKey": { "type": "string", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" } }, "required": [ "extendedPublicKey" ] }, "DeleteSyncedHDWalletXPubYPubZPubR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DeleteSyncedHDWalletXPubYPubZPubRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "DeleteSyncedHDWalletXPubYPubZPubE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "DeleteSyncedHDWalletXPubYPubZPubE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidBlockchain" }, { "$ref": "#/components/schemas/InvalidNetwork" }, { "$ref": "#/components/schemas/XpubNotSynced" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "DeleteSyncedHDWalletXPubYPubZPubE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/XpubIsDisabled" } ] }, "XpubIsDisabled": { "type": "object", "description": "xpub_is_disabled", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "xpub_is_disabled" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "This xpub has been deactivated." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "NewUnconfirmedCoinsTransactionsRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address of the transaction, per which the result is returned.", "example": "mho4jHBcrNCncKt38trJahXakuaBnS7LK5" }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2021-03-20-111/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "createdTimestamp": { "type": "integer", "description": "Defines the specific time/date when the subscription was created in Unix Timestamp.", "example": 1611238648 }, "eventType": { "type": "string", "description": "Defines the type of the specific event available for the customer to subscribe to for callback notification.", "example": "ADDRESS_COINS_TRANSACTION_UNCONFIRMED" }, "isActive": { "type": "boolean", "description": "Defines whether the subscription is active or not. Set as boolean.", "example": true }, "referenceId": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "bc243c86-0902-4386-b30d-e6b30fa1f2aa" } }, "required": [ "address", "callbackSecretKey", "callbackUrl", "createdTimestamp", "eventType", "isActive", "referenceId" ] }, "NewUnconfirmedCoinsTransactionsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/NewUnconfirmedCoinsTransactionsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "NewUnconfirmedCoinsTransactionsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "NewUnconfirmedCoinsTransactionsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "NewUnconfirmedCoinsTransactionsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/BlockchainEventsCallbacksLimitReached" } ] }, "NewUnconfirmedCoinsTransactionsE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/AlreadyExists" } ] }, "BlockchainEventsCallbacksLimitReached": { "type": "object", "description": "blockchain_events_callbacks_limit_reached", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "blockchain_events_callbacks_limit_reached" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "You have reached the maximum number of active Blockchain Events subscriptions which is {callbacks_limit} now. Please upgrade your plan to be get higher number of active subscriptions." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "NewConfirmedCoinsTransactionsRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address of the transaction, per which the result is returned.", "example": "mfo7jkvcoSNxpRBM7XfcseZGQf9PmmU8TZ" }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs 2.0. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "createdTimestamp": { "type": "integer", "description": "Defines the specific time/date when the subscription was created in Unix Timestamp.", "example": 1236238648 }, "eventType": { "type": "string", "description": "Defines the type of the specific event available for the customer to subscribe to for callback notification.", "example": "ADDRESS_COINS_TRANSACTION_CONFIRMED" }, "isActive": { "type": "boolean", "description": "Defines whether the subscription is active or not. Set as boolean.", "example": true }, "receiveCallbackOn": { "type": "integer", "description": "Represents the exact confirmation, on which the user wants to receive callback.", "example": 3 }, "referenceId": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "bc243c86-0902-4386-b30d-e6b30fa1f2aa" } }, "required": [ "address", "callbackSecretKey", "callbackUrl", "createdTimestamp", "eventType", "isActive", "receiveCallbackOn", "referenceId" ] }, "NewConfirmedCoinsTransactionsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/NewConfirmedCoinsTransactionsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "NewConfirmedCoinsTransactionsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "NewConfirmedCoinsTransactionsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "NewConfirmedCoinsTransactionsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/BlockchainEventsCallbacksLimitReached" } ] }, "NewConfirmedCoinsTransactionsE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/AlreadyExists" } ] }, "NewConfirmedTokensTransactionsRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address of the transaction, per which the result is returned.", "example": "0x7495fede000c8a3b77eeae09cf70fa94cd2d53f5" }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "createdTimestamp": { "type": "integer", "description": "Defines the specific time/date when the subscription was created in Unix Timestamp.", "example": 1611238648 }, "eventType": { "type": "string", "description": "Defines the type of the specific event available for the customer to subscribe to for callback notification.", "example": "ADDRESS_TOKENS_TRANSACTION_CONFIRMED" }, "isActive": { "type": "boolean", "description": "Defines whether the subscription is active or not. Set as boolean.", "example": true }, "receiveCallbackOn": { "type": "integer", "description": "Represents the exact confirmation, on which the user wants to receive callback.", "example": 3 }, "referenceId": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "c748624f-1843-4738-a7de-8258ada0f524" } }, "required": [ "address", "callbackSecretKey", "callbackUrl", "createdTimestamp", "eventType", "isActive", "referenceId" ] }, "NewConfirmedTokensTransactionsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/NewConfirmedTokensTransactionsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "NewConfirmedTokensTransactionsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "NewConfirmedTokensTransactionsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "NewConfirmedTokensTransactionsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/BlockchainEventsCallbacksLimitReached" } ] }, "NewConfirmedTokensTransactionsE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/AlreadyExists" } ] }, "NewConfirmedTokensTransactionsAndEachConfirmationRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address of the transaction, per which the result is returned.", "example": "0x7495fede000c8a3b77eeae09cf70fa94cd2d53f5" }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "confirmationsCount": { "type": "integer", "description": "Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.", "example": 3 }, "createdTimestamp": { "type": "integer", "description": "Defines the specific time/date when the subscription was created in Unix Timestamp.", "example": 1236238648 }, "eventType": { "type": "string", "description": "Defines the type of the specific event available for the customer to subscribe to for callback notification.", "example": "ADDRESS_TOKENS_TRANSACTION_CONFIRMED_EACH_CONFIRMATION" }, "isActive": { "type": "boolean", "description": "Defines whether the subscription is active or not. Set as boolean.", "example": true }, "referenceId": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "c748624f-1843-4738-a7de-8258ada0f524" } }, "required": [ "address", "callbackUrl", "createdTimestamp", "eventType", "isActive", "referenceId" ] }, "NewConfirmedTokensTransactionsAndEachConfirmationR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/NewConfirmedTokensTransactionsAndEachConfirmationRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "NewConfirmedTokensTransactionsAndEachConfirmationE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "NewConfirmedTokensTransactionsAndEachConfirmationE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "NewConfirmedTokensTransactionsAndEachConfirmationE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/BlockchainEventsCallbacksLimitReached" } ] }, "NewConfirmedTokensTransactionsAndEachConfirmationE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/AlreadyExists" } ] }, "NewConfirmedCoinsTransactionsAndEachConfirmationRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address of the transaction, per which the result is returned.", "example": "15XyNC88pujwuuur8DCsXBCfEhJJMzHayU" }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "confirmationsCount": { "type": "integer", "description": "Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.", "example": 3 }, "createdTimestamp": { "type": "integer", "description": "Defines the specific time/date when the subscription was created in Unix Timestamp.", "example": 1611238648 }, "eventType": { "type": "string", "description": "Defines the type of the specific event available for the customer to subscribe to for callback notification.", "example": "ADDRESS_COINS_TRANSACTION_CONFIRMED_EACH_CONFIRMATION" }, "isActive": { "type": "boolean", "description": "Defines whether the subscription is active or not. Set as boolean.", "example": true }, "referenceId": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "bc243c86-0902-4386-b30d-e6b30fa1f2aa" } }, "required": [ "address", "callbackSecretKey", "callbackUrl", "confirmationsCount", "createdTimestamp", "eventType", "isActive", "referenceId" ] }, "NewConfirmedCoinsTransactionsAndEachConfirmationR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/NewConfirmedCoinsTransactionsAndEachConfirmationRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "NewConfirmedCoinsTransactionsAndEachConfirmationE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "NewConfirmedCoinsTransactionsAndEachConfirmationE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "NewConfirmedCoinsTransactionsAndEachConfirmationE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/BlockchainEventsCallbacksLimitReached" } ] }, "NewConfirmedCoinsTransactionsAndEachConfirmationE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/AlreadyExists" } ] }, "NewBlockRI": { "type": "object", "properties": { "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://yourURL.com" }, "createdTimestamp": { "type": "integer", "description": "Defines the specific time/date when the subscription was created in Unix Timestamp.", "example": 1611238648 }, "isActive": { "type": "boolean", "description": "Defines whether the subscription is active or not. Set as boolean.", "example": true }, "referenceId": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "4c530a43-5602-41d9-bc69-156a0372f9aa" } }, "required": [ "callbackSecretKey", "callbackUrl", "createdTimestamp", "isActive", "referenceId" ] }, "NewBlockR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/NewBlockRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "NewBlockE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "NewBlockE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "NewBlockE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/BlockchainEventsCallbacksLimitReached" } ] }, "NewBlockE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/AlreadyExists" } ] }, "ListBlockchainEventsSubscriptionsRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address of the transaction.", "example": "tb1qtm44m6xmuasy4sc7nl7thvuxcerau2dfvkkgsc" }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "confirmationsCount": { "type": "integer", "description": "Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.", "example": 5 }, "createdTimestamp": { "type": "integer", "description": "Defines the specific time/date when the subscription was created in Unix Timestamp.", "example": 1966238648 }, "deactivationReasons": { "type": "array", "description": "Represents the deactivation reason details, available when a blockchain event subscription has status isActive - false.", "items": { "type": "object", "properties": { "reason": { "type": "string", "description": "Defines the deactivation reason as a message.", "example": "maximum_retry_attempts_reached" }, "timestamp": { "type": "integer", "description": "Represents the time of the subscription deactivation.", "example": 1642102581 } }, "required": [ "reason", "timestamp" ] } }, "eventType": { "type": "string", "description": "Defines the type of the specific event available for the customer to subscribe to for callback notification.", "example": "BLOCK_MINED" }, "isActive": { "type": "boolean", "description": "Defines whether the subscription is active or not. Set as boolean.", "example": true }, "referenceId": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "bc243c86-0902-4386-b30d-e6b30fa1f2aa" }, "transactionId": { "type": "string", "description": "Represents the unique identification string that defines the transaction.", "example": "742b4a8d54a663d372fa16abf74093595ae6fc950f2fa2bb7388c7f4d061d7b8" } }, "required": [ "address", "callbackUrl", "confirmationsCount", "createdTimestamp", "eventType", "isActive", "referenceId" ] }, "ListBlockchainEventsSubscriptionsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListBlockchainEventsSubscriptionsRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListBlockchainEventsSubscriptionsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListBlockchainEventsSubscriptionsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListBlockchainEventsSubscriptionsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetBlockchainEventSubscriptionDetailsByReferenceIDRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address of the transaction.", "example": "tb1qtm44m6xmuasy4sc7nl7thvuxcerau2dfvkkgsc" }, "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs.", "example": "http://example.com" }, "confirmationsCount": { "type": "integer", "description": "Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.", "example": 5 }, "createdTimestamp": { "type": "integer", "description": "Defines the specific time/date when the subscription was created in Unix Timestamp.", "example": 1966238648 }, "deactivationReasons": { "type": "array", "description": "Represents the deactivation reason details, available when a blockchain event subscription has status isActive - false.", "items": { "type": "object", "properties": { "reason": { "type": "string", "description": "Defines the deactivation reason as a message.", "example": "maximum_retry_attempts_reached" }, "timestamp": { "type": "integer", "description": "Represents the time of the subscription deactivation.", "example": 1642102581 } }, "required": [ "reason", "timestamp" ] } }, "eventType": { "type": "string", "description": "Defines the type of the specific event available for the customer to subscribe to for callback notification.", "example": "ADDRESS_COINS_TRANSACTION_CONFIRMED" }, "isActive": { "type": "boolean", "description": "Defines whether the subscription is active or not. Set as boolean.", "example": false }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, "referenceId": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "bc243c86-0902-4386-b30d-e6b30fa1f2aa" }, "transactionId": { "type": "string", "description": "Represents the unique identification string that defines the transaction.", "example": "742b4a8d54a663d372fa16abf74093595ae6fc950f2fa2bb7388c7f4d061d7b8" } }, "required": [ "blockchain", "callbackUrl", "createdTimestamp", "eventType", "isActive", "network", "referenceId" ] }, "GetBlockchainEventSubscriptionDetailsByReferenceIDR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetBlockchainEventSubscriptionDetailsByReferenceIDRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetBlockchainEventSubscriptionDetailsByReferenceIDE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetBlockchainEventSubscriptionDetailsByReferenceIDE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetBlockchainEventSubscriptionDetailsByReferenceIDE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ResourceNotFound": { "type": "object", "description": "resource_not_found", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "resource_not_found" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The specified resource has not been found." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "ActivateBlockchainEventSubscriptionRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address of the transaction, per which the result is returned.", "example": "0x7495fede000c8a3b77eeae09cf70fa94cd2d53f5" }, "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "confirmationsCount": { "type": "integer", "description": "Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.", "example": 2 }, "createdTimestamp": { "type": "integer", "description": "Defines the specific time/date when the subscription was created in Unix Timestamp.", "example": 1611238648 }, "eventType": { "type": "string", "description": "Defines the type of the specific event available for the customer to subscribe to for callback notification.", "example": "ADDRESS_TOKENS_TRANSACTION_CONFIRMED" }, "isActive": { "type": "boolean", "description": "Defines whether the subscription is active or not. Set as boolean.", "example": true }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, "referenceId": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "bc243c86-0902-4386-b30d-e6b30fa1f2aa" }, "transactionId": { "type": "string", "description": "Represents the unique identification string that defines the transaction.", "example": "0xbe38781783b1b9d480219255ff98e20335a39e13979a66112efa33f05fde0a33" } }, "required": [ "address", "blockchain", "callbackSecretKey", "callbackUrl", "confirmationsCount", "createdTimestamp", "eventType", "isActive", "network", "referenceId", "transactionId" ] }, "ActivateBlockchainEventSubscriptionR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ActivateBlockchainEventSubscriptionRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ActivateBlockchainEventSubscriptionE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ActivateBlockchainEventSubscriptionE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ActivateBlockchainEventSubscriptionE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "DeleteBlockchainEventSubscriptionRI": { "type": "object", "properties": { "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://developers.cryptoapis.io/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "createdTimestamp": { "type": "integer", "description": "Defines the specific time/date when the subscription was created in Unix Timestamp.", "example": 1611238648 }, "eventType": { "type": "string", "description": "Defines the type of the specific event available for the customer to subscribe to for callback notification.", "example": "ADDRESS_COINS_TRANSACTION_UNCONFIRMED" }, "referenceId": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "6de9a6ae-1463-458c-81a5-16d68d108012" } }, "required": [ "callbackSecretKey", "callbackUrl", "createdTimestamp", "eventType", "referenceId" ] }, "DeleteBlockchainEventSubscriptionR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DeleteBlockchainEventSubscriptionRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "DeleteBlockchainEventSubscriptionE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "DeleteBlockchainEventSubscriptionE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "DeleteBlockchainEventSubscriptionE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "NewConfirmedInternalTransactionsRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Defines the specific address of the internal transaction.", "example": "0xbcc817f057950b0df41206c5d7125e6225cae18e" }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs 2.0. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2021-03-20-111/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "createdTimestamp": { "type": "integer", "description": "Defines the specific time/date when the subscription was created in Unix Timestamp.", "example": 1236238648 }, "eventType": { "type": "string", "description": "Defines the type of the specific event available for the customer to subscribe to for callback notification.", "example": "ADDRESS_INTERNAL_TRANSACTION_CONFIRMED" }, "isActive": { "type": "boolean", "description": "Defines whether the subscription is active or not. Set as boolean.", "example": true }, "receiveCallbackOn": { "type": "integer", "description": "Represents the exact confirmation, on which the user wants to receive callback.", "example": 3 }, "referenceId": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "bc243c86-0902-4386-b30d-e6b30fa1f2aa" } }, "required": [ "address", "callbackSecretKey", "callbackUrl", "createdTimestamp", "eventType", "isActive", "receiveCallbackOn", "referenceId" ] }, "NewConfirmedInternalTransactionsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/NewConfirmedInternalTransactionsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "NewConfirmedInternalTransactionsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "NewConfirmedInternalTransactionsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "NewConfirmedInternalTransactionsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/BlockchainEventsCallbacksLimitReached" } ] }, "NewConfirmedInternalTransactionsE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/AlreadyExists" } ] }, "NewConfirmedInternalTransactionsAndEachConfirmationRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Defines the specific address of the internal transaction.", "example": "0xe2b5f5e885a268e4b6faae53f99a663f3bb3e036" }, "callbackSecretKey": { "type": "string", "description": "Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](https://project-2a14af.doxify.ai/v-1.2021-03-20-111/RESTapis/general-information/callbacks#callback-security).", "example": "yourSecretKey" }, "callbackUrl": { "type": "string", "description": "Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. `We support ONLY httpS type of protocol`.", "example": "https://example.com" }, "confirmationsCount": { "type": "integer", "description": "Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.", "example": 3 }, "createdTimestamp": { "type": "integer", "description": "Defines the specific time/date when the subscription was created in Unix Timestamp.", "example": 1611238648 }, "eventType": { "type": "string", "description": "Defines the type of the specific event available for the customer to subscribe to for callback notification.", "example": "ADDRESS_INTERNAL_TRANSACTION_CONFIRMED_EACH_CONFIRMATION" }, "isActive": { "type": "boolean", "description": "Defines whether the subscription is active or not. Set as boolean.", "example": true }, "referenceId": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "bc243c86-0902-4386-b30d-e6b30fa1f2aa" } }, "required": [ "address", "callbackSecretKey", "callbackUrl", "confirmationsCount", "createdTimestamp", "eventType", "isActive", "referenceId" ] }, "NewConfirmedInternalTransactionsAndEachConfirmationR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/NewConfirmedInternalTransactionsAndEachConfirmationRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "NewConfirmedInternalTransactionsAndEachConfirmationE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "NewConfirmedInternalTransactionsAndEachConfirmationE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "NewConfirmedInternalTransactionsAndEachConfirmationE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/BlockchainEventsCallbacksLimitReached" } ] }, "NewConfirmedInternalTransactionsAndEachConfirmationE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/AlreadyExists" } ] }, "ListSupportedAssetsRI": { "type": "object", "properties": { "latestRate": { "type": "object", "description": "Specifies the latest price of the asset.", "properties": { "amount": { "type": "string", "description": "Represents the amount of the latest rate.", "example": "61704.20995670996" }, "calculationTimestamp": { "type": "integer", "description": "Defines when the price was calculated in UNIX timestamp. Oldest possible timestamp is 30 days.", "example": 1636107864 }, "unit": { "type": "string", "description": "Specifies the unit of the latest price of the asset.", "example": "USD" } }, "required": [ "amount", "unit" ] }, "logo": { "type": "object", "properties": { "encoding": { "type": "string", "description": "Defines the encoding of the image data which is usually base64.", "example": "base64" }, "imageData": { "type": "string", "description": "Defines the encoded image data as a string.", "example": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzMiIgaGVpZ2h0PSIzMiI+PGcgZmlsbD0ibm9uZSIgZmlsbC1ydWxlPSJldmVub2RkIj48Y2lyY2xlIGN4PSIxNiIgY3k9IjE2IiByPSIxNiIgZmlsbD0iI0Y3OTMxQSIvPjxwYXRoIGZpbGw9IiNGRkYiIGZpbGwtcnVsZT0ibm9uemVybyIgZD0iTTIzLjE4OSAxNC4wMmMuMzE0LTIuMDk2LTEuMjgzLTMuMjIzLTMuNDY1LTMuOTc1bC43MDgtMi44NC0xLjcyOC0uNDMtLjY5IDIuNzY1Yy0uNDU0LS4xMTQtLjkyLS4yMi0xLjM4NS0uMzI2bC42OTUtMi43ODNMMTUuNTk2IDZsLS43MDggMi44MzljLS4zNzYtLjA4Ni0uNzQ2LS4xNy0xLjEwNC0uMjZsLjAwMi0uMDA5LTIuMzg0LS41OTUtLjQ2IDEuODQ2czEuMjgzLjI5NCAxLjI1Ni4zMTJjLjcuMTc1LjgyNi42MzguODA1IDEuMDA2bC0uODA2IDMuMjM1Yy4wNDguMDEyLjExLjAzLjE4LjA1N2wtLjE4My0uMDQ1LTEuMTMgNC41MzJjLS4wODYuMjEyLS4zMDMuNTMxLS43OTMuNDEuMDE4LjAyNS0xLjI1Ni0uMzEzLTEuMjU2LS4zMTNsLS44NTggMS45NzggMi4yNS41NjFjLjQxOC4xMDUuODI4LjIxNSAxLjIzMS4zMThsLS43MTUgMi44NzIgMS43MjcuNDMuNzA4LTIuODRjLjQ3Mi4xMjcuOTMuMjQ1IDEuMzc4LjM1N2wtLjcwNiAyLjgyOCAxLjcyOC40My43MTUtMi44NjZjMi45NDguNTU4IDUuMTY0LjMzMyA2LjA5Ny0yLjMzMy43NTItMi4xNDYtLjAzNy0zLjM4NS0xLjU4OC00LjE5MiAxLjEzLS4yNiAxLjk4LTEuMDAzIDIuMjA3LTIuNTM4em0tMy45NSA1LjUzOGMtLjUzMyAyLjE0Ny00LjE0OC45ODYtNS4zMi42OTVsLjk1LTMuODA1YzEuMTcyLjI5MyA0LjkyOS44NzIgNC4zNyAzLjExem0uNTM1LTUuNTY5Yy0uNDg3IDEuOTUzLTMuNDk1Ljk2LTQuNDcuNzE3bC44Ni0zLjQ1Yy45NzUuMjQzIDQuMTE4LjY5NiAzLjYxIDIuNzMzeiIvPjwvZz48L3N2Zz4=" }, "mimeType": { "type": "string", "description": "Defines the image type of the logo - jpg, png, svg, etc.", "example": "image/svg+xml" } }, "required": [ "encoding", "imageData", "mimeType" ] }, "name": { "type": "string", "description": "Specifies the name of the asset in question.", "example": "Bitcoin" }, "originalSymbol": { "type": "string", "description": "Specifies the asset's original symbol as introduced by its founders.", "example": "BTC" }, "referenceId": { "type": "string", "description": "Defines the unique ID of the specific asset.", "example": "5b1ea92e584bf50020130615" }, "slug": { "type": "string", "description": "Represents the asset`s unique slug string in Crypto APIs listings.", "example": "bitcoin" }, "specificData": { "$ref": "#/components/schemas/ListSupportedAssetsRIS" }, "symbol": { "type": "string", "description": "Specifies the asset's unique symbol in the Crypto APIs listings.", "example": "BTC" } }, "required": [ "latestRate", "logo", "name", "originalSymbol", "referenceId", "specificData", "symbol" ] }, "ListSupportedAssetsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListSupportedAssetsRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListSupportedAssetsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListSupportedAssetsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListSupportedAssetsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetExchangeRateByAssetSymbolsRI": { "type": "object", "properties": { "calculationTimestamp": { "type": "integer", "description": "Defines the time of the market data used to calculate the exchange rate in UNIX Timestamp. Oldest possible timestamp is 30 days.", "example": 1618577849 }, "fromAssetId": { "type": "string", "description": "Defines the base asset Reference ID to get a rate for.", "example": "5b1ea92e584bf50020130612" }, "fromAssetSymbol": { "type": "string", "description": "Defines the base asset symbol to get a rate for.", "example": "BTC" }, "rate": { "type": "string", "description": "Defines the exchange rate between assets calculated by weighted average of the last trades in every exchange for the last 24 hours by giving more weight to exchanges with higher volume.", "example": "54768.26745499848" }, "toAssetId": { "type": "string", "description": "Defines the relation asset Reference ID in which the base asset rate will be displayed.", "example": "5b1ea92e584bf50020130615" }, "toAssetSymbol": { "type": "string", "description": "Defines the relation asset symbol in which the base asset rate will be displayed.", "example": "USD" } }, "required": [ "calculationTimestamp", "fromAssetId", "fromAssetSymbol", "rate", "toAssetId", "toAssetSymbol" ] }, "GetExchangeRateByAssetSymbolsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetExchangeRateByAssetSymbolsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetExchangeRateByAssetSymbolsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetExchangeRateByAssetSymbolsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetExchangeRateByAssetSymbolsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "CouldNotCalculateRateForPair": { "type": "object", "description": "could_not_calculate_rate_for_pair", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "could_not_calculate_rate_for_pair" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Rate could not be calculated due to not enough pair trades data." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "GetExchangeRateByAssetSymbolsE422": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestBodyStructure" }, { "$ref": "#/components/schemas/CouldNotCalculateRateForPair" } ] }, "GetExchangeRateByAssetsIDsRI": { "type": "object", "properties": { "calculationTimestamp": { "type": "integer", "description": "Defines the time of the market data used to calculate the exchange rate in UNIX Timestamp. Oldest possible timestamp is 30 days.", "example": 1618577849 }, "fromAssetId": { "type": "string", "description": "Defines the base asset Reference ID to get a rate for.", "example": "5b1ea92e584bf50020130612" }, "fromAssetSymbol": { "type": "string", "description": "Defines the base asset symbol to get a rate for.", "example": "BTC" }, "rate": { "type": "string", "description": "Defines the exchange rate between assets calculated by weighted average of the last trades in every exchange for the last 24 hours by giving more weight to exchanges with higher volume.", "example": "54691.40481689715" }, "toAssetId": { "type": "string", "description": "Defines the relation asset Reference ID in which the base asset rate will be displayed.", "example": "5b1ea92e584bf50020130615" }, "toAssetSymbol": { "type": "string", "description": "Defines the relation asset symbol in which the base asset rate will be displayed.", "example": "USD" } }, "required": [ "calculationTimestamp", "fromAssetId", "fromAssetSymbol", "rate", "toAssetId", "toAssetSymbol" ] }, "GetExchangeRateByAssetsIDsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetExchangeRateByAssetsIDsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetExchangeRateByAssetsIDsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetExchangeRateByAssetsIDsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetExchangeRateByAssetsIDsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetExchangeRateByAssetsIDsE422": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestBodyStructure" }, { "$ref": "#/components/schemas/CouldNotCalculateRateForPair" } ] }, "SyncAddressRI": { "type": "object", "properties": { "address": { "type": "string", "example": "0x3d0b25fe09e2cd92f06ba776391a122519936e90" }, "blockchain": { "type": "string", "example": "ethereum" }, "callcackUrl": { "type": "string", "example": "https://example.com" }, "isActive": { "type": "boolean", "example": true }, "network": { "type": "string", "example": "sepolia" }, "syncStatus": { "type": "string", "example": "completed" } }, "required": [ "address", "blockchain", "callcackUrl", "network", "syncStatus" ] }, "SyncAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/SyncAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "SyncAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "SyncAddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "SyncAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/SyncAddressesLimitReached" } ] }, "SyncAddressE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/AlreadyExists" } ] }, "SyncAddressesLimitReached": { "type": "object", "description": "sync_addresses_limit_reached", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "sync_addresses_limit_reached" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "You have reached the maximum sync addresses count. Please, upgrade your plan in order to have a higher sync addresses count." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "GetAssetDetailsByAssetIDRI": { "type": "object", "properties": { "contracts": { "type": "array", "items": { "type": "object", "properties": { "blockchain": { "type": "string", "description": "Blockchain string full name representation (eg. ethereum)", "example": "ethereum" }, "fungibleValues": { "type": "object", "properties": { "decimals": { "type": "integer", "description": "Token`s decimal number (points after zero)", "example": 18 } } }, "identifier": { "type": "string", "description": "Token`s unique identifier string the provided blockchain and network", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" }, "network": { "type": "string", "description": "Network string full name representation (eg. sepolia)", "example": "mainnet" }, "standard": { "type": "string", "description": "Token`s type representation - exp. ERC-20, Omni, etc..", "example": "ERC-20" } }, "required": [ "blockchain", "identifier", "network", "standard" ] } }, "latestRate": { "type": "object", "description": "Specifies the latest price of the asset.", "properties": { "amount": { "type": "string", "description": "Represents the amount of the latest rate.", "example": "61704.20995670996" }, "calculationTimestamp": { "type": "integer", "description": "Defines when the price was calculated in UNIX timestamp. Oldest possible timestamp is 30 days.", "example": 1636107864 }, "unit": { "type": "string", "description": "Specifies the unit of the latest price of the asset.", "example": "USD" } }, "required": [ "amount", "unit" ] }, "logo": { "type": "object", "properties": { "encoding": { "type": "string", "description": "Defines the encoding of the image data which is usually base64.", "example": "base64" }, "imageData": { "type": "string", "description": "Defines the encoded image data as a string.", "example": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzMiIgaGVpZ2h0PSIzMiI+PGcgZmlsbD0ibm9uZSIgZmlsbC1ydWxlPSJldmVub2RkIj48Y2lyY2xlIGN4PSIxNiIgY3k9IjE2IiByPSIxNiIgZmlsbD0iI0Y3OTMxQSIvPjxwYXRoIGZpbGw9IiNGRkYiIGZpbGwtcnVsZT0ibm9uemVybyIgZD0iTTIzLjE4OSAxNC4wMmMuMzE0LTIuMDk2LTEuMjgzLTMuMjIzLTMuNDY1LTMuOTc1bC43MDgtMi44NC0xLjcyOC0uNDMtLjY5IDIuNzY1Yy0uNDU0LS4xMTQtLjkyLS4yMi0xLjM4NS0uMzI2bC42OTUtMi43ODNMMTUuNTk2IDZsLS43MDggMi44MzljLS4zNzYtLjA4Ni0uNzQ2LS4xNy0xLjEwNC0uMjZsLjAwMi0uMDA5LTIuMzg0LS41OTUtLjQ2IDEuODQ2czEuMjgzLjI5NCAxLjI1Ni4zMTJjLjcuMTc1LjgyNi42MzguODA1IDEuMDA2bC0uODA2IDMuMjM1Yy4wNDguMDEyLjExLjAzLjE4LjA1N2wtLjE4My0uMDQ1LTEuMTMgNC41MzJjLS4wODYuMjEyLS4zMDMuNTMxLS43OTMuNDEuMDE4LjAyNS0xLjI1Ni0uMzEzLTEuMjU2LS4zMTNsLS44NTggMS45NzggMi4yNS41NjFjLjQxOC4xMDUuODI4LjIxNSAxLjIzMS4zMThsLS43MTUgMi44NzIgMS43MjcuNDMuNzA4LTIuODRjLjQ3Mi4xMjcuOTMuMjQ1IDEuMzc4LjM1N2wtLjcwNiAyLjgyOCAxLjcyOC40My43MTUtMi44NjZjMi45NDguNTU4IDUuMTY0LjMzMyA2LjA5Ny0yLjMzMy43NTItMi4xNDYtLjAzNy0zLjM4NS0xLjU4OC00LjE5MiAxLjEzLS4yNiAxLjk4LTEuMDAzIDIuMjA3LTIuNTM4em0tMy45NSA1LjUzOGMtLjUzMyAyLjE0Ny00LjE0OC45ODYtNS4zMi42OTVsLjk1LTMuODA1YzEuMTcyLjI5MyA0LjkyOS44NzIgNC4zNyAzLjExem0uNTM1LTUuNTY5Yy0uNDg3IDEuOTUzLTMuNDk1Ljk2LTQuNDcuNzE3bC44Ni0zLjQ1Yy45NzUuMjQzIDQuMTE4LjY5NiAzLjYxIDIuNzMzeiIvPjwvZz48L3N2Zz4=" }, "mimeType": { "type": "string", "description": "Defines the image type of the logo - jpg, png, svg, etc.", "example": "image/svg+xml" } }, "required": [ "encoding", "imageData", "mimeType" ] }, "name": { "type": "string", "description": "Specifies the name of the asset in question.", "example": "Bitcoin" }, "originalSymbol": { "type": "string", "description": "Specifies the asset's original symbol as introduced by its founders.", "example": "BTC" }, "referenceId": { "type": "string", "description": "Defines the unique ID of the specific asset.", "example": "5b1ea92e584bf50020130615" }, "slug": { "type": "string", "description": "Represents the asset`s unique slug string in Crypto APIs listings.", "example": "bitcoin" }, "specificData": { "$ref": "#/components/schemas/GetAssetDetailsByAssetIDRIS" }, "symbol": { "type": "string", "description": "Specifies the asset's unique symbol in the Crypto APIs listings.", "example": "BTC" } }, "required": [ "contracts", "latestRate", "logo", "name", "originalSymbol", "referenceId", "specificData", "symbol" ] }, "GetAssetDetailsByAssetIDR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetAssetDetailsByAssetIDRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetAssetDetailsByAssetIDE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetAssetDetailsByAssetIDE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetAssetDetailsByAssetIDE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetAssetDetailsByAssetSymbolRI": { "type": "object", "properties": { "contracts": { "type": "array", "items": { "type": "object", "properties": { "blockchain": { "type": "string", "description": "Blockchain string full name representation (eg. ethereum)", "example": "ethereum" }, "fungibleValues": { "type": "object", "properties": { "decimals": { "type": "integer", "description": "Token`s decimal number (points after zero)", "example": 18 } } }, "identifier": { "type": "string", "description": "Token`s unique identifier string the provided blockchain and network", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" }, "network": { "type": "string", "description": "Network string full name representation (eg. sepolia)", "example": "mainnet" }, "standard": { "type": "string", "description": "Token`s type representation - exp. ERC-20, Omni, etc..", "example": "ERC-20" } }, "required": [ "blockchain", "identifier", "network", "standard" ] } }, "latestRate": { "type": "object", "description": "Specifies the latest price of the asset.", "properties": { "amount": { "type": "string", "description": "Represents the amount of the latest rate.", "example": "61704.20995670996" }, "calculationTimestamp": { "type": "integer", "description": "Defines when the price was calculated in UNIX timestamp. Oldest possible timestamp is 30 days.", "example": 1636107864 }, "unit": { "type": "string", "description": "Specifies the unit of the latest price of the asset.", "example": "USD" } }, "required": [ "amount", "unit" ] }, "logo": { "type": "object", "properties": { "encoding": { "type": "string", "description": "Defines the encoding of the image data which is usually base64.", "example": "base64" }, "imageData": { "type": "string", "description": "Defines the encoded image data as a string.", "example": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzMiIgaGVpZ2h0PSIzMiI+PGcgZmlsbD0ibm9uZSIgZmlsbC1ydWxlPSJldmVub2RkIj48Y2lyY2xlIGN4PSIxNiIgY3k9IjE2IiByPSIxNiIgZmlsbD0iI0Y3OTMxQSIvPjxwYXRoIGZpbGw9IiNGRkYiIGZpbGwtcnVsZT0ibm9uemVybyIgZD0iTTIzLjE4OSAxNC4wMmMuMzE0LTIuMDk2LTEuMjgzLTMuMjIzLTMuNDY1LTMuOTc1bC43MDgtMi44NC0xLjcyOC0uNDMtLjY5IDIuNzY1Yy0uNDU0LS4xMTQtLjkyLS4yMi0xLjM4NS0uMzI2bC42OTUtMi43ODNMMTUuNTk2IDZsLS43MDggMi44MzljLS4zNzYtLjA4Ni0uNzQ2LS4xNy0xLjEwNC0uMjZsLjAwMi0uMDA5LTIuMzg0LS41OTUtLjQ2IDEuODQ2czEuMjgzLjI5NCAxLjI1Ni4zMTJjLjcuMTc1LjgyNi42MzguODA1IDEuMDA2bC0uODA2IDMuMjM1Yy4wNDguMDEyLjExLjAzLjE4LjA1N2wtLjE4My0uMDQ1LTEuMTMgNC41MzJjLS4wODYuMjEyLS4zMDMuNTMxLS43OTMuNDEuMDE4LjAyNS0xLjI1Ni0uMzEzLTEuMjU2LS4zMTNsLS44NTggMS45NzggMi4yNS41NjFjLjQxOC4xMDUuODI4LjIxNSAxLjIzMS4zMThsLS43MTUgMi44NzIgMS43MjcuNDMuNzA4LTIuODRjLjQ3Mi4xMjcuOTMuMjQ1IDEuMzc4LjM1N2wtLjcwNiAyLjgyOCAxLjcyOC40My43MTUtMi44NjZjMi45NDguNTU4IDUuMTY0LjMzMyA2LjA5Ny0yLjMzMy43NTItMi4xNDYtLjAzNy0zLjM4NS0xLjU4OC00LjE5MiAxLjEzLS4yNiAxLjk4LTEuMDAzIDIuMjA3LTIuNTM4em0tMy45NSA1LjUzOGMtLjUzMyAyLjE0Ny00LjE0OC45ODYtNS4zMi42OTVsLjk1LTMuODA1YzEuMTcyLjI5MyA0LjkyOS44NzIgNC4zNyAzLjExem0uNTM1LTUuNTY5Yy0uNDg3IDEuOTUzLTMuNDk1Ljk2LTQuNDcuNzE3bC44Ni0zLjQ1Yy45NzUuMjQzIDQuMTE4LjY5NiAzLjYxIDIuNzMzeiIvPjwvZz48L3N2Zz4=" }, "mimeType": { "type": "string", "description": "Defines the image type of the logo - jpg, png, svg, etc.", "example": "image/svg+xml" } }, "required": [ "encoding", "imageData", "mimeType" ] }, "name": { "type": "string", "description": "Specifies the name of the asset in question.", "example": "Bitcoin" }, "originalSymbol": { "type": "string", "description": "Specifies the asset's original symbol as introduced by its founders.", "example": "BTC" }, "referenceId": { "type": "string", "description": "Asset reference ID", "example": "5b1ea92e584bf50020130615" }, "slug": { "type": "string", "description": "Represents the asset`s unique slug string in Crypto APIs listings.", "example": "bitcoin" }, "specificData": { "$ref": "#/components/schemas/GetAssetDetailsByAssetSymbolRIS" }, "symbol": { "type": "string", "description": "Specifies the asset's unique symbol in the Crypto APIs listings.", "example": "BTC" }, "type": { "type": "string", "description": "Defines the type of the supported asset. This could be either \"crypto\" or \"fiat\".", "example": "crypto", "enum": [ "fiat", "crypto" ] } }, "required": [ "contracts", "latestRate", "logo", "name", "originalSymbol", "referenceId", "specificData", "symbol", "type" ] }, "GetAssetDetailsByAssetSymbolR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetAssetDetailsByAssetSymbolRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetAssetDetailsByAssetSymbolE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetAssetDetailsByAssetSymbolE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetAssetDetailsByAssetSymbolE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListSyncedAddressesRI": { "type": "object", "properties": { "address": { "type": "string", "description": "String representation of the address", "example": "0x3d0b25fe09e2cd92f06ba776391a122519936e90" }, "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Bitcoin, etc.", "example": "ethereum" }, "id": { "type": "string", "description": "Record identificator used for pagination startingAfter", "example": "65f8d5e0c35b1cca17c9af05" }, "isActive": { "type": "boolean", "description": "Defines whether the synchronization is active or not.", "example": true }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, "syncStatus": { "type": "string", "description": "String representation of the synchronization status", "example": "completed" } }, "required": [ "address", "blockchain", "id", "isActive", "network", "syncStatus" ] }, "ListSyncedAddressesR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListSyncedAddressesRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListSyncedAddressesE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListSyncedAddressesE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListSyncedAddressesE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ActivateSyncedAddressRI": { "type": "object", "properties": { "isActive": { "type": "boolean", "example": true }, "syncStatus": { "type": "string", "example": "completed" } }, "required": [ "isActive", "syncStatus" ] }, "ActivateSyncedAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ActivateSyncedAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ActivateSyncedAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ActivateSyncedAddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ActivateSyncedAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "SyncAddressAlreadyActive": { "type": "object", "description": "sync_address_already_active", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "sync_address_already_active" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The sync address that you are trying to activate is already active. " }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "ActivateSyncedAddressE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/SyncAddressAlreadyActive" } ] }, "DeleteSyncedAddressRI": { "type": "object", "properties": { "isActive": { "type": "boolean", "example": false }, "syncStatus": { "type": "string", "example": "completed" } }, "required": [ "isActive", "syncStatus" ] }, "DeleteSyncedAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DeleteSyncedAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "DeleteSyncedAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "DeleteSyncedAddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "DeleteSyncedAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "CanNotDeleteSyncingAddress": { "type": "object", "description": "can_not_delete_syncing_address", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "can_not_delete_syncing_address" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The sync address that you are trying to delete is still being synced." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "DeleteSyncedAddressE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/CanNotDeleteSyncingAddress" } ] }, "ListUnspentTransactionOutputsByAddressUTXOsRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address that has unspend funds per which the result is returned.", "example": "2N5PcdirZUzKF9bWuGdugNuzcQrCbBudxv1" }, "index": { "type": "integer", "format": "int64", "description": "Represents the index position of the transaction in the block.", "example": 1 }, "isAvailable": { "type": "boolean", "description": "Represents if the UTXO has been used from another unconfirmed transaction. If it is - the value will be \"false\".", "example": true }, "isConfirmed": { "type": "boolean", "description": "Represents the state of the transaction whether it is confirmed or not confirmed.", "example": true }, "timestamp": { "type": "integer", "format": "int64", "description": "Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.", "example": 1622466746 }, "transactionId": { "type": "string", "description": "Represents the unique identifier of a transaction, i.e. it could be `transactionId` in UTXO-based protocols like Bitcoin, and transaction `hash` in Ethereum blockchain.", "example": "4b66461bf88b61e1e4326356534c135129defb504c7acb2fd6c92697d79eb250" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the sent/received amount.", "example": "0.00873472" }, "denomination": { "type": "integer", "description": "Integer value representing the denomination of the amount from the main unit", "example": 1 }, "unit": { "type": "string", "description": "Represents the unit of the amount", "example": "ZEC" } }, "required": [ "amount", "denomination", "unit" ] } }, "required": [ "address", "index", "isAvailable", "isConfirmed", "timestamp", "transactionId", "value" ] }, "ListUnspentTransactionOutputsByAddressUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListUnspentTransactionOutputsByAddressUTXOsRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListUnspentTransactionOutputsByAddressUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListUnspentTransactionOutputsByAddressUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListUnspentTransactionOutputsByAddressUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/AddressNotSynced" } ] }, "AddressNotSynced": { "type": "object", "description": "address_not_synced", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "address_not_synced" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The specified address is not synced. Please sync the address in order to be able to obtain information from this endpoint." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "SyncAddressNotActive": { "type": "object", "description": "sync_address_not_active", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "sync_address_not_active" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The specified address is not active. Please, activate your address in order to be able to obtain information from this endpoint." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "SimulateEthereumTransactionsRI": { "type": "object", "properties": { "contract": { "type": "string", "description": "String representation of contract address of the token that was transfered", "example": "0x534bD102153EF199abAe8296a2FaE4599fC44Cdc" }, "gasLimit": { "type": "integer", "description": "String representation of the transaction gas limit", "example": 21000 }, "gasUsed": { "type": "integer", "description": "String representation of the transaction used gas", "example": 21000 }, "hash": { "type": "string", "description": "String representation of the transaction hash", "example": "0xbedfba55a8ef9342d1fe70e1e9adefad20aca7c164b072a648b1bb95d5a6b631" }, "inputData": { "type": "string", "description": "Hex data for contract interaction", "example": "0xa9059cbb000000000000000000000000392214d9de6aaafe32f8ce1e166c2b3ac8ce04c700000000000000000000000000000000000000000000000000000000000001F4" }, "internalTransactions": { "type": "array", "description": "Internal transactions executed by transaction", "items": { "type": "object", "properties": { "depth": { "type": "integer", "description": "This simply shows how far we are looking into the transactions. Each Call has a \"Depth\" value that indicates how far it is away from the original transaction. A depth of 1 means it's a direct call, while Calls higher than 1 shows nested calls.", "example": 1 }, "operationType": { "type": "string", "description": "String representation of internal transaction type", "example": "CALL" }, "recipient": { "type": "string", "description": "String representation of the internal transaction recipient", "example": "0xc946cb236481c159f460b212b34ab246dac37fcd" }, "sender": { "type": "string", "description": "String representation of the internal transaction sender", "example": "0xadf10d7f6a7069c11fc5f3c6c9b4f419b326bcbc" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount that was transacted", "example": "0.0123" }, "unit": { "type": "string", "example": "ETH" } }, "required": [ "amount" ] } }, "required": [ "depth", "operationType", "recipient", "sender", "value" ] } }, "nonce": { "type": "integer", "description": "Numeric representation of the transaction nonce", "example": 123 }, "positionInBlock": { "type": "integer", "description": "Numeric representation of the transaction index", "example": 1 }, "status": { "type": "string", "description": "Status of the transaction", "example": "0x1" }, "timestamp": { "type": "integer", "description": "Numeric representation of the timestamp in seconds since epoch", "example": 1669627454 }, "tokenTransfers": { "type": "array", "description": "Token transfers executed by transaction", "items": { "type": "object", "properties": { "recipient": { "type": "string", "description": "Defines the address to which the recipient receives the transferred tokens.", "example": "0xc6d46aba0c6e2eb6358c4e24804158cc4d847922" }, "sender": { "type": "string", "description": "Defines the address from which the sender transfers tokens.", "example": "0xc6d46aba0c6e2eb6358c4e24804158cc4d847922" }, "tokenData": { "type": "object", "description": "Token data", "properties": { "contractAddress": { "type": "string", "description": "String representation of contract address of the token that was transfered", "example": "0xece01807f7d9b93529174533e997e5de168b0b39" }, "fungibleValues": { "type": "object", "properties": { "amount": { "type": "string", "description": "Amount of the transferred token", "example": "0.123" }, "decimals": { "type": "integer", "description": "Decimals of the token (for fungible tokens)", "example": 18 } } }, "name": { "type": "string", "description": "String representation of the token name", "example": "Tether" }, "nonFungibleValues": { "type": "object", "properties": { "tokenId": { "type": "string", "description": "Token ID of the token (for non-fungible tokens)", "example": "73424079983647210902572285069973579475843508985221180214989723113099915952129" } } }, "standard": { "type": "string", "description": "Defines the specific token type.", "example": "ERC-20" }, "symbol": { "type": "string", "description": "String representation of the token symbol", "example": "USDT" } }, "required": [ "contractAddress", "standard" ] } }, "required": [ "recipient", "sender", "tokenData" ] } }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "Fee spent for transaction", "example": "0.0001" }, "unit": { "type": "string", "description": "Unit in which amount is calculated", "example": "ETH" } }, "required": [ "amount", "unit" ] }, "gasPrice": { "type": "object", "properties": { "amount": { "type": "integer", "description": "String representation of the transaction gas price", "example": 1234567 }, "unit": { "type": "string", "description": "String representation of the transaction price unit", "example": "WEI" } }, "required": [ "amount", "unit" ] }, "maxFeePerGas": { "type": "object", "properties": { "amount": { "type": "string", "description": "Max fee per gas for EIP-1559 transactions", "example": "3558974297" }, "unit": { "type": "string", "example": "WEI" } }, "required": [ "unit" ] }, "maxPriorityFeePerGas": { "type": "object", "properties": { "amount": { "type": "string", "description": "Max priority fee for EIP-1559 transactions", "example": "21000" }, "unit": { "type": "string", "example": "WEI" } }, "required": [ "unit" ] }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "String representation of the block hash", "example": "0xbedfba55a8ef9342d1fe70e1e9adefad20aca7c164b072a648b1bb95d5a6b631" }, "height": { "type": "integer", "format": "int64", "description": "Numeric representation of the block height", "example": 2408785 } }, "required": [ "hash", "height" ] }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "0.123" }, "unit": { "type": "string", "example": "ETH" } }, "required": [ "amount", "unit" ] } }, "required": [ "gasLimit", "hash", "nonce", "positionInBlock", "status", "timestamp", "fee", "gasPrice", "minedInBlock", "value" ] }, "SimulateEthereumTransactionsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/SimulateEthereumTransactionsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "SimulateEthereumTransactionsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "SimulateEthereumTransactionsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "SimulateEthereumTransactionsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ConvertBitcoinCashAddressRI": { "type": "object", "properties": { "convertedAddress": { "type": "string", "description": "Represents the converted address", "example": "mqmpq9nZBbotG22nVDruEVwn2nCHWKfU4p" } }, "required": [ "convertedAddress" ] }, "ConvertBitcoinCashAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ConvertBitcoinCashAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ConvertBitcoinCashAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ConvertBitcoinCashAddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidBlockchain" } ] }, "ConvertBitcoinCashAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListTokensByAddressSyncedEVMRI": { "type": "object", "properties": { "name": { "type": "string", "description": "String representation of the token name", "example": "Tether" }, "standard": { "type": "string", "description": "Defines the specific token type.", "example": "ERC-20" }, "symbol": { "type": "string", "description": "String representation of the token symbol", "example": "USDT" }, "contractAddress": { "type": "string", "description": "String representation of contract address of the token that was transfered", "example": "0xece01807f7d9b93529174533e997e5de168b0b39" }, "fungibleValues": { "type": "object", "properties": { "amount": { "type": "string", "description": "Token balance", "example": "162727.720910848" } }, "required": [ "amount" ] } }, "required": [ "name", "standard", "symbol", "contractAddress", "fungibleValues" ] }, "ListTokensByAddressSyncedEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListTokensByAddressSyncedEVMRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListTokensByAddressSyncedEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListTokensByAddressSyncedEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListTokensByAddressSyncedEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/AddressNotSynced" } ] }, "GetAddressBalanceXRPRI": { "type": "object", "properties": { "confirmedBalance": { "type": "object", "properties": { "amount": { "type": "string", "description": "Numeric representation of the total balance of the address", "example": "53.8163231" }, "unit": { "type": "string", "description": "Represents the unit of the confirmed balance.", "example": "XRP" } }, "required": [ "amount", "unit" ] } }, "required": [ "confirmedBalance" ] }, "GetAddressBalanceXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetAddressBalanceXRPRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetAddressBalanceXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetAddressBalanceXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetAddressBalanceXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListConfirmedTransactionsByAddressByTimestampUTXOHistoricalRI": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the fee value", "example": "0.00000191" }, "unit": { "type": "string", "example": "BTC" } }, "required": [ "amount", "unit" ] }, "hash": { "type": "string", "description": "String representation of the transaction hash", "example": "b8483fe0d1f276a3c53b9ce65f60a2963202f7096c3c3e9a2d4ea0cb31ab60de" }, "id": { "type": "string", "description": "String representation of the transaction identifier (txid)", "example": "b8483fe0d1f276a3c53b9ce65f60a2963202f7096c3c3e9a2d4ea0cb31ab60de" }, "inputs": { "type": "array", "description": "Object Array representation of transaction inputs", "items": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "String array representation of the addresses", "example": "XpXpivu9BppPn7XSd9JVPSXb2NsdCr1JZ7" } }, "coinbase": { "type": "string", "description": "String representation of the coinbase hex", "example": "XtotjTJ1nRGkuAH1axUfybBKoJGtFCqMaV" }, "outputIndex": { "type": "integer", "description": "Numeric representation of the vout", "example": 1 }, "script": { "type": "object", "properties": { "type": { "type": "string", "description": "String representation of the votype", "example": "scripthash" } }, "required": [ "type" ] }, "transactionId": { "type": "string", "description": "String representation of the txid", "example": "b8483fe0d1ff60a2963202f7096c3c3e9a2d4ea0cb31ab60de276a3c53b9ce65" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "123" }, "unit": { "type": "string", "description": "String representation of the unit", "example": "BTC" } } }, "witnesses": { "type": "array", "items": { "type": "string", "description": "Array String representation of the witness", "example": "b8483fe0202f7096c3c3e9a2d4ea0cb31ab60ded1f276a3c53b9ce65f60a2963" } } }, "required": [ "outputIndex", "script", "transactionId" ] } }, "locktime": { "type": "integer", "format": "int64", "description": "Numeric representation of the transaction locktime", "example": 1781865 }, "outputs": { "type": "array", "description": "Object Array representation of transaction outputs", "items": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "String array representation of the addresses", "example": "XtotjxUfybBKoJGtFCqMaVTJ1nRGkuAH1a" } }, "isSpent": { "type": "boolean", "description": "Boolean representation of is the transaction output spent", "example": true }, "script": { "type": "object", "properties": { "type": { "type": "string", "description": "String representation of the type", "example": "scripthash" } }, "required": [ "type" ] }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "123" }, "unit": { "type": "string", "description": "String representation of the unit", "example": "BTC" } } } }, "required": [ "isSpent", "script" ] } }, "positionInBlock": { "type": "integer", "description": "Numeric representation of the index", "example": 10 }, "recipients": { "type": "array", "description": "Object Array representation of transaction receivers", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String representation of the receiver address", "example": "XtotjxUfybBKoJGtFCqMaVTJ1nRGkuAH1a" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "123" }, "unit": { "type": "string", "description": "String representation of the unit", "example": "BTC" } } } } } }, "senders": { "type": "array", "description": "Object Array representation of transaction senders", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String array representation of the sender address", "example": "XpXpivu9BppPn7XSd9JVPSXb2NsdCr1JZ7" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "123" }, "unit": { "type": "string", "description": "String representation of the unit", "example": "BTC" } } } } } }, "size": { "type": "integer", "description": "Numeric representation of the transaction size", "example": 123 }, "timestamp": { "type": "integer", "description": "Numeric representation of the timestamp in seconds since epoch", "example": 1739356303 }, "version": { "type": "integer", "description": "Numeric representation of the transaction version", "example": 2 }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "String representation of the block hash", "example": "0000000000000001ce2cbb18127b56a4e6495fdec1fc81326317193ed6281cb6" }, "height": { "type": "integer", "description": "Numeric representation of the block height", "example": 2221316 } }, "required": [ "hash", "height" ] } }, "required": [ "fee", "hash", "id", "inputs", "locktime", "outputs", "positionInBlock", "recipients", "senders", "size", "timestamp", "version", "minedInBlock" ] }, "ListConfirmedTransactionsByAddressByTimestampUTXOHistoricalR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressByTimestampUTXOHistoricalRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListConfirmedTransactionsByAddressByTimestampUTXOHistoricalE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListConfirmedTransactionsByAddressByTimestampUTXOHistoricalE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListConfirmedTransactionsByAddressByTimestampUTXOHistoricalE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/AddressNotSynced" } ] }, "ListConfirmedTransactionsByAddressEVMHistoryRIBST": { "type": "object", "properties": { "bandwithUsed": { "type": "integer", "description": "Numeric representation of the transaction used bandwidth", "example": 45 }, "energyUsed": { "type": "string", "description": "String representation of the transaction used energy", "example": "276" } }, "description": "Tron", "required": [ "bandwithUsed", "energyUsed" ] }, "ListConfirmedTransactionsByAddressEVMHistoryRI": { "type": "object", "properties": { "contract": { "type": "string", "description": "String representation of the transaction contract address", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7" }, "fee": { "type": "object", "description": "Object representation of the transaction fee", "properties": { "amount": { "type": "string", "description": "String representation of the fee value", "example": "31" }, "unit": { "type": "string", "description": "String representation of the fee unit.", "example": "TRX" } }, "required": [ "amount", "unit" ] }, "gasLimit": { "type": "integer", "description": "String representation of the transaction gas limit", "example": 210000 }, "gasUsed": { "type": "integer", "description": "String representation of the transaction used gas", "example": 21000 }, "hash": { "type": "string", "description": "String representation of the transaction hash", "example": "4259f7eeb8619c7578a2f78b27dd849dba0760db2e0fa61feec0f948a20b6b3c" }, "inputData": { "type": "string", "description": "Numeric representation of the transaction input" }, "positionInBlock": { "type": "integer", "description": "Numeric representation of the transaction index", "example": 10 }, "recipient": { "type": "string", "description": "String representation of the transaction to address", "example": "TRRRpTqaYnBN9EUYXwtAdaSamNNTP2XVr4" }, "sender": { "type": "string", "description": "String representation of the transaction from address", "example": "TQrY8tryqsYVCYS3MFbtffiPp2ccyn4STm" }, "status": { "type": "string", "description": "String representation of the transaction status", "example": "0x1" }, "timestamp": { "type": "integer", "description": "Numeric representation of the timestamp in seconds since epoch", "example": 1739363524 }, "value": { "type": "object", "description": "Object representation of the transacted amount", "properties": { "amount": { "type": "string", "description": "String representation of the amount value", "example": "1.6" }, "unit": { "type": "string", "description": "String representation of the amount unit.", "example": "TRX" } }, "required": [ "amount", "unit" ] }, "gasPrice": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the transaction gas price", "example": "123456" }, "unit": { "type": "string", "description": "String representation of the transaction price unit", "example": "WEI" } }, "required": [ "amount", "unit" ] }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "String representation of the block hash", "example": "0000000004258f50e41a9128f5b6db83ef5bed4e491c4814576acda264f5f42f" }, "height": { "type": "integer", "description": "Numeric representation of the block height", "example": 69570384 } }, "required": [ "hash", "height" ] }, "vallue": { "type": "object", "description": "Object representation of the transacted amount", "properties": {} }, "blockchainSpecific": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressEVMHistoryRIBS" } }, "required": [ "contract", "fee", "gasLimit", "gasUsed", "hash", "inputData", "positionInBlock", "recipient", "sender", "status", "timestamp", "value", "gasPrice", "minedInBlock", "vallue" ] }, "ListConfirmedTransactionsByAddressEVMHistoryRIBS": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressEVMHistoryRIBST" } ] }, "ListConfirmedTransactionsByAddressEVMHistoryR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressEVMHistoryRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListConfirmedTransactionsByAddressEVMHistoryE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListConfirmedTransactionsByAddressEVMHistoryE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListConfirmedTransactionsByAddressEVMHistoryE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/AddressNotSynced" } ] }, "GetAddressBalanceUTXOsRI": { "type": "object", "properties": { "confirmedBalance": { "type": "object", "properties": { "amount": { "type": "string", "description": "Numeric representation of the total balance of the address", "example": "53.8163231" }, "denomination": { "type": "integer", "description": "Integer value representing the denomination of the amount from the main unit", "example": 1 }, "unit": { "type": "string", "description": "Represents the unit of the confirmed balance.", "example": "ZEC" } }, "required": [ "amount", "denomination", "unit" ] } }, "required": [ "confirmedBalance" ] }, "GetAddressBalanceUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetAddressBalanceUTXOsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetAddressBalanceUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetAddressBalanceUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetAddressBalanceUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetAddressBalanceEVMRI": { "type": "object", "properties": { "confirmedBalance": { "type": "object", "properties": { "amount": { "type": "string", "description": "Numeric representation of the total balance of the address", "example": "53.8163231" }, "unit": { "type": "string", "description": "Represents the unit of the confirmed balance.", "example": "ETH" } }, "required": [ "amount", "unit" ] } }, "required": [ "confirmedBalance" ] }, "GetAddressBalanceEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetAddressBalanceEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetAddressBalanceEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetAddressBalanceEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetAddressBalanceEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetAddressBalanceSolanaRI": { "type": "object", "properties": { "confirmedBalance": { "type": "object", "properties": { "amount": { "type": "string", "description": "Numeric representation of the total balance of the address", "example": "53.8163231" }, "unit": { "type": "string", "description": "Represents the unit of the confirmed balance.", "example": "SOL" } }, "required": [ "amount", "unit" ] } }, "required": [ "confirmedBalance" ] }, "GetAddressBalanceSolanaR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetAddressBalanceSolanaRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetAddressBalanceSolanaE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetAddressBalanceSolanaE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetAddressBalanceSolanaE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetTokenDetailsByContractAddressSolanaRI": { "type": "object", "properties": { "collection": { "type": "object", "description": "Object representation of the collection", "properties": { "address": { "type": "string", "description": "String representation of the collection's address", "example": "69k55dCTwiUPNgaTZ8FVMADorTvEGJEGuAGEB7m1qB1S" }, "verified": { "type": "string", "description": "Boolean representation of the collection's verification status", "example": "true" } }, "required": [ "address", "verified" ] }, "description": { "type": "string", "description": "String representation of the token's description", "example": "A Community Brand Capturing the Spirit of Perseverance and Ambition, in Style" }, "image": { "type": "string", "description": "String representation of the token's image", "example": "https://ipfs.io/ipfs/QmQ5TWTtXoKeupMucMUuss8pCbt3ZyyfV3frCKPjzzJXQf/8877.png" }, "name": { "type": "string", "description": "String representation of the token's name", "example": "BoDoggos #8877" }, "symbol": { "type": "string", "description": "String representation of the token's symbol", "example": "DOG" }, "type": { "type": "string", "description": "String representation of the token's type", "example": "fungible", "enum": [ "fungible", "non-fungible" ] }, "fungibleValues": { "type": "object", "properties": { "decimals": { "type": "integer", "description": "String representation of the token's decimals", "example": 0 }, "totalSupply": { "type": "integer", "description": "Represent the token total supply", "example": 1 } } } }, "required": [ "type" ] }, "GetTokenDetailsByContractAddressSolanaR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetTokenDetailsByContractAddressSolanaRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetTokenDetailsByContractAddressSolanaE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetTokenDetailsByContractAddressSolanaE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetTokenDetailsByContractAddressSolanaE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "BlockchainDataTokenDetailsNotFound": { "type": "object", "description": "blockchain_data_token_details_not_found", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "blockchain_data_token_details_not_found" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The specified token details has not been found on the specific blockchain." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "GetBlockDetailsByBlockHeightXRPRI": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "1ab0614d2a438da8b23086cbceef7d443edbd295d9c7619fc8a19c7618bc22c9" }, "height": { "type": "integer", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 15886156 }, "nextBlockHash": { "type": "string", "description": "Represents the hash of the next block. When this is the last block of the blockchain this value will be an empty string.", "example": "738cf04b9e32826395a8445aa44ec6bbb83f2cc296d94201625f3a3d6ff85a5a" }, "previousBlockHash": { "type": "string", "description": "Represents the hash of the previous block, also known as the parent block.", "example": "dcf6ade36e1d5f30b3e52605692ff47123f290f4c8915cbf5a6b7c3541f2354e" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this block was mined in Unix Timestamp.", "example": 1616069434 }, "totalCoins": { "type": "object", "description": "Represents the total Coins of the block as a string.", "properties": { "amount": { "type": "string", "description": "Represents the total amount of all Coins of the block as a string.", "example": "22.0012" }, "unit": { "type": "string", "description": "Represents the unit of total Coins of the block as a string.", "example": "Drops" } }, "required": [ "amount", "unit" ] }, "totalFees": { "type": "object", "description": "Defines the total fees included in the specific block.", "properties": { "amount": { "type": "string", "description": "Defines the amount of all fees included in the specific block.", "example": "0.004487" }, "unit": { "type": "string", "description": "Defines the unit of all fees included in the specific block.", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "transactionsCount": { "type": "integer", "description": "Represents the total number of all transactions as part of this block.", "example": 0 } }, "required": [ "hash", "height", "nextBlockHash", "previousBlockHash", "timestamp", "totalCoins", "totalFees", "transactionsCount" ] }, "GetBlockDetailsByBlockHeightXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightXRPRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetBlockDetailsByBlockHeightXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetBlockDetailsByBlockHeightXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetBlockDetailsByBlockHeightXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListTransactionsByBlockHeightUTXOsRIBSZ": { "type": "object", "properties": { "expiryHeight": { "type": "integer", "description": "Numeric representation of the transaction block height expiration", "example": 123 }, "overwintered": { "type": "boolean", "description": "\"Overwinter\" is the network upgrade for the Zcash blockchain.", "example": true }, "valueBalance": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the transaction value balance", "example": "0.123" } }, "required": [ "amount" ] }, "versionGroupId": { "type": "string", "description": "String representation of the transaction version group id", "example": "0b292f2085" } }, "description": "Zcash", "required": [ "expiryHeight", "overwintered", "valueBalance", "versionGroupId" ] }, "ListTransactionsByBlockHeightUTXOsRI": { "type": "object", "properties": { "fee": { "type": "object", "description": "Object representation of the transaction fee", "properties": { "amount": { "type": "string", "description": "String representation of the fee value", "example": "0.123" }, "unit": { "type": "string", "description": "String representation of the fee unit", "example": "ZEC" } }, "required": [ "amount", "unit" ] }, "hash": { "type": "string", "description": "Represents the unique identifier of a transaction", "example": "1ec73b0f61359927d02376b35993b756b1097cb9a857bec23da4c98c4977d2b2" }, "id": { "type": "string", "description": "Represents the unique identifier of a transaction, i.e. it could be `transactionId` in UTXO-based protocols like Bitcoin, and transaction `hash` in Ethereum blockchain.", "example": "4b66461bf88b61e1e4326356534c135129defb504c7acb2fd6c92697d79eb250" }, "locktime": { "type": "integer", "format": "int64", "description": "Numeric representation of the transaction locktime", "example": 123 }, "positionInBlock": { "type": "integer", "description": "Numeric representation of the transaction index", "example": 1 }, "size": { "type": "integer", "description": "Numeric representation of the transaction size", "example": 123 }, "timestamp": { "type": "integer", "description": "Numeric representation of the timestamp in seconds since epoch", "example": 1618208236 }, "version": { "type": "integer", "description": "Numeric representation of the transaction version", "example": 1 }, "inputs": { "type": "array", "description": "Object Array representation of transaction inputs", "items": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "String array representation of the addresses", "example": "t2UNzUUx8mWBCRYPRezvA363EYXyEpHokyi" } }, "coinbase": { "type": "string", "description": "String representation of the coinbase hex", "example": "02d3080c4e060000000000002f4e614e" }, "outputIndex": { "type": "integer", "description": "Numeric representation of the vout", "example": 1 }, "script": { "type": "object", "properties": { "type": { "type": "string", "description": "String representation of the votype", "example": "pubkeyhash" } }, "required": [ "type" ] }, "transactionId": { "type": "string", "description": "String representation of the txid", "example": "a2022151256fa5d6d3d282f3c0074456fa247da08bc07df71f8c1d9e76e7d928" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "0.002324" }, "unit": { "type": "string", "example": "ZEC" } } }, "witnesses": { "type": "array", "items": { "type": "string", "description": "Array String representation of the wintness", "example": "3045022100c11ea5740bcd69f0f68a4914279838014d28923134d18e05c5a5486dfd06cc8c02200dadccec3f07bed0d1040f9e5a155efa5fdd40fc91f92342578d26848da4c6b901" } } }, "required": [ "outputIndex", "script", "transactionId" ] } }, "outputs": { "type": "array", "description": "Object Array representation of transaction outputs", "items": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "String array representation of the addresses", "example": "t2UNzUUx8mWBCRYPRezvA363EYXyEpHokyi" } }, "isSpent": { "type": "boolean", "description": "Boolean representation of is the transaction output spent", "example": true }, "script": { "type": "object", "properties": { "type": { "type": "string", "description": "String representation of the type", "example": "pubkeyhash" } }, "required": [ "type" ] }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "0.000144" }, "unit": { "type": "string", "example": "ZEC" } } } }, "required": [ "isSpent", "script" ] } }, "recipients": { "type": "array", "description": "Object Array representation of transaction receivers", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String representation of the receiver address", "example": "yEpHokyit2UNzUUx8mWBCRYPRezvA363EYX" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "0.000144" }, "unit": { "type": "string", "example": "ZEC" } }, "required": [ "amount", "unit" ] }, "addresses": { "type": "string", "description": "String representation of the receiver address", "example": "2MzakdGTEp8SMWEHKwKM4HYv6uNCBXtHpkV" } }, "required": [ "address", "value", "addresses" ] } }, "senders": { "type": "array", "description": "Object Array representation of transaction senders", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String array representation of the sender address", "example": "t2UNzUUx8mWBCRYPRezvA363EYXyEpHokyi" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "0.00873472" }, "unit": { "type": "string", "example": "ZEC" } }, "required": [ "amount", "unit" ] }, "addresses": { "type": "string", "description": "String array representation of the sender address", "example": "2N5PcdirZUzKF9bWuGdugNuzcQrCbBudxv1" } }, "required": [ "address", "value", "addresses" ] } }, "blockchainSpecific": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightUTXOsRIBS" } }, "required": [ "fee", "hash", "id", "locktime", "positionInBlock", "size", "timestamp", "version", "inputs", "outputs", "recipients", "senders" ] }, "ListTransactionsByBlockHeightUTXOsRIBS": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ListTransactionsByBlockHeightUTXOsRIBSZ" } ] }, "ListTransactionsByBlockHeightUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightUTXOsRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListTransactionsByBlockHeightUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListTransactionsByBlockHeightUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListTransactionsByBlockHeightUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListConfirmedTransactionsByAddressFromTimestampEVMHistoryRI": { "type": "object", "properties": { "contract": { "type": "string", "description": "String representation of the transaction contract address", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7" }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the fee value", "example": "35" }, "unit": { "type": "string", "description": "String representation of the fee unit.", "example": "ETC" } }, "required": [ "amount", "unit" ] }, "gasLimit": { "type": "integer", "description": "String representation of the transaction gas limit", "example": 210000 }, "gasUsed": { "type": "integer", "description": "String representation of the transaction used gas", "example": 21000 }, "hash": { "type": "string", "description": "String representation of the transaction hash", "example": "4259f7eeb8619c7578a2f78b27dd849dba0760db2e0fa61feec0f948a20b6b3c" }, "inputData": { "type": "string", "description": "Numeric representation of the transaction input" }, "positionInBlock": { "type": "integer", "description": "Numeric representation of the transaction index", "example": 10 }, "recipient": { "type": "string", "description": "String representation of the transaction to address", "example": "0xa56e2d02db7d846091d48ef25955240365bc5efe" }, "sender": { "type": "string", "description": "String representation of the transaction from address", "example": "0xfad4a236c87880035497043f24ea58d73c3e50de" }, "status": { "type": "string", "description": "String representation of the transaction status", "example": "0x1" }, "timestamp": { "type": "integer", "description": "Numeric representation of the timestamp in seconds since epoch", "example": 1739363524 }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount value", "example": "25" }, "unit": { "type": "string", "description": "String representation of the amount unit.", "example": "ETC" } }, "required": [ "amount", "unit" ] }, "gasPrice": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the transaction gas price", "example": "123456" }, "unit": { "type": "string", "description": "String representation of the transaction price unit", "example": "WEI" } }, "required": [ "amount", "unit" ] }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "String representation of the block hash", "example": "0000000004258f50e41a9128f5b6db83ef5bed4e491c4814576acda264f5f42f" }, "height": { "type": "integer", "description": "Numeric representation of the block height", "example": 69570384 } }, "required": [ "hash", "height" ] } }, "required": [ "contract", "fee", "gasLimit", "gasUsed", "hash", "inputData", "positionInBlock", "recipient", "sender", "status", "timestamp", "value", "gasPrice", "minedInBlock" ] }, "ListConfirmedTransactionsByAddressFromTimestampEVMHistoryR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressFromTimestampEVMHistoryRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListConfirmedTransactionsByAddressFromTimestampEVMHistoryE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListConfirmedTransactionsByAddressFromTimestampEVMHistoryE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListConfirmedTransactionsByAddressFromTimestampEVMHistoryE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/AddressNotSynced" } ] }, "ListConfirmedTransactionsByAddressKaspaRI": { "type": "object", "properties": { "blocksHashes": { "type": "array", "items": { "type": "string", "description": "Array of block hashes where the transaction appears", "example": "7f9a4f8e0826e6afe73df7d2e28134a6d796caec3bb81de94aa60966a8463533" } }, "fee": { "type": "object", "description": "Transaction fee details", "properties": { "amount": { "type": "string", "description": "Fee amount", "example": "0.123" }, "denomination": { "type": "integer", "format": "int64", "description": "Fee denomination", "example": 100000000 }, "unit": { "type": "string", "description": "Fee unit", "example": "SOMPI" } }, "required": [ "amount", "denomination", "unit" ] }, "hash": { "type": "string", "description": "String representation of the transaction hash", "example": "23e520dd6004712e0f81ca37d8da37245cdc6ab47386e4bd369ebe32bd427998" }, "id": { "type": "string", "description": "String representation of the transaction ID", "example": "1c6205c801b61c3d9c46e6e6a28b643ed5fafad27d30c4c482c09b3914085b3e" }, "inputs": { "type": "array", "description": "Transaction inputs", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Input address", "example": "kaspa:qpamkvhgh0kzx50gwvvp5xs8ktmqutcy3dfs9dc3w7lm9rq0zs76vf959mmrp" }, "outputIndex": { "type": "integer", "description": "Previous output index", "example": 1 }, "transactionId": { "type": "string", "description": "Previous output transaction ID", "example": "1c6205c801b61c3d9c46e6e6a28b643ed5fafad27d30c4c482c09b3914085b3e" }, "value": { "type": "object", "description": "Input amount details", "properties": { "amount": { "type": "string", "description": "Amount value", "example": "6173541265" }, "denomination": { "type": "integer", "format": "int64", "description": "Amount denomination", "example": 100000000 }, "unit": { "type": "string", "description": "Amount unit", "example": "SOMPI" } }, "required": [ "amount", "denomination", "unit" ] } }, "required": [ "outputIndex", "transactionId", "value" ] } }, "outputs": { "type": "array", "description": "Transaction outputs", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Output address", "example": "kaspa:qpamkvhgh0kzx50gwvvp5xs8ktmqutcy3dfs9dc3w7lm9rq0zs76vf959mmrp" }, "value": { "type": "object", "description": "Output amount details", "example": "6173541265", "properties": { "amount": { "type": "string", "description": "Amount value", "example": "6173541265" }, "denomination": { "type": "integer", "format": "int64", "description": "Amount denomination", "example": 100000000 }, "unit": { "type": "string", "description": "Amount unit", "example": "SOMPI" } }, "required": [ "amount", "denomination", "unit" ] } }, "required": [ "address", "value" ] } }, "timestamp": { "type": "integer", "description": "Timestamp of the transaction", "example": 1742196610 } }, "required": [ "blocksHashes", "hash", "id", "inputs", "outputs", "timestamp" ] }, "ListConfirmedTransactionsByAddressKaspaR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressKaspaRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListConfirmedTransactionsByAddressKaspaE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListConfirmedTransactionsByAddressKaspaE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListConfirmedTransactionsByAddressKaspaE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListTransactionsByBlockHashXRPRI": { "type": "object", "properties": { "additionalData": { "type": "string", "description": "Represents any additional data that may be needed.", "example": "r4CmvbkDWGt9AZmkfuubmiSdsxGZFxAKBY" }, "destinationTag": { "type": "integer", "format": "int64", "description": "Defines a specific Tag that is an additional XRP address feature. It helps identifying a transaction recipient beyond a wallet address.", "example": 3999472835 }, "hash": { "type": "string", "description": "Represents the same as `transactionId` for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols `hash` is different from `transactionId` for SegWit transactions.", "example": "ba3bc1337071c8e73b441fe12a1911f4365d7ea82cace7c8ecba3ee9f364978b" }, "offer": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount of the offer.", "example": "8.2365" }, "unit": { "type": "string", "description": "Defines the unit of the offer.", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "positionInBlock": { "type": "integer", "description": "Represents the index position of the transaction in the specific block.", "example": 3 }, "recipient": { "type": "string", "description": "String representation of the transaction to address", "example": "rXSYHuUUrFsk8CABEf6PtrYwFWoAfUMrK" }, "sender": { "type": "string", "description": "String representation of the transaction from address", "example": "rQpVbrqNCK4dY9ENhV85z8df4jQm81uqRQ" }, "status": { "type": "string", "description": "Defines the status of the transaction.", "example": "tesSUCCESS" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.", "example": 236589 }, "type": { "type": "string", "description": "Defines the type of the transaction.", "example": "Payment" }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount of the fee.", "example": "2.0325" }, "unit": { "type": "string", "description": "Defines the unit of the fee.", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "receive": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the received amount.", "example": "6.2354" }, "unit": { "type": "string", "description": "Defines the unit of the received amount.", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount of the value.", "example": "22.023" }, "unit": { "type": "string", "description": "Defines the unit of the value.", "example": "XRP" } }, "required": [ "amount", "unit" ] } }, "required": [ "hash", "offer", "positionInBlock", "recipient", "sender", "status", "timestamp", "type", "fee", "receive", "value" ] }, "ListTransactionsByBlockHashXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListTransactionsByBlockHashXRPRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListTransactionsByBlockHashXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListTransactionsByBlockHashXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListTransactionsByBlockHashXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetLastMinedBlockEVMRI": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "0x6b1fdd6357845016fb238d1bd58992a01b01c94e668f55e9502d65f0a50ac021" }, "height": { "type": "integer", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 234324 }, "previousBlockHash": { "type": "string", "description": "Represents the hash of the previous block, also known as the parent block.", "example": "0x45ec99037b9098f402ab83fa962ba54c11b6e5e5d3a981961e0784e8edf6f2a0" }, "size": { "type": "integer", "description": "Represents the total size of the block in Bytes.", "example": 1408113 }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this block was mined in Unix Timestamp.", "example": 1681893875 }, "transactionsCount": { "type": "integer", "description": "Represents the total number of all transactions as part of this block.", "example": 23432 }, "extraData": { "type": "string", "description": "Numeric representation of the block extra data", "example": "0x45ec99037b9098f402ab83fa962ba54c11b6e5e5d3a981961e0784e8edf6f2a0" }, "gasLimit": { "type": "integer", "description": "Defines the total gas limit of all transactions in the block.", "example": 12499653 }, "gasUsed": { "type": "integer", "description": "Represents the total amount of gas used by all transactions in this block.", "example": 12488144 }, "minedInSeconds": { "type": "integer", "description": "Numeric representation of the block gas limit", "example": 7 }, "nonce": { "type": "integer", "description": "Represents a random value that can be adjusted to satisfy the proof of work", "example": 2113101077 }, "totalDifficulty": { "type": "integer", "description": "Defines the total difficulty of the chain until this block, i.e. how difficult it is for a specific miner to mine a new block.", "example": 4794080996481072 } }, "required": [ "hash", "height", "previousBlockHash", "size", "timestamp", "transactionsCount", "extraData", "gasLimit", "gasUsed", "minedInSeconds", "nonce", "totalDifficulty" ] }, "GetLastMinedBlockEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetLastMinedBlockEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetLastMinedBlockEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetLastMinedBlockEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetLastMinedBlockEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "BlockchainDataBlockNotFound": { "type": "object", "description": "blockchain_data_block_not_found", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "blockchain_data_block_not_found" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The specified block has not been found on the specific blockchain." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "GetBlockDetailsByBlockHashXRPRI": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "1ab0614d2a438da8b23086cbceef7d443edbd295d9c7619fc8a19c7618bc22c9" }, "height": { "type": "integer", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 15886156 }, "nextBlockHash": { "type": "string", "description": "Represents the hash of the next block. When this is the last block of the blockchain this value will be an empty string.", "example": "738cf04b9e32826395a8445aa44ec6bbb83f2cc296d94201625f3a3d6ff85a5a" }, "previousBlockHash": { "type": "string", "description": "Represents the hash of the previous block, also known as the parent block.", "example": "dcf6ade36e1d5f30b3e52605692ff47123f290f4c8915cbf5a6b7c3541f2354e" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this block was mined in Unix Timestamp.", "example": 1616069434 }, "totalCoins": { "type": "object", "description": "Defines the total coins.", "properties": { "amount": { "type": "string", "description": "Defines the amount of the total coins.", "example": "22.0012" }, "unit": { "type": "string", "description": "Defines the unit of the total coins.", "example": "Drops" } }, "required": [ "amount", "unit" ] }, "totalFees": { "type": "object", "description": "Defines the total fees included in the specific block.", "properties": { "amount": { "type": "string", "description": "Defines the amount of all fees included in the specific block.", "example": "0.004487" }, "unit": { "type": "string", "description": "Defines the unit of all fees included in the specific block.", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "transactionsCount": { "type": "integer", "description": "Represents the total number of all transactions as part of this block.", "example": 0 } }, "required": [ "hash", "height", "nextBlockHash", "previousBlockHash", "timestamp", "totalCoins", "totalFees", "transactionsCount" ] }, "GetBlockDetailsByBlockHashXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashXRPRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetBlockDetailsByBlockHashXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetBlockDetailsByBlockHashXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetBlockDetailsByBlockHashXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListLatestMinedBlocksXRPRI": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "f9b304b7933ef298142fdd58ad2dec414a5267dcbbd8a4fe9fc2c0a5f9dde050" }, "height": { "type": "integer", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 15975748 }, "previousBlockHash": { "type": "string", "description": "Represents the hash of the previous block, also known as the parent block.", "example": "de9f9e5b68a1322a16f0d1217cf31765e9101764e6e2f3c7aa058b8c641da37a" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this block was mined in Unix Timestamp.", "example": 1616430182 }, "totalFees": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001" }, "unit": { "type": "string", "description": "Defines the unit of the amount of all fees.", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "transactionsCount": { "type": "integer", "description": "Represents the total number of all transactions as part of this block.", "example": 1234 }, "totalCoins": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount of all coins.", "example": "12345" }, "unit": { "type": "string", "description": "Defines the unit of the amount of all coins.", "example": "Drops" } }, "required": [ "amount", "unit" ] } }, "required": [ "hash", "height", "previousBlockHash", "timestamp", "totalFees", "transactionsCount", "totalCoins" ] }, "ListLatestMinedBlocksXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListLatestMinedBlocksXRPRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListLatestMinedBlocksXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListLatestMinedBlocksXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListLatestMinedBlocksXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListLatestMinedBlocksUTXOsRI": { "type": "object", "properties": { "bits": { "type": "integer", "description": "Numeric representation of the Block bits", "example": 524517883 }, "chainwork": { "type": "integer", "description": "Numeric representation of the expected number of hashes required to produce the chain up to this block", "example": 262 }, "difficulty": { "type": "integer", "description": "Numeric representation of the block difficulty", "example": 1234567890 }, "hash": { "type": "string", "description": "Represents the same as transactionId for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols hash is different from transactionId for SegWit transactions.", "example": "3c7b39671b02df07c5c25c2ce135f3a1615acb47d01337211ece8aa5e5926b72" }, "height": { "type": "integer", "description": "Represents the hight of the block where this transaction was mined/confirmed for first time. The height is defined as the number of blocks in the blockchain preceding this specific block.", "example": 45903259 }, "merkleRoot": { "type": "string", "description": "String representation of the block merkle root", "example": "961113ae943a3abf76da307cf881c4c6b6c13efb27fb67f02c9cdb46029848e8" }, "nextBlockHash": { "type": "string", "description": "String representation of the next block hash", "example": "00000000000000000008953625613e60b56194ea31f07aad43c7505fbddce78f" }, "previousBlockHash": { "type": "string", "description": "Represents the hash of the previous block, also known as the parent block.", "example": "24057417652cd253e328ffc9a44ed3a8b0708c0c598bab73c5799505a1452e01" }, "size": { "type": "integer", "description": "Numeric representation of the block size", "example": 1681893875 }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this block was mined in Unix Timestamp.", "example": 1681893875 }, "transactionsCount": { "type": "integer", "description": "Represents the total number of all transactions as part of this block.", "example": 92 }, "version": { "type": "integer", "description": "Numeric representation of the block version", "example": 4 }, "strippedSize": { "type": "integer", "description": "Defines the numeric representation of the block size excluding the witness data.", "example": 4322 }, "versionHex": { "type": "string", "description": "Is the hexadecimal string representation of the block's version.", "example": "20000010" }, "weight": { "type": "integer", "description": "Represents a measurement to compare the size of different transactions to each other in proportion to the block size limit.", "example": 17288 } }, "required": [ "bits", "chainwork", "difficulty", "hash", "height", "merkleRoot", "previousBlockHash", "size", "timestamp", "transactionsCount", "version", "strippedSize", "versionHex", "weight" ] }, "ListLatestMinedBlocksUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListLatestMinedBlocksUTXOsRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListLatestMinedBlocksUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListLatestMinedBlocksUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListLatestMinedBlocksUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetBlockDetailsByBlockHeightEVMRI": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "0x7f44b4943a7d1b318763a97ab8f16c352578b3daa06b0d4729dd1ec6d6d657c0" }, "height": { "type": "integer", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 673852 }, "nextBlockHash": { "type": "string", "description": "Representation of the next block hash.", "example": "0x45ec99037b9098f402ab83fa962ba54c11b6e5e5d3a981961e0784e8edf6f2a0" }, "previousBlockHash": { "type": "string", "description": "Represents the hash of the previous block, also known as the parent block.", "example": "0x6b1fdd6357845016fb238d1bd58992a01b01c94e668f55e9502d65f0a50ac021" }, "size": { "type": "integer", "description": "Numeric representation of the block size", "example": 123 }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this block was mined in Unix Timestamp.", "example": 1681893875 }, "transactionsCount": { "type": "integer", "description": "Represents the total number of all transactions as part of this block.", "example": 12 }, "extraData": { "type": "string", "description": "Represents any data that can be included by the miner in the block.", "example": "0xd983010203844765746887676f312e342e328777696e646f7773" }, "gasLimit": { "type": "integer", "description": "Numeric representation of the block gas limit", "example": 3141592 }, "gasUsed": { "type": "integer", "description": "Numeric representation of the block gas used", "example": 21000 }, "minedInSeconds": { "type": "integer", "description": "Numeric representation of the block gas limit", "example": 3 }, "nonce": { "type": "integer", "description": "Numeric representation of the block nonce", "example": 2 }, "totalDifficulty": { "type": "integer", "description": "Numeric representation of the block total difficulty", "example": 201047 } }, "required": [ "hash", "height", "previousBlockHash", "size", "timestamp", "transactionsCount", "extraData", "gasLimit", "gasUsed", "minedInSeconds", "nonce", "totalDifficulty" ] }, "GetBlockDetailsByBlockHeightEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetBlockDetailsByBlockHeightEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetBlockDetailsByBlockHeightEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetBlockDetailsByBlockHeightEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListTransactionsByAddressXRPRI": { "type": "object", "properties": { "destinationTag": { "type": "integer", "format": "int64", "example": 3999472835 }, "hash": { "type": "string", "description": "Represents the hash of the XRP transaction.", "example": "33684d38ccf56f5b10a25e60b11b251abe6288f41aadd03c7596dced895b282a" }, "positionInBlock": { "type": "integer", "description": "Represents the index position of the transaction in the block.", "example": 3 }, "recipient": { "type": "string", "description": "String representation of the transaction to address", "example": "rDsbeomae4FXwgQTJp9Rs64Qg9vDiTCdBv" }, "sender": { "type": "string", "description": "String representation of the transaction from address", "example": "rpiFwLYi6Gb1ESHYorn2QG1WU5vw2u4exQ" }, "status": { "type": "string", "description": "Defines the status of the transaction.", "example": "tesSUCCESS" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.", "example": 4256894 }, "type": { "type": "string", "description": "Specifies the type of the transaction.", "example": "OfferCreate" }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount of the transaction fee.", "example": "0.000024" }, "unit": { "type": "string", "description": "Defines the unit of the transaction fee.", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the hash of the block where this transaction was mined/confirmed for first time. The hash is defined as a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "3dff3ab3697a0a3116062a92a499dc7b5c9c777b2035f79bb906894972d4573d" }, "height": { "type": "integer", "description": "Represents the hight of the block where this transaction was mined/confirmed for first time. The height is defined as the number of blocks in the blockchain preceding this specific block.", "example": 15949067 } }, "required": [ "hash", "height" ] }, "offer": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount of the offer.", "example": "5.256" }, "unit": { "type": "string", "description": "Defines the unit of the offer.", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "receive": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount received.", "example": "4.236" }, "unit": { "type": "string", "description": "Defines the unit of the amount received.", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the specific amount of the value.", "example": "22" }, "unit": { "type": "string", "description": "Defines the specific unit of the value.", "example": "XRP" } }, "required": [ "amount", "unit" ] } }, "required": [ "hash", "positionInBlock", "recipient", "sender", "status", "timestamp", "type", "fee", "minedInBlock", "offer", "receive", "value" ] }, "ListTransactionsByAddressXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListTransactionsByAddressXRPRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListTransactionsByAddressXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListTransactionsByAddressXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListTransactionsByAddressXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListTransactionsByBlockHashUTXOsRIBSZ": { "type": "object", "properties": { "expiryHeight": { "type": "integer", "description": "Represents a block height after which the transaction will expire.", "example": 1 }, "overwintered": { "type": "boolean", "description": "\"Overwinter\" is the network upgrade for the Zcash blockchain.", "example": true }, "valueBalance": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the transaction value balance.", "example": "0" } }, "required": [ "amount" ] }, "versionGroupId": { "type": "string", "description": "Represents the transaction version group ID.", "example": "0x892f2085" } }, "description": "Zcash", "required": [ "expiryHeight", "overwintered", "valueBalance", "versionGroupId" ] }, "ListTransactionsByBlockHashUTXOsRI": { "type": "object", "properties": { "id": { "type": "string", "description": "Represents the unique identifier of a transaction, i.e. it could be `transactionId` in UTXO-based protocols like Bitcoin, and transaction `hash` in Ethereum blockchain.", "example": "4340d9463f0a5e3b3bc5844c17af78e20fa141f976f20732de630b0e6e4cd571" }, "locktime": { "type": "integer", "format": "int64", "description": "Represents the time at which a particular transaction can be added to the blockchain.", "example": 1781965 }, "size": { "type": "integer", "description": "Represents the total size of this transaction.", "example": 234 }, "version": { "type": "integer", "description": "Numeric representation of the transaction Represents the transaction version number.", "example": 1 }, "fee": { "type": "object", "description": "Object representation of the transaction fee", "properties": { "amount": { "type": "string", "description": "Represents the fee amount.", "example": "0.00016932" }, "unit": { "type": "string", "description": "Defines the specific unit of the fee.", "example": "ZEC" } }, "required": [ "amount", "unit" ] }, "hash": { "type": "string", "description": "Represents the same as `transactionId` for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols `hash` is different from `transactionId` for SegWit transactions.", "example": "273eac351a2b76bb98196f3b310eabc787758cf157e8abe726250447185956ed" }, "inputs": { "type": "array", "description": "Object Array representation of transaction inputs", "items": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "Represents the addresses which send/receive the amount.", "example": "tmGf1r6Bo9HFdssAcFpYPehzcn1QyfurEeH" } }, "coinbase": { "type": "string", "description": "Represents the coinbase hex.", "example": "02d3080c4e060000000000002f4e614e" }, "oututIndex": { "type": "integer", "description": "It refers to the index of the output address of this transaction. The index starts from 0.", "example": 1 }, "script": { "type": "object", "properties": { "type": { "type": "string", "description": "String representation of the votype", "example": "scripthash" } }, "required": [ "type" ] }, "transactionId": { "type": "string", "description": "Represents the reference transaction identifier.", "example": "a2022151256fa5d6d3d282f3c0074456fa247da08bc07df71f8c1d9e76e7d928" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the specific amount.", "example": "0.000144" }, "unit": { "type": "string", "description": "String representation of the input value unit", "example": "ZEC" } } }, "witnesses": { "type": "array", "items": { "type": "string", "description": "Represents an array hex-encoded witness data (if there is any) as strings.", "example": "3045022100c11ea5740bcd69f0f68a4914279838014d28923134d18e05c5a5486dfd06cc8c02200dadccec3f07bed0d1040f9e5a155efa5fdd40fc91f92342578d26848da4c6b901" } }, "outputIndex": { "type": "integer", "description": "It refers to the index of the output address of this transaction. The index starts from 0.", "example": 1 } }, "required": [ "oututIndex", "script", "transactionId", "witnesses", "outputIndex" ] } }, "outputs": { "type": "array", "description": "Object Array representation of transaction outputs", "items": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "Represents the addresses which send the amount.", "example": "t2UNzUUx8mWBCRYPRezvA363EYXyEpHokyi" } }, "isSpent": { "type": "boolean", "description": "Defines whether the transaction output has been spent or not.", "example": true }, "script": { "type": "object", "properties": { "type": { "type": "string", "description": "String representation of the type", "example": "scripthash" } }, "required": [ "type" ] }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the specific amount.", "example": "0.000144" }, "unit": { "type": "string", "description": "String representation of the output value unit", "example": "ZEC" } } } }, "required": [ "isSpent", "script" ] } }, "positionInBlock": { "type": "integer", "description": "Represents the index position of the transaction in the specific block.", "example": 1 }, "recipients": { "type": "array", "description": "Represents a list of recipient addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.", "example": "mvuvhgT5DUjpQ2LBWQhujiFGDZiDHGdHa7" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the amount received to this address.", "example": "0.00476076" }, "unit": { "type": "string", "description": "String representation of the recipient unit", "example": "ZEC" } }, "required": [ "amount", "unit" ] } }, "required": [ "address", "value" ] } }, "senders": { "type": "array", "description": "Represents a list of sender addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address which sends this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one sender.", "example": "n3NFmt8ibu1FnUqxexrVg4psg88Sx2PMsv" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the total amount sent by this address including the fee.", "example": "0.00572702" }, "unit": { "type": "string", "description": "String representation of the senders unit", "example": "ZEC" } }, "required": [ "amount", "unit" ] } }, "required": [ "address", "value" ] } }, "blockchainSpecific": { "$ref": "#/components/schemas/ListTransactionsByBlockHashUTXOsRIBS" } }, "required": [ "id", "locktime", "size", "version", "fee", "hash", "inputs", "outputs", "positionInBlock", "recipients", "senders" ] }, "ListTransactionsByBlockHashUTXOsRIBS": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ListTransactionsByBlockHashUTXOsRIBSZ" } ] }, "ListTransactionsByBlockHashUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListTransactionsByBlockHashUTXOsRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListTransactionsByBlockHashUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListTransactionsByBlockHashUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListTransactionsByBlockHashUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetNextAvailableNonceEVMRI": { "type": "object", "properties": { "nextAvailableNonce": { "type": "integer", "format": "int64", "description": "Represents the sequential running number for an address, starting from 0 for the first transaction. E.g., if the nonce of a transaction is 10, it would be the 11th transaction sent from the sender's address.", "example": 16 } }, "required": [ "nextAvailableNonce" ] }, "GetNextAvailableNonceEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetNextAvailableNonceEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetNextAvailableNonceEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetNextAvailableNonceEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetNextAvailableNonceEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListInternalTransactionsByAddressEVMRI": { "type": "object", "properties": { "transactionHash": { "type": "string", "description": "Defines the specific hash of the parent transaction.", "example": "0x5d4ea0471b70de09fa3d6a4bc32f703ec44483bffa4d6169fa0a36c6a1dc108a" }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the hash of the block where this transaction was mined/confirmed for first time. The hash is defined as a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "0x85ce0aa9628726c60db14526be8a2b823084b1f4c3dcccdc10b0235f23a49e66" }, "height": { "type": "integer", "description": "Numeric representation of the block height", "example": 69567970 } }, "required": [ "hash", "height" ] }, "operationId": { "type": "string", "description": "String representation of internal transaction type trace address", "example": "call_0_0" }, "operationType": { "type": "string", "description": "String representation of internal transaction type", "example": "CALL" }, "recipient": { "type": "string", "description": "String representation of the internal transaction recipient", "example": "TRpc3xTyUH7vX45XptZyHEBNoUqDteGoRm" }, "sender": { "type": "string", "description": "String representation of the internal transaction sender", "example": "TJ5usJLLwjwn7Pw3TPbdzreG7dvgKzfQ5y" }, "timestamp": { "type": "integer", "description": "Numeric representation of the timestamp in seconds since epoch", "example": 1739356303 }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount that was transacted", "example": "39" }, "unit": { "type": "string", "description": "String representation of the value unit", "example": "TRX" } }, "required": [ "amount", "unit" ] } }, "required": [ "transactionHash", "minedInBlock", "operationId", "operationType", "recipient", "sender", "timestamp", "value" ] }, "ListInternalTransactionsByAddressEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListInternalTransactionsByAddressEVMRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListInternalTransactionsByAddressEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListInternalTransactionsByAddressEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListInternalTransactionsByAddressEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "PrepareATransactionFromAnAddressInHDWalletXPubYPubZPubEVMRI": { "type": "object", "properties": { "derivationIndex": { "type": "integer", "format": "int64", "description": "Representation of the derivation index of the xpub address", "example": 0 }, "fee": { "type": "object", "description": "When isConfirmed is True - Defines the amount of the transaction fee When isConfirmed is False - For ETH-based blockchains this attribute represents the max fee value.", "properties": { "unit": { "type": "string", "example": "WEI" }, "maxFeePerGas": { "type": "integer", "description": "Representation of the max fee per gas value", "example": 2000000008 }, "maxPriorityFeePerGas": { "type": "integer", "description": "Representation of the max priority fee per gas value", "example": 2000000000 } }, "required": [ "unit" ] }, "gasLimit": { "type": "integer", "description": "Represents the amount of gas used by this specific transaction alone.", "example": 552020 }, "gasPrice": { "type": "integer", "description": "Represents the price offered to the miner to purchase this amount of gas.", "example": 2500000007 }, "inputData": { "type": "string", "description": "Representation of the data in hex value", "example": "0x0079006f00750072004100640064006900740069006f006e0061006c00440061007400610048006500720065" }, "nonce": { "type": "integer", "description": "Represents the sequential running number for an address, starting from 0 for the first transaction. E.g., if the nonce of a transaction is 10, it would be the 11th transaction sent from the sender's address.", "example": 0 }, "recipient": { "type": "string", "description": "Represents a recipient addresses. In account-based protocols like Ethereum there is only one address in this list.", "example": "0x041c594a0cc194e826bef5411b29c7f27001b7e3" }, "sender": { "type": "string", "description": "Represents a sender address with the respective amount. In account-based protocols like Ethereum there is only one address in this list.", "example": "0x03654A9E78771442CAdf8DB37ae60D6a12bAEa9f" }, "sigHash": { "type": "string", "description": "Representation of the hash that should be signed.", "example": "40738814e379fd2b1923729c87ac80dddc6810a3f8f02fef05452251972ec83a" }, "value": { "type": "object", "properties": { "amount": { "type": "integer", "description": "Representation of the amount of the transaction", "example": 0 }, "unit": { "type": "string", "description": "Represents the unit of the amount to be sent.", "example": "WEI" } }, "required": [ "amount", "unit" ] }, "type": { "type": "string", "description": "Representation of the transaction type", "example": "legacy-transaction", "enum": [ "legacy-transaction", "access-list-transaction", "gas-fee-market-transaction" ] } }, "required": [ "derivationIndex", "fee", "gasLimit", "gasPrice", "inputData", "nonce", "recipient", "sender", "sigHash", "value", "type" ] }, "PrepareATransactionFromAnAddressInHDWalletXPubYPubZPubEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/PrepareATransactionFromAnAddressInHDWalletXPubYPubZPubEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "PrepareATransactionFromAnAddressInHDWalletXPubYPubZPubEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "PrepareATransactionFromAnAddressInHDWalletXPubYPubZPubEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "PrepareATransactionFromAnAddressInHDWalletXPubYPubZPubEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListSyncedAddressesUTXORI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address.", "example": "bc1qtg5t0lvvjt0aw8dypeu9rnrecz0hyehsy6ppew" }, "index": { "type": "integer", "format": "int64", "description": "Represents the index position of the transaction in the specific block.", "example": 1 } }, "required": [ "address", "index" ] }, "ListSyncedAddressesUTXOR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListSyncedAddressesUTXORI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListSyncedAddressesUTXOE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListSyncedAddressesUTXOE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "ListSyncedAddressesUTXOE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListHDWalletXPubYPubZPubTransactionsUTXORI": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the same as `transactionId` for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols `hash` is different from `transactionId` for SegWit transactions.", "example": "1ec73b0f61359927d02376b35993b756b1097cb9a857bec23da4c98c4977d2b2" }, "id": { "type": "string", "description": "Represents the unique identifier of a transaction, i.e. it could be `transactionId` in UTXO-based protocols like Bitcoin, and transaction `hash` in Ethereum blockchain.", "example": "4b66461bf88b61e1e4326356534c135129defb504c7acb2fd6c92697d79eb250" }, "positionInBlock": { "type": "integer", "description": "Represents the index position of the transaction in the block.", "example": 1 }, "recipients": { "type": "array", "description": "Represents a list of recipient addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.", "example": "2MzakdGTEp8SMWEHKwKM4HYv6uNCBXtHpkV" }, "isMember": { "type": "boolean", "description": "Defines whether an address is a child address derived from the HD wallet (xPub, yPub, zPub) as boolean.", "example": false }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the amount received to this address.", "example": "0.000144" } }, "required": [ "amount" ] } }, "required": [ "address", "isMember", "value" ] } }, "senders": { "type": "array", "description": "Represents a list of sender addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address which sends this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one sender.", "example": "2N5PcdirZUzKF9bWuGdugNuzcQrCbBudxv1" }, "isMember": { "type": "boolean", "description": "Defines whether an address is a child address derived from the HD wallet (xPub, yPub, zPub) as boolean.", "example": true }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the amount sent by this address.", "example": "0.00873472" } }, "required": [ "amount" ] } }, "required": [ "address", "isMember", "value" ] } }, "timestamp": { "type": "integer", "description": "Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.", "example": 1582202940 }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount of the transaction fee.", "example": "0.00016932" } }, "required": [ "amount" ] }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the hash of the block where this transaction was mined/confirmed for first time. The hash is defined as a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "00000000407f119ecb74b44229228910400aaeb9f4e3b9869955b85a53e9b7db" }, "height": { "type": "integer", "format": "int64", "description": "Represents the hight of the block where this transaction was mined/confirmed for first time. The height is defined as the number of blocks in the blockchain preceding this specific block.", "example": 1903849 } }, "required": [ "hash", "height" ] } }, "required": [ "hash", "id", "positionInBlock", "recipients", "senders", "timestamp", "fee", "minedInBlock" ] }, "ListHDWalletXPubYPubZPubTransactionsUTXOR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsUTXORI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListHDWalletXPubYPubZPubTransactionsUTXOE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListHDWalletXPubYPubZPubTransactionsUTXOE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "ListHDWalletXPubYPubZPubTransactionsUTXOE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListHDWalletXPubYPubZPubTransactionsUTXOE422": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestBodyStructure" }, { "$ref": "#/components/schemas/XpubSyncInProgress" } ] }, "EstimateTransactionSmartFeeUTXOsRI": { "type": "object", "properties": { "confirmationTarget": { "type": "integer", "format": "int64", "description": "Represents the confirmation target in blocks", "example": 2 }, "feeRate": { "type": "string", "description": "Represents the Fee Rate value.", "example": "0.00001" }, "unit": { "type": "string", "description": "Defines the fee unit.", "example": "BTC" } }, "required": [ "confirmationTarget", "feeRate", "unit" ] }, "EstimateTransactionSmartFeeUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/EstimateTransactionSmartFeeUTXOsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "EstimateTransactionSmartFeeUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "EstimateTransactionSmartFeeUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "EstimateTransactionSmartFeeUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "Unimplemented": { "type": "object", "description": "unimplemented", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "unimplemented" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "This {feature} has not been implemented yet." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "ListHDWalletXPubYPubZPubUTXOsRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "muZxmnQiz8gZgpYmUoTHpD2CFTHWYEjTwB" }, "addressPath": { "type": "string", "description": "Defines a data which tells a Hierarchical Deterministic wallet how to derive a specific key within a tree of keys.", "example": "m/0/5" }, "derivation": { "type": "string", "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "ACCOUNT" }, "index": { "type": "integer", "description": "Represents the output index. It refers to the UTXO sequence in the transaction outputs (vout).", "example": 1 }, "isAvailable": { "type": "boolean", "description": "Represents if the UTXO has been used from another unconfirmed transaction. If it is - the value will be \"false\".", "example": true }, "isConfirmed": { "type": "boolean", "description": "Represents the state of the transaction whether it is confirmed or not confirmed.", "example": true }, "transactionId": { "type": "string", "description": "Represents the unique identifier of a transaction, i.e. it could be transactionId in UTXO-based protocols like Bitcoin, and transaction hash in Ethereum blockchain.", "example": "06af8234602b97f497496039a6eb99810db1287ce8aa3c501894dcd03bd4e544" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the UTXO amount value.", "example": "0.0005" } }, "required": [ "amount" ] } }, "required": [ "address", "addressPath", "derivation", "index", "isAvailable", "isConfirmed", "transactionId", "value" ] }, "ListHDWalletXPubYPubZPubUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubUTXOsRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListHDWalletXPubYPubZPubUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListHDWalletXPubYPubZPubUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/XpubNotSynced" } ] }, "ListHDWalletXPubYPubZPubUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListHDWalletXPubYPubZPubUTXOsE422": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestBodyStructure" }, { "$ref": "#/components/schemas/XpubSyncInProgress" } ] }, "ListConfirmedTokensTransfersByAddressEVMRI": { "type": "object", "properties": { "recipient": { "type": "string", "description": "Defines the address to which the recipient receives the transferred tokens.", "example": "0xc6d46aba0c6e2eb6358c4e24804158cc4d847922" }, "sender": { "type": "string", "description": "Defines the address from which the sender transfers tokens.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, "timestamp": { "type": "integer", "description": "Defines the specific time/date when the transaction was created in Unix Timestamp.", "example": 1615861410 }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the fee value of the transaction in which the token transfer happened", "example": "0.003" }, "unit": { "type": "string", "description": "Unit of the fee amount", "example": "ETH" } }, "required": [ "amount", "unit" ] }, "tokenData": { "type": "object", "properties": { "name": { "type": "string", "description": "String representation of the token name", "example": "Tether USD" }, "nonFungibleValues": { "type": "object", "properties": { "tokenId": { "type": "string", "description": "String representation of the token id", "example": "16722" } } }, "symbol": { "type": "string", "description": "String representation of the token symbol", "example": "Tether" }, "contractAddress": { "type": "string", "description": "String representation of contract address of the token that was transfered", "example": "0x534bD102153EF199abAe8296a2FaE4599fC44Cdc" }, "fungibleValues": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the token amount that was transfered", "example": "9.146383" }, "decimals": { "type": "integer", "description": "String representation of the token decimals", "example": 18 } }, "required": [ "amount", "decimals" ] }, "standard": { "type": "string", "description": "String representation of the token type", "example": "ERC-20" } }, "required": [ "name", "symbol", "contractAddress", "fungibleValues", "standard" ] }, "transactionHash": { "type": "string", "description": "String representation of the hash of the transaction in which the token transfer happened", "example": "0x6474b1c189c7cbfe844d0021c8a867e170f67b915a80b08ec372539702308e54" }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "example": "000000000425a9f370833e3e61d9fff351ad1c54835aea0fa4b288f7a04f1462" }, "height": { "type": "integer", "format": "int64", "description": "Numeric representation of the block height of the transaction in which the token transfer happened", "example": 12046964 } }, "required": [ "hash", "height" ] } }, "required": [ "recipient", "sender", "timestamp", "fee", "tokenData", "transactionHash", "minedInBlock" ] }, "ListConfirmedTokensTransfersByAddressEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListConfirmedTokensTransfersByAddressEVMRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListConfirmedTokensTransfersByAddressEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListConfirmedTokensTransfersByAddressEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListConfirmedTokensTransfersByAddressEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "DeriveAndSyncNewChangeAddressesUTXORI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0x5050F69a9786F081509234F1a7F4684b5E5b76C9" }, "format": { "type": "string", "description": "Represents the format of the address.", "example": "P2WPKH" }, "index": { "type": "integer", "description": "Represent the address derivation index", "example": 1 }, "derivationType": { "type": "string", "description": "Represents the derivation type", "example": "bip32", "enum": [ "account", "bip32" ] }, "type": { "type": "string", "description": "Defines the address type.", "example": "change", "enum": [ "change" ] } }, "required": [ "address", "format", "index", "derivationType", "type" ] }, "DeriveAndSyncNewChangeAddressesUTXOR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeriveAndSyncNewChangeAddressesUTXORI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "DeriveAndSyncNewChangeAddressesUTXOE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "DeriveAndSyncNewChangeAddressesUTXOE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "DeriveAndSyncNewChangeAddressesUTXOE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListHDWalletXPubYPubZPubTransactionsXRPRI": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the same as `transactionId` for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols `hash` is different from `transactionId` for SegWit transactions.", "example": "1ec73b0f61359927d02376b35993b756b1097cb9a857bec23da4c98c4977d2b2" }, "positionInBlock": { "type": "integer", "description": "Represents the index position of the transaction in the block.", "example": 1 }, "recipient": { "type": "array", "description": "Represents a list of recipient addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.", "example": "2MzakdGTEp8SMWEHKwKM4HYv6uNCBXtHpkV" }, "isMember": { "type": "boolean", "description": "Defines whether an address is a child address derived from the HD wallet (xPub, yPub, zPub) as boolean.", "example": false }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the amount received to this address in XRP units", "example": "0.000144" } }, "required": [ "amount" ] } }, "required": [ "address", "isMember", "value" ] } }, "sender": { "type": "array", "description": "Represents a list of sender addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address which sends this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one sender.", "example": "2N5PcdirZUzKF9bWuGdugNuzcQrCbBudxv1" }, "isMember": { "type": "boolean", "description": "Defines whether an address is a child address derived from the HD wallet (xPub, yPub, zPub) as boolean.", "example": true }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the amount sent by this address.", "example": "0.00873472" } }, "required": [ "amount" ] } }, "required": [ "address", "isMember", "value" ] } }, "timestamp": { "type": "integer", "description": "Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.", "example": 1582202940 }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount of the transaction fee in XRP units", "example": "0.00016932" } }, "required": [ "amount" ] }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the hash of the block where this transaction was mined/confirmed for first time. The hash is defined as a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "00000000407f119ecb74b44229228910400aaeb9f4e3b9869955b85a53e9b7db" }, "height": { "type": "integer", "format": "int64", "description": "Represents the hight of the block where this transaction was mined/confirmed for first time. The height is defined as the number of blocks in the blockchain preceding this specific block.", "example": 1903849 } }, "required": [ "hash", "height" ] } }, "required": [ "hash", "positionInBlock", "recipient", "sender", "timestamp", "fee", "minedInBlock" ] }, "ListHDWalletXPubYPubZPubTransactionsXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsXRPRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListHDWalletXPubYPubZPubTransactionsXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListHDWalletXPubYPubZPubTransactionsXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" }, { "$ref": "#/components/schemas/InvalidBlockchain" }, { "$ref": "#/components/schemas/InvalidNetwork" }, { "$ref": "#/components/schemas/XpubNotSynced" } ] }, "ListHDWalletXPubYPubZPubTransactionsXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListHDWalletXPubYPubZPubTransactionsXRPE422": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestBodyStructure" }, { "$ref": "#/components/schemas/XpubSyncInProgress" } ] }, "DeriveAndSyncNewReceivingAddressesEVMRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0x5050F69a9786F081509234F1a7F4684b5E5b76C9" }, "format": { "type": "string", "description": "Represents the format of the address.", "example": "P2WPKH" }, "index": { "type": "integer", "description": "Represent the address derivation index", "example": 1 }, "derivationType": { "type": "string", "description": "Represents the derivation type", "example": "bip32", "enum": [ "account", "bip32" ] }, "type": { "type": "string", "description": "Defines the address type.", "example": "change", "enum": [ "change" ] } }, "required": [ "address", "format", "index", "derivationType", "type" ] }, "DeriveAndSyncNewReceivingAddressesEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesEVMRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "DeriveAndSyncNewReceivingAddressesEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "DeriveAndSyncNewReceivingAddressesEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "DeriveAndSyncNewReceivingAddressesEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListSyncedAddressesEVMRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address.", "example": "0x9e91eb3a35b96f0f0fe71f3c17fe8d29eb406b16" }, "index": { "type": "integer", "format": "int64", "description": "Represents derivation index of the address in the xpub", "example": 1 } }, "required": [ "address", "index" ] }, "ListSyncedAddressesEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListSyncedAddressesEVMRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListSyncedAddressesEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListSyncedAddressesEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "ListSyncedAddressesEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetHDWalletXPubYPubZPubAssetsEVMRI": { "type": "object", "properties": { "confirmedBalance": { "type": "string", "description": "Specifies the confirmed coins balance of the Wallet.", "example": "0.0021" }, "fungibleTokens": { "type": "array", "description": "Represents fungible tokens'es detailed information", "items": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount of the fungible tokens.", "example": "0.100000000000000000" }, "contractAddress": { "type": "string", "description": "Represents tokens' contract address.", "example": "0x101848d5c5bbca18e6b4431eedf6b95e9adf82fa" }, "standard": { "type": "string", "description": "Defines the specific token type.", "example": "ERC-20" }, "symbol": { "type": "string", "description": "Defines the symbol of the fungible token.", "example": "WEENUS" } }, "required": [ "amount", "contractAddress", "standard", "symbol" ] } }, "nonFungibleTokens": { "type": "array", "description": "Represents non-fungible tokens'es detailed information.", "items": { "type": "object", "properties": { "contractAddress": { "type": "string", "description": "Represents tokens' contract address.", "example": "0x90ca8a3eb2574f937f514749ce619fdcca187d45" }, "standard": { "type": "string", "description": "Defines the specific token type.", "example": "ERC-721" }, "symbol": { "type": "string", "description": "Defines the symbol of the non-fungible token.", "example": "GA" }, "tokenId": { "type": "string", "description": "Represents tokens' unique identifier.", "example": "0x000000000000000000000000000000000000000000000000000000000000195b" } }, "required": [ "contractAddress", "standard", "symbol", "tokenId" ] } }, "totalReceived": { "type": "string", "description": "Defines the total currency received to the Wallet.", "example": "0.0002" }, "totalSpent": { "type": "string", "description": "Defines the total currency spent from the Wallet.", "example": "0.0001" }, "unit": { "type": "string", "example": "ETH" } }, "required": [ "confirmedBalance", "fungibleTokens", "nonFungibleTokens", "totalReceived", "totalSpent", "unit" ] }, "GetHDWalletXPubYPubZPubAssetsEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetHDWalletXPubYPubZPubAssetsEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetHDWalletXPubYPubZPubAssetsEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "GetHDWalletXPubYPubZPubAssetsEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetHDWalletXPubYPubZPubAssetsEVME422": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestBodyStructure" }, { "$ref": "#/components/schemas/XpubSyncInProgress" } ] }, "GetTransactionDetailsByTransactionHashSolanaRI": { "type": "object", "properties": { "fee": { "type": "object", "description": "Object representation of the fee's amount & unit", "properties": { "amount": { "type": "string", "description": "String representation of the transaction's fee amount", "example": "0.000010702" }, "unit": { "type": "string", "description": "String representation of the transaction's fee unit (ex. SOL)", "example": "SOL", "enum": [ "SOL" ] } }, "required": [ "amount", "unit" ] }, "nativeBalanceChanges": { "type": "array", "description": "Object Array representation of the transactions native (SOL) balance changes of each address", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String representation of the balance change address", "example": "5yZiE74sGLCT4uRoyeqz4iTYiUwX5uykiPRggCVih9PN" }, "after": { "type": "string", "description": "String representation of the balance change after the transaction", "example": "100" }, "before": { "type": "string", "description": "String representation of the balance change before the transaction", "example": "150" }, "change": { "type": "string", "description": "String representation of the balance change calculated", "example": "50" }, "type": { "type": "string", "description": "String representation of the balance change type", "example": "native" }, "unit": { "type": "string", "description": "String representation of the balance change unit (ex. SOL)", "example": "SOL" } }, "required": [ "address", "after", "before", "change", "unit" ] } }, "nativeMovements": { "type": "array", "description": "Object Array representation of the transactions native movements", "items": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the movement asset amount", "example": "10" }, "recipientAddress": { "type": "string", "description": "String representation of the movement recipient address", "example": "DUVULQ5bLhvrMwV6BzqPPEQ9RYJ2pVkqwmByBTESTpVf" }, "senderAddress": { "type": "string", "description": "String representation of the movement sender address", "example": "DUVULQ5bLhvrMTEstBzqPPEQ9RYJ2pVkqwmByBHKNGpVf" }, "unit": { "type": "string", "description": "String representation of the movement token's unit", "example": "SOL", "enum": [ "SOL" ] } }, "required": [ "amount", "recipientAddress", "senderAddress", "unit" ] } }, "signature": { "type": "string", "description": "String representation of the transaction's signature", "example": "2KGuERep8VNbpDbyLxxXKV8uFik5ECSx5zrRAgUyzAbGCXGVg2Xb62Yda8TVD3xjxsmGkSNDSm5cVstgLjfnmte5" }, "signer": { "type": "string", "description": "String representation of the transaction's signer", "example": "DCAKxn5PFNN1mBREPWGdk1RXg5aVH9rPErLfBFEi2Emb" }, "timestamp": { "type": "integer", "format": "int64", "description": "Numeric representation of the transaction's timestamp", "example": 1712821685 }, "tokenBalanceChanges": { "type": "array", "description": "Object Array representation of the transactions token (SPL) balance changes of each address and token", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String representation of the balance change address", "example": "DUVULQ5bLhvrMwV6BzqPPEQ9RYJ2pVkqwmByBHKNGpVf" }, "after": { "type": "string", "description": "String representation of the balance change after the transaction", "example": "50" }, "before": { "type": "string", "description": "String representation of the balance change before the transaction", "example": "50" }, "change": { "type": "string", "description": "String representation of the balance change calculated", "example": "100" }, "contractAddress": { "type": "string", "description": "String representation of the balance change token's contract address (also called mint)", "example": "Dn4noZ5jgGfkntzcQSUZ8czkreiZ1ForXYoV2H8Dm7S1" }, "tokenAddress": { "type": "string", "description": "String representation of the balance change token address (also called mint)", "example": "DUVULQ5bLhvrMwV6BzqPPEQ9RYJ2pVkqwmByBHKNGpVf" }, "type": { "type": "string", "description": "String representation of the balance change type", "example": "spl" } }, "required": [ "after", "before", "change", "contractAddress", "tokenAddress" ] } }, "tokenMovements": { "type": "array", "description": "Object Array representation of the transactions token movements", "items": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the movement asset amount", "example": "10" }, "contractAddress": { "type": "string", "description": "String representation of the movement contract's address (also called mint)", "example": "Dn4noZ5jgGfkntzcQSUZ8czkreiZ1ForXYoV2H8Dm7S1" }, "recipientAddress": { "type": "string", "description": "String representation of the movement recipient address", "example": "DUVULQ5bLhvrMwV6BzqPPEQ9RYJ2pVkqwmByBTESTpVf" }, "recipientTokenAddress": { "type": "string", "description": "String representation of the movement recipient token address", "example": "3m15qNJDM5zydsYNJzkFYXE7iGCVnkKz1mrmbawrDUAH" }, "senderAddress": { "type": "string", "description": "String representation of the movement sender address", "example": "DUVULQ5bLhvrMTEstBzqPPEQ9RYJ2pVkqwmByBHKNGpVf" }, "senderTokenAddress": { "type": "string", "description": "String representation of the movement sender token address", "example": "DUVULQ5bLhvrMwV6BzqPPEQ9RYJ2pVkqwmByBHKNGpVf" } }, "required": [ "amount", "contractAddress", "recipientAddress", "senderAddress" ] } }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "String representation of the transaction's block hash", "example": "ByacH5PR9vSBwHyc6R1Rt2THzGGZd3DqwhgEcUfSKG5C" }, "height": { "type": "integer", "format": "int64", "description": "Numeric representation of the transaction's block height", "example": 259495121 } }, "required": [ "hash", "height" ] } }, "required": [ "fee", "nativeBalanceChanges", "nativeMovements", "signature", "signer", "timestamp", "tokenBalanceChanges", "tokenMovements", "minedInBlock" ] }, "GetTransactionDetailsByTransactionHashSolanaR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashSolanaRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetTransactionDetailsByTransactionHashSolanaE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetTransactionDetailsByTransactionHashSolanaE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetTransactionDetailsByTransactionHashSolanaE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "BlockchainDataTransactionNotFound": { "type": "object", "description": "blockchain_data_transaction_not_found", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "blockchain_data_transaction_not_found" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The specified transaction has not been found on the specific blockchain." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "DeriveHDWalletXPubYPubZPubChangeOrReceivingAddressesRI": { "type": "object", "properties": { "addresses": { "type": "array", "description": "Represents the address details.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "muZxmnQiz8gZgpYmUoTHpD2CFTHWYEjTwB" }, "index": { "type": "integer", "format": "int64", "description": "Represents the output index. It refers to the UTXO sequence in the transaction outputs (vout).", "example": 1 } }, "required": [ "address", "index" ] } } }, "required": [ "addresses" ] }, "DeriveHDWalletXPubYPubZPubChangeOrReceivingAddressesR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DeriveHDWalletXPubYPubZPubChangeOrReceivingAddressesRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "DeriveHDWalletXPubYPubZPubChangeOrReceivingAddressesE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "DeriveHDWalletXPubYPubZPubChangeOrReceivingAddressesE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidBlockchain" }, { "$ref": "#/components/schemas/InvalidNetwork" } ] }, "DeriveHDWalletXPubYPubZPubChangeOrReceivingAddressesE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetHDWalletXPubYPubZPubDetailsXRPRI": { "type": "object", "properties": { "confirmedBalance": { "type": "string", "description": "Specifies the confirmed coins balance of the Wallet.", "example": "0.0021" }, "totalReceived": { "type": "string", "description": "Defines the total currency received to the Wallet.", "example": "0.0002" }, "totalSpent": { "type": "string", "description": "Defines the total currency spent from the Wallet.", "example": "0.0001" }, "unit": { "type": "string", "example": "XRP" } }, "required": [ "confirmedBalance", "unit" ] }, "GetHDWalletXPubYPubZPubDetailsXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsXRPRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetHDWalletXPubYPubZPubDetailsXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetHDWalletXPubYPubZPubDetailsXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" }, { "$ref": "#/components/schemas/InvalidBlockchain" }, { "$ref": "#/components/schemas/InvalidNetwork" }, { "$ref": "#/components/schemas/XpubNotSynced" } ] }, "GetHDWalletXPubYPubZPubDetailsXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetHDWalletXPubYPubZPubDetailsXRPE422": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestBodyStructure" }, { "$ref": "#/components/schemas/XpubSyncInProgress" } ] }, "DecodeRawTransactionHexEVMRIBSE": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "maxFeePerGas": { "type": "string", "description": "Defines the maximum amount that customer is willing to pay per unit of gas to get his transaction included in a block.", "example": "0.000000149248157973" }, "maxPrioriryFeePerGas": { "type": "string", "description": "Represents determined by the user value that is paid directly to miners.", "example": "0.000000002" }, "unit": { "type": "string", "description": "String representation of the fee unit", "example": "ETH" } }, "required": [ "unit" ] } }, "description": "Ethereum" }, "DecodeRawTransactionHexEVMRI": { "type": "object", "properties": { "id": { "type": "string", "description": "Represents the decoded transaction hex.", "example": "00a8a090a7c78f64e4626e6720b305edd95fcd7865b5b45864a88070a8079cea" }, "gasLimit": { "type": "integer", "description": "Represents the amount of gas used by this specific transaction alone.", "example": 552020 }, "gasPaidForData": { "type": "integer", "description": "Represents the amount of gas paid for the data in the transaction.", "example": 0 }, "inputData": { "type": "string", "description": "Represents additional information that is required for the transaction.", "example": "0x67a5cd0600000000000000000000000031f42841c2db5173425b5223809cf3a38fede360" }, "nonce": { "type": "integer", "description": "Represents the sequential running number for an address, starting from 0 for the first transaction.", "example": 1 }, "r": { "type": "string", "description": "Represents output of an ECDSA signature.", "example": "0xc297031972fe2d4926e01e66768d669882ace256f8a8397f757af341f5e7c499" }, "recipient": { "type": "string", "description": "The address which receives this transaction", "example": "0xd30b438df65f4f788563b2b3611bd6059bff4ad9" }, "s": { "type": "string", "description": "Represents output of an ECDSA signature.", "example": "0x7b717faa31c5edf9332e1cd5fa3f736838a9262834ece621bb3c30671b66ab05" }, "sender": { "type": "string", "description": "Represents the address which sends this transaction", "example": "0x7b717faa31c5edf9332e1cd5fa3f736838a9262834ece621bb3c30671b66ab05" }, "type": { "type": "integer", "description": "Specifies the transaction type as one from three options: if response returns a \"0\" it means the raw transaction includes legacy transaction data, if it is \"1\" - includes access lists for EIP2930, and if it is \"2\" - EIP1559 data.", "example": 0 }, "v": { "type": "string", "description": "Defines the the recovery id.", "example": "0x26" }, "fee": { "type": "object", "properties": { "approximateAmount": { "type": "string", "description": "This attribute represents the max fee value.", "example": "0.00016932" }, "approximateMinimumRequiredAmount": { "type": "string", "description": "Defines the approximate minimum fee that is required for the transaction.", "example": "0.000021" }, "unit": { "type": "string", "description": "String representation of the fee unit", "example": "BNB" }, "aproximateAmount": { "type": "string", "description": "Represents the approximate fee amount that will be used for this transaction", "example": "0.00003" } }, "required": [ "approximateAmount", "approximateMinimumRequiredAmount", "unit", "aproximateAmount" ] }, "gasPrice": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the price offered to the miner to purchase this amount of gas.", "example": "2994782927" }, "unit": { "type": "string", "description": "String representation of the gas price unit", "example": "WEI" } }, "required": [ "amount", "unit" ] }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the transaction amount.", "example": "2.312" }, "unit": { "type": "string", "description": "String representation of the amount unit", "example": "BNB" } }, "required": [ "amount", "unit" ] }, "blockchainSpecific": { "$ref": "#/components/schemas/DecodeRawTransactionHexEVMRIBS" } }, "required": [ "id", "gasLimit", "gasPaidForData", "inputData", "nonce", "r", "recipient", "s", "sender", "type", "v", "fee", "gasPrice", "value" ] }, "DecodeRawTransactionHexEVMRIBS": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DecodeRawTransactionHexEVMRIBSE" } ] }, "DecodeRawTransactionHexEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DecodeRawTransactionHexEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "DecodeRawTransactionHexEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "DecodeRawTransactionHexEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidBlockchain" } ] }, "DecodeRawTransactionHexEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListConfirmedTransactionsByAddressUTXOHistoricalRIBSZ": { "type": "object", "properties": { "expiryHeight": { "type": "integer", "description": "Numeric representation of the transaction block height expiration", "example": 3 }, "overwintered": { "type": "boolean", "description": "Boolean representation of the overwintered upgrade.", "example": true }, "valueBalance": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the transaction value balance", "example": "10.34" }, "unit": { "type": "string", "description": "String representation of the amount balance", "example": "ZEC" } }, "required": [ "amount", "unit" ] } }, "description": "Zcash", "required": [ "expiryHeight", "overwintered", "valueBalance" ] }, "ListConfirmedTransactionsByAddressUTXOHistoricalRI": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the fee value", "example": "0.00000191" }, "unit": { "type": "string", "description": "String representation of the fee unit", "example": "DASH" } }, "required": [ "amount", "unit" ] }, "hash": { "type": "string", "description": "String representation of the transaction hash", "example": "b8483fe0d1f276a3c53b9ce65f60a2963202f7096c3c3e9a2d4ea0cb31ab60de" }, "id": { "type": "string", "description": "String representation of the transaction identifier (txid)", "example": "b8483fe0d1f276a3c53b9ce65f60a2963202f7096c3c3e9a2d4ea0cb31ab60de" }, "locktime": { "type": "integer", "format": "int64", "description": "Numeric representation of the transaction locktime", "example": 1781865 }, "positionInBlock": { "type": "integer", "description": "Numeric representation of the index", "example": 10 }, "size": { "type": "integer", "description": "Numeric representation of the transaction size", "example": 123 }, "timestamp": { "type": "integer", "description": "Numeric representation of the timestamp in seconds since epoch", "example": 1739356303 }, "version": { "type": "integer", "description": "Numeric representation of the transaction version", "example": 2 }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "String representation of the block hash", "example": "0000000000000001ce2cbb18127b56a4e6495fdec1fc81326317193ed6281cb6" }, "height": { "type": "integer", "description": "Numeric representation of the block height", "example": 2221316 } }, "required": [ "hash", "height" ] }, "inputs": { "type": "array", "description": "Object Array representation of transaction inputs", "items": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "String array representation of the addresses", "example": "XpXpivu9BppPn7XSd9JVPSXb2NsdCr1JZ7" } }, "coinbase": { "type": "string", "description": "String representation of the coinbase hex", "example": "XtotjTJ1nRGkuAH1axUfybBKoJGtFCqMaV" }, "outputIndex": { "type": "integer", "description": "Numeric representation of the vout", "example": 1 }, "script": { "type": "object", "properties": { "type": { "type": "string", "description": "String representation of the votype", "example": "scripthash" } }, "required": [ "type" ] }, "transactionId": { "type": "string", "description": "String representation of the txid", "example": "b8483fe0d1ff60a2963202f7096c3c3e9a2d4ea0cb31ab60de276a3c53b9ce65" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "300.09363391" }, "unit": { "type": "string", "description": "String representation of the amount unit inputs", "example": "DASH" } } }, "witnesses": { "type": "array", "items": { "type": "string", "description": "Array String representation of the witness", "example": "b8483fe0202f7096c3c3e9a2d4ea0cb31ab60ded1f276a3c53b9ce65f60a2963" } } }, "required": [ "outputIndex", "script", "transactionId" ] } }, "outputs": { "type": "array", "description": "Object Array representation of transaction outputs", "items": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "String array representation of the addresses", "example": "XtotjxUfybBKoJGtFCqMaVTJ1nRGkuAH1a" } }, "isSpent": { "type": "boolean", "description": "Boolean representation of is the transaction output spent", "example": true }, "script": { "type": "object", "properties": { "type": { "type": "string", "description": "String representation of the type", "example": "scripthash" } }, "required": [ "type" ] }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "300.093632" }, "unit": { "type": "string", "description": "String representation of the amount unit outputs", "example": "DASH" } } } }, "required": [ "isSpent", "script" ] } }, "recipients": { "type": "array", "description": "Object Array representation of transaction receivers", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String representation of the receiver address", "example": "XtotjxUfybBKoJGtFCqMaVTJ1nRGkuAH1a" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "300.093632" }, "unit": { "type": "string", "example": "DASH" } }, "required": [ "amount", "unit" ] } }, "required": [ "address", "value" ] } }, "senders": { "type": "array", "description": "Object Array representation of transaction senders", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String array representation of the sender address", "example": "XpXpivu9BppPn7XSd9JVPSXb2NsdCr1JZ7" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "300.09363391" }, "unit": { "type": "string", "description": "String representation of the amount value", "example": "DASH" } }, "required": [ "amount", "unit" ] } }, "required": [ "address", "value" ] } }, "blockchaiSpecific": { "type": "object", "properties": { "versionGroupId": { "type": "string", "description": "String representation of the transaction version group id", "example": "3" } }, "required": [ "versionGroupId" ] }, "blockchainSpecific": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressUTXOHistoricalRIBS" } }, "required": [ "fee", "hash", "id", "locktime", "positionInBlock", "size", "timestamp", "version", "minedInBlock", "inputs", "outputs", "recipients", "senders", "blockchaiSpecific" ] }, "ListConfirmedTransactionsByAddressUTXOHistoricalRIBS": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressUTXOHistoricalRIBSZ" } ] }, "ListConfirmedTransactionsByAddressUTXOHistoricalR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressUTXOHistoricalRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListConfirmedTransactionsByAddressUTXOHistoricalE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListConfirmedTransactionsByAddressUTXOHistoricalE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListConfirmedTransactionsByAddressUTXOHistoricalE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/AddressNotSynced" } ] }, "EstimateNativeCoinTransferGasLimitEVMRI": { "type": "object", "properties": { "gasLimit": { "type": "integer", "description": "Represents the amount of gas used by this specific transaction alone.", "example": 550000 } }, "required": [ "gasLimit" ] }, "EstimateNativeCoinTransferGasLimitEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/EstimateNativeCoinTransferGasLimitEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "EstimateNativeCoinTransferGasLimitEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "EstimateNativeCoinTransferGasLimitEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "EstimateNativeCoinTransferGasLimitEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetTransactionDetailsByTransactionIdKaspaRI": { "type": "object", "properties": { "blocksHashes": { "type": "array", "items": { "type": "string", "description": "Array of block hashes where the transaction appears", "example": "14ffe6a8da878316db9afca55c62746f97033631072b931cae2a0b3458b29fc8" } }, "fee": { "type": "object", "description": "Transaction fee details", "properties": { "amount": { "type": "string", "description": "Fee amount", "example": "0.123" }, "denomination": { "type": "string", "description": "Fee denomination", "example": "100000000" }, "unit": { "type": "string", "description": "Fee unit" } }, "required": [ "amount", "denomination", "unit" ] }, "hash": { "type": "string", "description": "String representation of the transaction hash", "example": "76d7502fa19c53f61d6acd83102e4e153d864908eea9e2140a86dc6278b4e1f0" }, "id": { "type": "string", "description": "String representation of the transaction ID" }, "inputs": { "type": "array", "description": "Transaction inputs", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Input address", "example": "kaspa:qzyzhlkd8thwywu2ajylmzlz9hxdqw9s5xznf0kzed8s9y4h6mtfj222rtgcn" }, "outputIndex": { "type": "integer", "description": "Previous output index", "example": 3 }, "transactionId": { "type": "string", "description": "Previous output transaction ID", "example": "794af341e2fc00b732a60a4fb5ee238c6289fec30c21bbadf326cc448d2c312e" }, "value": { "type": "object", "description": "Input amount details", "properties": { "amount": { "type": "string", "description": "Amount value", "example": "6173541265" }, "denomination": { "type": "integer", "format": "int64", "description": "Amount denomination", "example": 100000000 }, "unit": { "type": "string", "description": "Amount unit", "example": "SOMPI" } }, "required": [ "amount", "denomination", "unit" ] } }, "required": [ "outputIndex", "transactionId" ] } }, "outputs": { "type": "array", "description": "Transaction outputs", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Output address", "example": "kaspa:qrk9decfnl4rayeegp6gd3tc6605zavclkpud5jp78axat5namppwt050d57j" }, "value": { "type": "object", "description": "Output amount details", "properties": { "amount": { "type": "string", "description": "Amount value", "example": "6173541265" }, "denomination": { "type": "integer", "format": "int64", "description": "Amount denomination", "example": 100000000 }, "unit": { "type": "string", "description": "Amount unit", "example": "SOMPI" } }, "required": [ "amount", "denomination", "unit" ] } }, "required": [ "address", "value" ] } }, "timestamp": { "type": "integer", "description": "Timestamp of the transaction", "example": 1741515023 } }, "required": [ "blocksHashes", "hash", "id", "inputs", "outputs", "timestamp" ] }, "GetTransactionDetailsByTransactionIdKaspaR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionIdKaspaRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetTransactionDetailsByTransactionIdKaspaE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetTransactionDetailsByTransactionIdKaspaE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetTransactionDetailsByTransactionIdKaspaE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "EncodeX-AddressRI": { "type": "object", "properties": { "xAddress": { "type": "string", "description": "Represents the encoded classic address with its destination tag.", "example": "TVTMSyg6nRscAm2JtRd8hnpF9nD21CgZx6ibb9iy3EWHotV" } }, "required": [ "xAddress" ] }, "EncodeX-AddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/EncodeX-AddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "EncodeX-AddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "EncodeX-AddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidBlockchain" }, { "$ref": "#/components/schemas/InvalidNetwork" } ] }, "EncodeX-AddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListSyncedAddressTokensTransferEVMRI": { "type": "object", "properties": { "recipient": { "type": "string", "description": "String representation of the token transfer recipient", "example": "0x3d0b25fe09e2cd92f06ba776391a122519936e90" }, "sender": { "type": "string", "description": "String representation of the token transfer sender", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, "timestamp": { "type": "integer", "description": "Numeric representation of the timestamp in seconds since epoch", "example": 1615861410 }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the fee value", "example": "0.003" }, "unit": { "type": "string", "description": "Unit of the fee amount", "example": "BNB" } }, "required": [ "amount", "unit" ] }, "tokenData": { "type": "object", "properties": { "fungibleValues": { "type": "object", "properties": { "amount": { "type": "string", "example": "162727.720910848" } }, "required": [ "amount" ] }, "name": { "type": "string", "description": "String representation of the token name", "example": "Tether" }, "nonFungibleValues": { "type": "object", "properties": { "tokenId": { "type": "string", "description": "String representation of the token id", "example": "123456" } } }, "symbol": { "type": "string", "description": "String representation of the token symbol", "example": "USDT" }, "contractAddress": { "type": "string", "description": "String representation of contract address of the token that was transfered", "example": "0xece01807f7d9b93529174533e997e5de168b0b39" }, "standard": { "type": "string", "description": "Defines the specific token type.", "example": "ERC-20" } }, "required": [ "fungibleValues", "name", "symbol", "contractAddress", "standard" ] }, "transactionHash": { "type": "string", "description": "String representation of the transaction hash", "example": "0x2613aeecd43d41707f7158d9ea278e970ffb7240e272ff4aa758ede717859775" }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "String representation of the block hash", "example": "0xbedfba55a8ef9342d1fe70e1e9adefad20aca7c164b072a648b1bb95d5a6b631" }, "height": { "type": "integer", "format": "int64", "description": "Numeric representation of the block height", "example": 123456789 } }, "required": [ "hash", "height" ] } }, "required": [ "recipient", "sender", "timestamp", "fee", "tokenData", "transactionHash", "minedInBlock" ] }, "ListSyncedAddressTokensTransferEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListSyncedAddressTokensTransferEVMRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListSyncedAddressTokensTransferEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListSyncedAddressTokensTransferEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListSyncedAddressTokensTransferEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/AddressNotSynced" } ] }, "NextAvailableSequenceXRPRI": { "type": "object", "properties": { "nextAvailableSequence": { "type": "integer", "format": "int64", "description": "Represents the sequential running number for an address, starting from 0 for the first transaction.", "example": 124 } }, "required": [ "nextAvailableSequence" ] }, "NextAvailableSequenceXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/NextAvailableSequenceXRPRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "NextAvailableSequenceXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "NextAvailableSequenceXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "NextAvailableSequenceXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetAddressStatisticsEVMRI": { "type": "object", "properties": { "address": { "type": "string", "description": "String representation of the EVM address", "example": "0xfad4a236c87880035497043f24ea58d73c3e50de" }, "blockHeight": { "type": "integer", "format": "int64", "description": "Numeric representation of the current block height", "example": 123456 }, "blockTimestamp": { "type": "integer", "format": "int64", "description": "Numeric representation of the current block timestamp in seconds since Unix epoch.", "example": 1760003893 }, "internalTransactionsCounts": { "type": "object", "description": "Internal transaction statistics", "properties": { "incoming": { "type": "integer", "description": "Number of incoming internal transactions", "example": 321 }, "outgoing": { "type": "integer", "description": "Number of outgoing internal transactions", "example": 123 } }, "required": [ "incoming", "outgoing" ] }, "nativeTransactionsCounts": { "type": "object", "description": "Native transaction statistics", "properties": { "incoming": { "type": "integer", "description": "Number of incoming native transactions", "example": 321 }, "outgoing": { "type": "integer", "description": "Number of outgoing native transactions", "example": 123 } }, "required": [ "incoming", "outgoing" ] }, "tokenTransfersCounts": { "type": "object", "description": "Token transfer statistics", "properties": { "incoming": { "type": "integer", "description": "Number of incoming token transfers", "example": 321 }, "outgoing": { "type": "integer", "description": "Number of outgoing token transfers", "example": 123 } }, "required": [ "incoming", "outgoing" ] } }, "required": [ "address", "blockHeight", "blockTimestamp", "internalTransactionsCounts", "nativeTransactionsCounts", "tokenTransfersCounts" ] }, "GetAddressStatisticsEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetAddressStatisticsEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetAddressStatisticsEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetAddressStatisticsEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetAddressStatisticsEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/AddressNotSynced" } ] }, "NotFound": { "type": "object", "description": "not_found", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "not_found" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "" }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "GetTransactionDetailsByTransactionHashXRPRI": { "type": "object", "properties": { "additionalData": { "type": "string", "description": "Represents additional data that may be needed.", "example": "rPmPErQe4g9725pcNxJpuvKkdqTESTQ6Tu" }, "destinationTag": { "type": "integer", "format": "int64", "example": 3999472835 }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount of the fee.", "example": "0.0021" }, "unit": { "type": "string", "description": "Defines the unit of the fee.", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "hash": { "type": "string", "description": "Represents the same as `transactionId` for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols `hash` is different from `transactionId` for SegWit transactions.", "example": "36a1737481edec87bacc3101dfb752ae2c76f9171e7edebe587e330c1ea77c8d" }, "offer": { "type": "object", "description": "Defines the specific offer.", "properties": { "amount": { "type": "string", "description": "Defines the amount of the offer.", "example": "3.0154" }, "unit": { "type": "string", "description": "Defines the unit of the offer.", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "positionInBlock": { "type": "string", "description": "Defines the index of the transaction, i.e. the consecutive place it takes in the blockchain.", "example": "2" }, "receive": { "type": "object", "description": "Defines on object array of the funds for which an offer is made.", "properties": { "amount": { "type": "string", "description": "Defines the amount of the funds for which an offer is made.", "example": "2.1256" }, "unit": { "type": "string", "description": "Defines the unit of the funds for which an offer is made.", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "recipient": { "type": "string", "description": "String representation of the movement recipient address", "example": "rJ6DPnjeZbZF6EYqzTQPP9nAmhMuxXjPUT" }, "sender": { "type": "string", "description": "String representation of the movement sender address", "example": "rJ6DPnjeZbZF6EYqzTQPP9nAmhMuxXjPUT" }, "status": { "type": "string", "description": "Defines the status of the transaction.", "example": "tesSUCCESS" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.", "example": 1582202940 }, "type": { "type": "string", "description": "Defines the type of the transaction.", "example": "Payment" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount of the value.", "example": "3.0254" }, "unit": { "type": "string", "description": "Defines the unit of the value.", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the hash of the block where this transaction was mined/confirmed for first time. The hash is defined as a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "3f7af58d6cf1cd9020fb285d8e3e215131800d5109e42647ffd9b3aeae59df33" }, "height": { "type": "integer", "description": "Represents the hight of the block where this transaction was mined/confirmed for first time. The height is defined as the number of blocks in the blockchain preceding this specific block.", "example": 15973802 } }, "required": [ "hash", "height" ] } }, "required": [ "additionalData", "fee", "hash", "offer", "positionInBlock", "receive", "recipient", "sender", "timestamp", "type", "value", "minedInBlock" ] }, "GetTransactionDetailsByTransactionHashXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashXRPRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetTransactionDetailsByTransactionHashXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetTransactionDetailsByTransactionHashXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetTransactionDetailsByTransactionHashXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListConfirmedTransactionsByAddressUTXOsRIBSZ": { "type": "object", "properties": { "expiryHeight": { "type": "integer", "description": "Numeric representation of the transaction block height expiration", "example": 123 }, "overwintered": { "type": "boolean", "example": true }, "valueBalance": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the transaction value balance", "example": "0.1234" }, "unit": { "type": "string", "example": "ZEC" } }, "required": [ "amount", "unit" ] }, "versionGroupId": { "type": "string", "description": "String representation of the transaction version group id", "example": "abc1234567" } }, "description": "Zcash", "required": [ "expiryHeight", "overwintered", "valueBalance", "versionGroupId" ] }, "ListConfirmedTransactionsByAddressUTXOsRI": { "type": "object", "properties": { "id": { "type": "string", "description": "String representation of the weight", "example": "284f4abb8b76620b3e94bb5f37f06810a58a08fd03cf255a2da094107b99c9ff" }, "locktime": { "type": "integer", "format": "int64", "description": "Numeric representation of the transaction locktime", "example": 1781965 }, "size": { "type": "integer", "description": "Numeric representation of the transaction size", "example": 123 }, "version": { "type": "integer", "description": "Numeric representation of the transaction version", "example": 2 }, "fee": { "type": "object", "description": "Object representation of the transaction fee", "properties": { "amount": { "type": "string", "description": "String representation of the fee value", "example": "0.0001" }, "unit": { "type": "string", "description": "String representation of the fee unit", "example": "ZEC" } }, "required": [ "amount", "unit" ] }, "hash": { "type": "string", "description": "String representation of the weight", "example": "284f4abb8b76620b3e94bb5f37f06810a58a08fd03cf255a2da094107b99c9ff" }, "inputs": { "type": "array", "description": "Object Array representation of transaction inputs", "items": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "String array representation of the addresses", "example": "t3cFfPt1Bcvgez9ZbMBFWeZsskxTkPzGCow" } }, "coinbase": { "type": "string", "description": "String representation of the coinbase hex", "example": "f40208bedab78d0a2a8283a900bf86d286674dbb3684f067b5498edabf34be61f40208bedab78d" }, "outputIndex": { "type": "integer", "description": "Numeric representation of the vout", "example": 1 }, "script": { "type": "object", "properties": { "type": { "type": "string", "description": "String representation of the votype", "example": "pubkeyhash" } }, "required": [ "type" ] }, "transactionId": { "type": "string", "description": "String representation of the txid", "example": "t1at7nVNsv6taLRrNRvnQdtfLNRDfsGc3Ak" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "0.123" }, "unit": { "type": "string", "example": "ZEC" } } }, "witnesses": { "type": "array", "items": { "type": "string", "description": "Array String representation of the witness", "example": "6674dbb3684f067b5498edabf34be61f40208bedab78d0a2a8283a900bf86d28" } } }, "required": [ "outputIndex", "script" ] } }, "outputs": { "type": "array", "description": "Object Array representation of transaction outputs", "items": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "String array representation of the addresses", "example": "t1at7nVNsv6taLRrNRvnQdtfLNRDfsGc3Ak" } }, "isSpent": { "type": "boolean", "description": "Boolean representation of is the transaction output spent", "example": false }, "script": { "type": "object", "properties": { "type": { "type": "string", "description": "String representation of the type", "example": "pubkeyhash" } }, "required": [ "type" ] }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "0.123" }, "unit": { "type": "string", "example": "ZEC" } } } }, "required": [ "isSpent", "script" ] } }, "positionInBlock": { "type": "integer", "description": "Numeric representation of the transaction index", "example": 1 }, "recipients": { "type": "array", "description": "Object Array representation of transaction receivers", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String representation of the receiver address", "example": "t3cFfPt1Bcvgez9ZbMBFWeZsskxTkPzGCow" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "0.123" }, "unit": { "type": "string", "example": "ZEC" } }, "required": [ "amount", "unit" ] } }, "required": [ "address", "value" ] } }, "senders": { "type": "array", "description": "Object Array representation of transaction senders", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String array representation of the sender address", "example": "t1at7nVNsv6taLRrNRvnQdtfLNRDfsGc3Ak" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "0.123" }, "unit": { "type": "string", "example": "ZEC" } }, "required": [ "amount", "unit" ] } }, "required": [ "address", "value" ] } }, "timestamp": { "type": "integer", "description": "Numeric representation of the timestamp in seconds since epoch", "example": 1669627454 }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "String representation of the block hash", "example": "00000000000000000002146d4033d17224b3e9f2998bc0a0d01be57fe5686416" }, "height": { "type": "integer", "description": "Numeric representation of the block height", "example": 882529 } }, "required": [ "hash", "height" ] }, "blockchainSpecific": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressUTXOsRIBS" } }, "required": [ "id", "locktime", "size", "version", "fee", "hash", "inputs", "outputs", "positionInBlock", "recipients", "senders", "timestamp", "minedInBlock" ] }, "ListConfirmedTransactionsByAddressUTXOsRIBS": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressUTXOsRIBSZ" } ] }, "ListConfirmedTransactionsByAddressUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressUTXOsRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListConfirmedTransactionsByAddressUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListConfirmedTransactionsByAddressUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListConfirmedTransactionsByAddressUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ValidateAddressUTXORI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the specific address that will be checked if it's valid or not.", "example": "bc1qa2n5l96vh9df4zq7g3epvx3en3647zgchc4np3" }, "isValid": { "type": "boolean", "description": "Defines whether the address is valid or not. Set as boolean.", "example": true } }, "required": [ "address", "isValid" ] }, "ValidateAddressUTXOR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ValidateAddressUTXORI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ValidateAddressUTXOE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ValidateAddressUTXOE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ValidateAddressUTXOE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListSyncedAddressInternalTransactionsEVMRI": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Numeric representation of the timestamp in seconds since epoch", "example": 1582202940 }, "transactionHash": { "type": "string", "description": "String representation of the hash of the transaction in which the internal transaction happened", "example": "0x5d4ea0471b70de09fa3d6a4bc32f703ec44483bffa4d6169fa0a36c6a1dc108a" }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "String representation of the block hash of the transaction in which the internal transaction happened", "example": "0x85ce0aa9628726c60db14526be8a2b823084b1f4c3dcccdc10b0235f23a49e66" }, "height": { "type": "integer", "description": "Numeric representation of the block height of the transaction in which the internal transaction happened", "example": 56009972 } }, "required": [ "hash", "height" ] }, "operationId": { "type": "string", "description": "String representation of internal transaction type trace address", "example": "call_0_0" }, "operationType": { "type": "string", "description": "String representation of internal transaction type", "example": "CALL" }, "recipient": { "type": "string", "description": "String representation of the internal transaction recipient", "example": "0xc946cb236481c159f460b212b34ab246dac37fcd" }, "sender": { "type": "string", "description": "String representation of the internal transaction sender", "example": "0xadf10d7f6a7069c11fc5f3c6c9b4f419b326bcbc" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount that was transacted", "example": "0.025" }, "unit": { "type": "string", "description": "String representation of the fee unit", "example": "BNB" } }, "required": [ "amount", "unit" ] } }, "required": [ "timestamp", "transactionHash", "minedInBlock", "operationId", "operationType", "recipient", "sender", "value" ] }, "ListSyncedAddressInternalTransactionsEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListSyncedAddressInternalTransactionsEVMRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListSyncedAddressInternalTransactionsEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListSyncedAddressInternalTransactionsEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListSyncedAddressInternalTransactionsEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/AddressNotSynced" } ] }, "GetAddressBalanceKaspaRI": { "type": "object", "properties": { "confirmedBalance": { "type": "object", "description": "Numeric representation of the total balance of the address", "properties": { "amount": { "type": "string", "description": "Balance amount", "example": "33.1794059" }, "denomination": { "type": "integer", "format": "int64", "description": "Balance denomination", "example": 1 }, "unit": { "type": "string", "description": "Balance unit", "example": "KAS" } }, "required": [ "amount", "denomination", "unit" ] } }, "required": [ "confirmedBalance" ] }, "GetAddressBalanceKaspaR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetAddressBalanceKaspaRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetAddressBalanceKaspaE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetAddressBalanceKaspaE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetAddressBalanceKaspaE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "PrepareANonFungibleTokenTransferFromAddressEVMRI": { "type": "object", "properties": { "inputData": { "type": "string", "description": "0x0079006f00750072004100640064006900740069006f006e0061006c00440061007400610048006500720065", "example": "0x23b872dd000000000000000000000000c6d46aba0c6e2eb6358c4e24804158cc4d8479220000000000000000000000000902a667d6a3f287835e0a4593cae4167384abc6000000000000000000000000000000000000000000000000000000000000000e" }, "nonce": { "type": "integer", "description": "Represents the sequential running number for an address, starting from 0 for the first transaction. E.g., if the nonce of a transaction is 10, it would be the 11th transaction sent from the sender's address.", "example": 1 }, "recipient": { "type": "string", "description": "Represents the address which sends this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one sender.", "example": "0x5668213c59ab2612ecd948f98371d1d291098b5e" }, "sender": { "type": "string", "description": "The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.", "example": "0xc6d46aba0c6e2eb6358c4e24804158cc4d847922" }, "sigHash": { "type": "string", "description": "Representation of the hash that should be signed", "example": "1b0ba4f497e39a74aa9a83afde0ec257c5c6e8547ea8187c319f0a242c2506f4" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the unique token identifier.", "example": "14" } }, "required": [ "amount" ] }, "fee": { "type": "object", "description": "Defines the amount of the transaction fee.", "properties": { "gasPrice": { "type": "integer", "description": "Represents the price offered to the miner to purchase this amount of gas.", "example": 2500000007 }, "maxFeePerGas": { "type": "integer", "description": "Representation of the max fee per gas value", "example": 6655534951 }, "maxPriorityFeePerGas": { "type": "integer", "description": "Representation of the max priority fee per gas value", "example": 1000000000 }, "unit": { "type": "integer", "example": "WEI" } }, "required": [ "gasPrice", "maxFeePerGas", "maxPriorityFeePerGas", "unit" ] }, "gasLimit": { "type": "integer", "description": "Represents the amount of gas used by this specific transaction alone.", "example": 552020 }, "type": { "type": "string", "description": "Representation of the transaction type", "example": "legacy-transaction", "enum": [ "legacy-transaction", "access-list-transaction", "gas-fee-market-transaction" ] } }, "required": [ "inputData", "nonce", "recipient", "sender", "sigHash", "value", "fee", "gasLimit", "type" ] }, "PrepareANonFungibleTokenTransferFromAddressEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/PrepareANonFungibleTokenTransferFromAddressEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "PrepareANonFungibleTokenTransferFromAddressEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "PrepareANonFungibleTokenTransferFromAddressEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "PrepareANonFungibleTokenTransferFromAddressEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetEIP1559FeeRecommendationsEVMRI": { "type": "object", "properties": { "lastBlock": { "type": "integer", "format": "int64", "description": "Numeric representation of the block height", "example": 19269503 }, "baseFeePerGas": { "type": "object", "properties": { "unit": { "type": "string", "description": "Represents the unit of the base fee per gas.", "example": "WEI" }, "value": { "type": "string", "description": "Represents the expected base fee per gas of the upcoming block, calculated from the previous block data.", "example": "45265143502" } }, "required": [ "unit", "value" ] }, "maxFeePerGas": { "type": "object", "properties": { "fast": { "type": "string", "description": "Represents the fast maximum fee per gas, calculated from unconfirmed transactions.", "example": "75235090892" }, "slow": { "type": "string", "description": "Represents the slow maximum fee per gas, calculated from unconfirmed transactions.", "example": "67416761254" }, "standard": { "type": "string", "description": "Represents the standard maximum fee per gas, calculated from unconfirmed transactions.", "example": "69996407508" }, "unit": { "type": "string", "description": "Represents the unit of the maximum fee per gas.", "example": "WEI" } }, "required": [ "fast", "slow", "standard", "unit" ] }, "maxPriorityFeePerGas": { "type": "object", "properties": { "fast": { "type": "string", "description": "Represents the fast maximum priority fee per gas, calculated from unconfirmed transactions.", "example": "47085140300" }, "slow": { "type": "string", "description": "Represents the slow maximum priority fee per gas, calculated from unconfirmed transactions.", "example": "37331114417" }, "standard": { "type": "string", "description": "Represents the standard maximum priority fee per gas, calculated from unconfirmed transactions.", "example": "41987372497" }, "unit": { "type": "string", "description": "Represents the unit of the maximum priority fee per gas.", "example": "WEI" } }, "required": [ "fast", "slow", "standard", "unit" ] } }, "required": [ "lastBlock", "baseFeePerGas", "maxFeePerGas", "maxPriorityFeePerGas" ] }, "GetEIP1559FeeRecommendationsEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetEIP1559FeeRecommendationsEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetEIP1559FeeRecommendationsEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetEIP1559FeeRecommendationsEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetEIP1559FeeRecommendationsEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListTokensByAddressSolanaRI": { "type": "object", "properties": { "contractAddress": { "type": "string", "description": "Defines the specific address of the contract.", "example": "Dn4noZ5jgGfkntzcQSUZ8czkreiZ1ForXYoV2H8Dm7S1" }, "name": { "type": "string", "description": "String identifier of the name", "example": "tether" }, "symbol": { "type": "string", "description": "Representation of the token symbol", "example": "USDT" }, "tokenAddress": { "type": "string", "description": "Defines the specific Token holder address.", "example": "DUVULQ5bLhvrMwV6BzqPPEQ9RYJ2pVkqwmByBHKNGpVf" }, "type": { "type": "string", "description": "Defines the type of the token.", "example": "fungible", "enum": [ "non-fungible", "fungible" ] }, "fungibleValues": { "type": "object", "properties": { "amount": { "type": "string", "description": "String", "example": "296.231921" } }, "required": [ "amount" ] } }, "required": [ "contractAddress", "tokenAddress", "type", "fungibleValues" ] }, "ListTokensByAddressSolanaR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListTokensByAddressSolanaRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListTokensByAddressSolanaE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListTokensByAddressSolanaE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListTokensByAddressSolanaE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "EstimateTokenTransferGasLimitEVMRI": { "type": "object", "properties": { "gasLimit": { "type": "integer", "description": "Represents the amount of gas used by this specific transaction alone.", "example": 550000 } }, "required": [ "gasLimit" ] }, "EstimateTokenTransferGasLimitEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/EstimateTokenTransferGasLimitEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "EstimateTokenTransferGasLimitEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "EstimateTokenTransferGasLimitEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "EstimateTokenTransferGasLimitEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListTransactionsByAddressSolanaRI": { "type": "object", "properties": { "fee": { "type": "object", "description": "Object representation of the fee's amount & unit", "properties": { "amount": { "type": "string", "description": "String representation of the transaction's fee amount", "example": "0.000010702" }, "unit": { "type": "string", "description": "String representation of the transaction's fee unit (ex. SOL)", "example": "SOL" } }, "required": [ "amount", "unit" ] }, "nativeBalanceChanges": { "type": "array", "description": "Object Array representation of the transactions native (SOL) balance changes of each address", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String representation of the balance change address", "example": "Dn4noZ5jgGfkntzcQSUZ8czkreiZ1ForXYoV2H8Dm7S1" }, "after": { "type": "string", "description": "String representation of the balance change after the transaction", "example": "100" }, "before": { "type": "string", "description": "String representation of the balance change before the transaction", "example": "150" }, "change": { "type": "string", "description": "String representation of the balance change calculated", "example": "50" }, "type": { "type": "string", "description": "String representation of the balance change type", "example": "native", "enum": [ "native" ] }, "unit": { "type": "string", "description": "String representation of the balance change unit (ex. SOL)", "example": "SOL", "enum": [ "SOL" ] } }, "required": [ "address", "after", "before", "change", "unit" ] } }, "nativeMovements": { "type": "array", "description": "Object Array representation of the transactions native movements", "items": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the movement asset amount", "example": "10" }, "recipientAddress": { "type": "string", "description": "String representation of the movement recipient address", "example": "DUVULQ5bLhvrMwV6BzqPPEQ9RYJ2pVkqwmByBTESTpVf" }, "senderAddress": { "type": "string", "description": "String representation of the movement sender address", "example": "DUVULQ5bLhvrMTEstBzqPPEQ9RYJ2pVkqwmByBHKNGpVf" }, "unit": { "type": "string", "description": "String representation of the movement token's unit", "example": "SOL", "enum": [ "SOL" ] } }, "required": [ "amount", "recipientAddress", "senderAddress", "unit" ] } }, "signature": { "type": "string", "description": "String representation of the transaction's signature", "example": "2KGuERep8VNbpDbyLxxXKV8uFik5ECSx5zrRAgUyzAbGCXGVg2Xb62Yda8TVD3xjxsmGkSNDSm5cVstgLjfnmte5" }, "signer": { "type": "string", "description": "String representation of the transaction's signer", "example": "DCAKxn5PFNN1mBREPWGdk1RXg5aVH9rPErLfBFEi2Emb" }, "timestamp": { "type": "integer", "format": "int64", "description": "Numeric representation of the transaction's timestamp", "example": 1712821685 }, "tokenBalanceChanges": { "type": "array", "description": "Object Array representation of the transactions token (SPL) balance changes of each address and token", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String representation of the balance change address", "example": "DUVULQ5bLhvrMwV6BzqPPEQ9RYJ2pVkqwmByBHKNGpVf" }, "after": { "type": "string", "description": "String representation of the balance change after the transaction", "example": "50" }, "before": { "type": "string", "description": "String representation of the balance change before the transaction", "example": "50" }, "change": { "type": "string", "description": "String representation of the balance change calculated", "example": "100" }, "contractAddress": { "type": "string", "description": "String representation of the balance change token's contract address (also called mint)", "example": "Dn4noZ5jgGfkntzcQSUZ8czkreiZ1ForXYoV2H8Dm7S1" }, "tokenAddress": { "type": "string", "description": "String representation of the balance change token address (also called mint)", "example": "DUVULQ5bLhvrMwV6BzqPPEQ9RYJ2pVkqwmByBHKNGpVf" }, "type": { "type": "string", "description": "String representation of the balance change type", "example": "spl", "enum": [ "spl" ] } }, "required": [ "address", "after", "before", "change", "contractAddress", "tokenAddress" ] } }, "tokenMovements": { "type": "array", "description": "Object Array representation of the transactions token movements", "items": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the movement asset amount", "example": "10" }, "contractAddress": { "type": "string", "description": "String representation of the movement contract's address (also called mint)", "example": "Dn4noZ5jgGfkntzcQSUZ8czkreiZ1ForXYoV2H8Dm7S1" }, "recipientAddress": { "type": "string", "description": "String representation of the movement recipient address", "example": "DUVULQ5bLhvrMwV6BzqPPEQ9RYJ2pVkqwmByBTESTpVf" }, "recipientTokenAddress": { "type": "string", "description": "String representation of the movement recipient token address", "example": "DUVULQ5bLhvrMTEstBzqPPEQ9RYJ2pVkqwmByBHKNGpVf" }, "senderAddress": { "type": "string", "description": "String representation of the movement sender address", "example": "DUVULQ5bLhvrMTEstBzqPPEQ9RYJ2pVkqwmByBHKNGpVf" }, "senderTokenAddress": { "type": "string", "description": "String representation of the movement sender token address", "example": "DUVULQ5bLhvrMwV6BzqPPEQ9RYJ2pVkqwmByBHKNGpVf" } }, "required": [ "amount", "contractAddress", "recipientAddress", "senderAddress" ] } }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "String representation of the transaction's block hash", "example": "ByacH5PR9vSBwHyc6R1Rt2THzGGZd3DqwhgEcUfSKG5C" }, "height": { "type": "integer", "format": "int64", "description": "Numeric representation of the transaction's block height", "example": 259495121 } }, "required": [ "hash", "height" ] } }, "required": [ "fee", "nativeBalanceChanges", "nativeMovements", "signature", "signer", "timestamp", "tokenBalanceChanges", "tokenMovements", "minedInBlock" ] }, "ListTransactionsByAddressSolanaR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListTransactionsByAddressSolanaRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListTransactionsByAddressSolanaE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListTransactionsByAddressSolanaE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListTransactionsByAddressSolanaE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetAddressStatisticsUTXOsRI": { "type": "object", "properties": { "address": { "type": "string", "description": "String representation of the address", "example": "bc1pp7w6kxnj7lzgm29pmuhezwl0vjdlcrthqukll5gn9xuqfq5n673smy4m63" }, "blockHeight": { "type": "integer", "format": "int64", "description": "Numeric representation of the current blockchain block height", "example": 123456 }, "blockTimestamp": { "type": "integer", "format": "int64", "description": "Numeric representation of the current blockchain block timestamp", "example": 1760003893 }, "transactionCounts": { "type": "object", "properties": { "incoming": { "type": "integer", "description": "Numeric representation of the incoming transaction count for the address", "example": 100 }, "outgoing": { "type": "integer", "description": "Numeric representation of the outgoing transaction count for the address", "example": 123 } }, "required": [ "incoming", "outgoing" ] } }, "required": [ "address", "blockHeight", "blockTimestamp", "transactionCounts" ] }, "GetAddressStatisticsUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetAddressStatisticsUTXOsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetAddressStatisticsUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetAddressStatisticsUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetAddressStatisticsUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetHDWalletXPubYPubZPubDetailsUTXORI": { "type": "object", "properties": { "confirmedBalance": { "type": "string", "description": "Specifies the confirmed coins balance of the Wallet.", "example": "0.0021" }, "totalReceived": { "type": "string", "description": "Defines the total currency received to the Wallet.", "example": "0.0002" }, "totalSpent": { "type": "string", "description": "Defines the total currency spent from the Wallet.", "example": "0.0001" }, "unit": { "type": "string", "example": "BTC" } }, "required": [ "confirmedBalance", "totalReceived", "totalSpent", "unit" ] }, "GetHDWalletXPubYPubZPubDetailsUTXOR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsUTXORI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetHDWalletXPubYPubZPubDetailsUTXOE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetHDWalletXPubYPubZPubDetailsUTXOE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "GetHDWalletXPubYPubZPubDetailsUTXOE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetHDWalletXPubYPubZPubDetailsUTXOE422": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestBodyStructure" }, { "$ref": "#/components/schemas/XpubSyncInProgress" } ] }, "GetBlockDetailsByBlockHashUTXOsRI": { "type": "object", "properties": { "bits": { "type": "integer", "description": "Numeric representation of the Block bits", "example": 123456 }, "chainwork": { "type": "string", "description": "Numeric representation of the expected number of hashes required to produce the chain up to this block", "example": "123456" }, "difficulty": { "type": "integer", "description": "Numeric representation of the block difficulty", "example": 123456789 }, "merkleRoot": { "type": "string", "description": "String representation of the block merkle root", "example": "a1c6d67c992a70fca66188e178d9ca7c20d5c775393948f19955be7f0952c0f" }, "size": { "type": "integer", "description": "Numeric representation of the block size", "example": 123456 }, "version": { "type": "integer", "description": "Numeric representation of the block version", "example": 12 }, "hash": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "0000000006b3f483bec16b8a85c632bdd30a14a202c83a9148002c9ee441dd0c" }, "height": { "type": "integer", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 1941208 }, "nextBlockHash": { "type": "string", "description": "Represents the hash of the next block. When this is the last block of the blockchain this value will be an empty string.", "example": "0000000000000003b08ca90b701da447fb3e7c5c6b43acd33a5e4062fe98dea5" }, "previousBlockHash": { "type": "string", "description": "Represents the hash of the previous block, also known as the parent block.", "example": "00000000844434fd86a630ba8e29503d5396a2b6c4003d69bf0a08d96169d4cd" }, "strippedSize": { "type": "integer", "description": "Defines the numeric representation of the block size excluding the witness data.", "example": 895429 }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this block was mined in Unix Timestamp.", "example": 1615378134 }, "transactionsCount": { "type": "integer", "description": "Represents the total number of all transactions as part of this block.", "example": 145 }, "versionHex": { "type": "string", "description": "Is the hexadecimal string representation of the block's version.", "example": "20000000" }, "weight": { "type": "integer", "description": "Represents a measurement to compare the size of different transactions to each other in proportion to the block size limit.", "example": 37248 } }, "required": [ "bits", "chainwork", "difficulty", "merkleRoot", "size", "hash", "height", "nextBlockHash", "previousBlockHash", "strippedSize", "timestamp", "transactionsCount", "versionHex", "weight" ] }, "GetBlockDetailsByBlockHashUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashUTXOsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetBlockDetailsByBlockHashUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetBlockDetailsByBlockHashUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetBlockDetailsByBlockHashUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListTransactionsByBlockHeightEVMRI": { "type": "object", "properties": { "contract": { "type": "string", "description": "Numeric representation of the transaction contract", "example": "0x534bD102153EF199abAe8296a2FaE4599fC44Cdc" }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the fee value", "example": "0.00016932" }, "unit": { "type": "string", "description": "Defines the fee unit", "example": "TRX" } }, "required": [ "amount", "unit" ] }, "hash": { "type": "string", "description": "String representation of the transaction hash", "example": "0x8ff7684331492af9bf8026938535a2703a8f2f9b81ef902a5c8b9e41cf9008b7" }, "inputData": { "type": "string", "description": "Numeric representation of the transaction input", "example": "123" }, "positionInBlock": { "type": "integer", "description": "Numeric representation of the transaction index", "example": 1 }, "recipient": { "type": "string", "description": "String representation of the transaction to address", "example": "0xf163C1592EbC8D3C01c146d95c3ea492b5A88652" }, "sender": { "type": "string", "description": "String representation of the transaction from address", "example": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97" }, "status": { "type": "string", "description": "String representation of the transaction status", "example": "mined" }, "timestamp": { "type": "integer", "description": "Numeric representation of the timestamp in seconds since epoch", "example": 1618208236 }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount value", "example": "0.123" }, "unit": { "type": "string", "example": "SUN" } }, "required": [ "amount", "unit" ] }, "gasLimit": { "type": "integer", "description": "String representation of the transaction gas", "example": 21000 }, "gasUsed": { "type": "integer", "description": "Numeric representation of the transaction gas used", "example": 123456 }, "gasPrice": { "type": "object", "properties": { "amount": { "type": "string", "description": "Numeric representation of the transaction gas price", "example": "12345" }, "unit": { "type": "string", "description": "Defines the unit of the gas price amount, e.g. BTC, ETH, XRP.", "example": "WEI" } }, "required": [ "amount", "unit" ] }, "blockchainSpecific": { "type": "object", "properties": { "bandwidth": { "type": "integer", "description": "Represents the amount of bandwidth used by transaction", "example": 268 }, "energy": { "type": "integer", "description": "Represents the amount of energy used by transaction", "example": 127 } }, "required": [ "bandwidth", "energy" ] } }, "required": [ "contract", "fee", "hash", "inputData", "positionInBlock", "recipient", "sender", "status", "timestamp", "value", "gasLimit", "gasUsed", "gasPrice", "blockchainSpecific" ] }, "ListTransactionsByBlockHeightEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightEVMRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListTransactionsByBlockHeightEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListTransactionsByBlockHeightEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListTransactionsByBlockHeightEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetBlockDetailsByBlockHeightUTXOsRI": { "type": "object", "properties": { "bits": { "type": "integer", "description": "Numeric representation of the Block bits", "example": 1234 }, "chainwork": { "type": "integer", "description": "Numeric representation of the expected number of hashes required to produce the chain up to this block", "example": 123456 }, "difficulty": { "type": "integer", "description": "Numeric representation of the block difficulty", "example": 123456789 }, "hash": { "type": "string", "description": "String representation of the block hash", "example": "00000000000000000002ad6f9c74faf503bb055c54e0d0746ef34f888f95890f" }, "height": { "type": "integer", "description": "Numeric representation of the block height", "example": 673852 }, "merkleRoot": { "type": "string", "description": "String representation of the block merkle root", "example": "a1c6d67c992a70fca66188e178d9ca7c20d5c775393948f19955be7f0952c0f" }, "nextBlockHash": { "type": "string", "description": "String representation of the next block hash", "example": "00000000000000000008953625613e60b56194ea31f07aad43c7505fbddce78f" }, "previousBlockHash": { "type": "string", "description": "String representation of the previous block hash", "example": "00000000000000000008953625613e60b56194ea31f07aad43c7505fbddce77f" }, "size": { "type": "integer", "description": "Numeric representation of the block size", "example": 3892 }, "timestamp": { "type": "integer", "description": "Numeric representation of the block timestamp in seconds since epoch", "example": 1681893875 }, "transactionsCount": { "type": "integer", "description": "Numeric representation of the block transactions count", "example": 1234 }, "version": { "type": "integer", "description": "Numeric representation of the block version", "example": 12 }, "strippedSize": { "type": "integer", "description": "Numeric representation of the block size excluding witness data", "example": 34555 }, "versionHex": { "type": "string", "description": "String representation of the block version in hexadecimal format", "example": "20000" }, "weight": { "type": "integer", "description": "Numeric representation of block weight", "example": 12412 } }, "required": [ "bits", "chainwork", "difficulty", "hash", "height", "merkleRoot", "nextBlockHash", "previousBlockHash", "size", "timestamp", "transactionsCount", "version", "strippedSize", "versionHex", "weight" ] }, "GetBlockDetailsByBlockHeightUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightUTXOsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetBlockDetailsByBlockHeightUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetBlockDetailsByBlockHeightUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetBlockDetailsByBlockHeightUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListSyncedAddressesXRPRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address.", "example": "rPf1QXeQonoLbA7TH2Ad2gtmPnK5iA2GDq" }, "index": { "type": "integer", "format": "int64", "description": "Represents the index position of the transaction in the specific block.", "example": 1 } }, "required": [ "address", "index" ] }, "ListSyncedAddressesXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListSyncedAddressesXRPRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListSyncedAddressesXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListSyncedAddressesXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "ListSyncedAddressesXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetLastMinedBlockUTXOsRI": { "type": "object", "properties": { "bits": { "type": "integer", "description": "Numeric representation of the Block bits", "example": 524517883 }, "chainwork": { "type": "string", "description": "Numeric representation of the expected number of hashes required to produce the chain up to this block", "example": "000000000000000000000000000000000000000000000000000000262b072797" }, "difficulty": { "type": "integer", "description": "String representation of the block difficulty", "example": 1234567890 }, "merkleRoot": { "type": "string", "description": "String representation of the block merkle root", "example": "961113ae943a3abf76da307cf881c4c6b6c13efb27fb67f02c9cdb46029848e8" }, "size": { "type": "integer", "description": "Represents the total size of the block in Bytes.", "example": 1408113 }, "version": { "type": "integer", "description": "Numeric representation of the block version", "example": 1234567 }, "hash": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "00000000000000000002ad6f9c74faf503bb055c54e0d0746ef34f888f95890f" }, "height": { "type": "integer", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 234324 }, "previousBlockHash": { "type": "string", "description": "Represents the hash of the previous block, also known as the parent block.", "example": "00000000000000000008953625613e60b56194ea31f07aad43c7505fbddce77f" }, "strippedSize": { "type": "integer", "description": "Defines the numeric representation of the block size excluding the witness data.", "example": 4322 }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this block was mined in Unix Timestamp.", "example": 1681893875 }, "transactionsCount": { "type": "integer", "description": "Represents the total number of all transactions as part of this block.", "example": 23432 }, "versionHex": { "type": "string", "description": "Is the hexadecimal string representation of the block's version.", "example": "20000010" }, "weight": { "type": "integer", "description": "Represents a measurement to compare the size of different transactions to each other in proportion to the block size limit.", "example": 17288 } }, "required": [ "bits", "chainwork", "difficulty", "merkleRoot", "size", "version", "hash", "height", "previousBlockHash", "strippedSize", "timestamp", "transactionsCount", "versionHex", "weight" ] }, "GetLastMinedBlockUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetLastMinedBlockUTXOsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetLastMinedBlockUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetLastMinedBlockUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetLastMinedBlockUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetFeeRecommendationsEVMRI": { "type": "object", "properties": { "fast": { "type": "string", "description": "Numeric representation of the fast gas price, calculated from unconfirmed transactions", "example": "0.000025" }, "slow": { "type": "string", "description": "Numeric representation of the slow gas price, calculated from unconfirmed transactions", "example": "0.000010" }, "standard": { "type": "string", "description": "Numeric representation of the standard gas price, calculated from unconfirmed transactions", "example": "0.000015" }, "unit": { "type": "string", "description": "Currency unit", "example": "WEI" } }, "required": [ "fast", "slow", "standard", "unit" ] }, "GetFeeRecommendationsEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetFeeRecommendationsEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetFeeRecommendationsEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetFeeRecommendationsEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetFeeRecommendationsEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "DeriveAndSyncNewReceivingAddressesXRPRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "rPf1QXeQonoLbA7TH2Ad2gtmPnK5iA2GDq" }, "derivationType": { "type": "string", "description": "Represents the derivation type", "example": "account", "enum": [ "account", "bip32" ] }, "format": { "type": "string", "description": "Represents the format of the address.", "example": "P2WPKH" }, "index": { "type": "integer", "example": 1 }, "type": { "type": "string", "description": "Defines the address type.", "example": "change", "enum": [ "change" ] } }, "required": [ "address", "derivationType", "format", "index", "type" ] }, "DeriveAndSyncNewReceivingAddressesXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesXRPRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "DeriveAndSyncNewReceivingAddressesXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "DeriveAndSyncNewReceivingAddressesXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidBlockchain" }, { "$ref": "#/components/schemas/InvalidNetwork" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "DeriveAndSyncNewReceivingAddressesXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetFeeRecommendationsUTXOsRI": { "type": "object", "properties": { "fast": { "type": "string", "description": "Numeric representation of the fast gas price, calculated from unconfirmed transactions", "example": "0.000025" }, "slow": { "type": "string", "description": "Numeric representation of the slow gas price, calculated from unconfirmed transactions", "example": "0.000010" }, "standard": { "type": "string", "description": "Numeric representation of the standard gas price, calculated from unconfirmed transactions", "example": "0.000015" }, "unit": { "type": "string", "description": "Currency unit", "example": "BTC" } }, "required": [ "fast", "slow", "standard", "unit" ] }, "GetFeeRecommendationsUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetFeeRecommendationsUTXOsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetFeeRecommendationsUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetFeeRecommendationsUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetFeeRecommendationsUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListInternalTransactionDetailsByTransactionHashEVMRI": { "type": "object", "properties": { "operationId": { "type": "string", "description": "String representation of internal transaction type trace address", "example": "call_1" }, "operationType": { "type": "string", "description": "String representation of internal transaction type", "example": "CALL" }, "recipient": { "type": "string", "description": "String representation of the internal transaction recipient", "example": "TFdcpuD26PWL44GN5zz4TMxRNFkCiESdVV" }, "sender": { "type": "string", "description": "String representation of the internal transaction sender", "example": "TYomb5BLbq9F3Az1uTQWvf4Be6HH1seG9Z" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount that was transacted", "example": "0.089286906469667626" }, "unit": { "type": "string", "example": "AVAX" } }, "required": [ "amount", "unit" ] }, "timestamp": { "type": "integer", "description": "Numeric representation of the date time", "example": 1622728329 } }, "required": [ "operationId", "operationType", "recipient", "sender", "value", "timestamp" ] }, "ListInternalTransactionDetailsByTransactionHashEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListInternalTransactionDetailsByTransactionHashEVMRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListInternalTransactionDetailsByTransactionHashEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListInternalTransactionDetailsByTransactionHashEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListInternalTransactionDetailsByTransactionHashEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetBlockDetailsByBlockHashEVMRI": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "0x6b1fdd6357845016fb238d1bd58992a01b01c94e668f55e9502d65f0a50ac021" }, "height": { "type": "integer", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 1941208 }, "nextBlockHash": { "type": "string", "description": "Represents the hash of the next block. When this is the last block of the blockchain this value will be an empty string.", "example": "0x78e1c05abcb5dc5ec223800c27bc31cf610488097c8d848dcd2260ac0cf857bf" }, "previousBlockHash": { "type": "string", "description": "Represents the hash of the previous block, also known as the parent block.", "example": "0x45ec99037b9098f402ab83fa962ba54c11b6e5e5d3a981961e0784e8edf6f2a0" }, "size": { "type": "integer", "description": "Numeric representation of the block size", "example": 3892 }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this block was mined in Unix Timestamp.", "example": 1615378134 }, "transactionsCount": { "type": "integer", "description": "Represents the total number of all transactions as part of this block.", "example": 145 }, "extraData": { "type": "string", "description": "Represents any data that can be included by the miner in the block.", "example": "0xd983010203844765746887676f312e342e328777696e646f7773" }, "gasLimit": { "type": "integer", "description": "Numeric representation of the block gas limit", "example": 3141592 }, "gasUsed": { "type": "integer", "description": "Numeric representation of the block gas used", "example": 21000 }, "minedInSeconds": { "type": "integer", "description": "Numeric representation of the block gas limit", "example": 5 }, "nonce": { "type": "integer", "description": "Numeric representation of the block nonce", "example": 2 }, "totalDifficulty": { "type": "integer", "description": "Numeric representation of the block total difficulty", "example": 209515044 } }, "required": [ "hash", "height", "nextBlockHash", "previousBlockHash", "size", "timestamp", "transactionsCount", "extraData", "gasLimit", "gasUsed", "minedInSeconds", "nonce", "totalDifficulty" ] }, "GetBlockDetailsByBlockHashEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetBlockDetailsByBlockHashEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetBlockDetailsByBlockHashEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetBlockDetailsByBlockHashEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetLatestMinedBlockXRPRI": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "f9b304b7933ef298142fdd58ad2dec414a5267dcbbd8a4fe9fc2c0a5f9dde050" }, "height": { "type": "integer", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 15975748 }, "previousBlockHash": { "type": "string", "description": "Represents the hash of the previous block, also known as the parent block.", "example": "de9f9e5b68a1322a16f0d1217cf31765e9101764e6e2f3c7aa058b8c641da37a" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this block was mined in Unix Timestamp.", "example": 1616430182 }, "transactionsCount": { "type": "integer", "description": "Represents the total number of all transactions as part of this block.", "example": 1 }, "totalCoins": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount of all coins.", "example": "22.0012" }, "unit": { "type": "string", "description": "Defines the unit of the amount of all coins.", "example": "Drops" } }, "required": [ "amount", "unit" ] }, "totalFees": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount of all fees.", "example": "0.00001" }, "unit": { "type": "string", "description": "Defines the unit of the amount of all fees.", "example": "XRP" } }, "required": [ "amount", "unit" ] } }, "required": [ "hash", "height", "previousBlockHash", "timestamp", "transactionsCount", "totalCoins", "totalFees" ] }, "GetLatestMinedBlockXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetLatestMinedBlockXRPRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetLatestMinedBlockXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetLatestMinedBlockXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetLatestMinedBlockXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListTransactionsByBlockHeightXRPRI": { "type": "object", "properties": { "additionalData": { "type": "string", "example": "r4CmvbkDWGt9AZmkfuubmiSdsxGZFxAKBY" }, "destinationTag": { "type": "integer", "format": "int64", "description": "Defines a specific Tag that is an additional XRP address feature. It helps identifying a transaction recipient beyond a wallet address.", "example": 3999472835 }, "hash": { "type": "string", "example": "ba3bc1337071c8e73b441fe12a1911f4365d7ea82cace7c8ecba3ee9f364978b" }, "positionInBlock": { "type": "integer", "example": 3 }, "recipient": { "type": "string", "description": "String representation of the transaction to address", "example": "rQpVbrqNCK4dY9ENhV85z8df4jQm81uqRQ" }, "sender": { "type": "string", "description": "String representation of the transaction from address", "example": "rXSYHuUUrFsk8CABEf6PtrYwFWoAfUMrK" }, "status": { "type": "string", "example": "tesSUCCESS" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.", "example": 236589 }, "type": { "type": "string", "example": "Payment" }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "2.0325" }, "unit": { "type": "string", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "offer": { "type": "object", "properties": { "amount": { "type": "string", "example": "8.2365" }, "unit": { "type": "string", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "receive": { "type": "object", "properties": { "amount": { "type": "string", "example": "6.2354" }, "unit": { "type": "string", "example": "XRP" } }, "required": [ "amount", "unit" ] }, "value": { "type": "object", "properties": { "amount": { "type": "string", "example": "22.023" }, "unit": { "type": "string", "example": "XRP" } }, "required": [ "amount", "unit" ] } }, "required": [ "hash", "positionInBlock", "recipient", "sender", "status", "timestamp", "type", "fee", "offer", "receive", "value" ] }, "ListTransactionsByBlockHeightXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightXRPRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListTransactionsByBlockHeightXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListTransactionsByBlockHeightXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListTransactionsByBlockHeightXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListTransactionsByBlockHashEVMRI": { "type": "object", "properties": { "contract": { "type": "integer", "description": "Numeric representation of the transaction contract", "example": 4.755369970448335e+47 }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the fee amount.", "example": "0.00016932" }, "unit": { "type": "string", "description": "Defines the fee unit", "example": "TRX" } }, "required": [ "amount", "unit" ] }, "hash": { "type": "string", "description": "String representation of the transaction hash", "example": "0x8ff7684331492af9bf8026938535a2703a8f2f9b81ef902a5c8b9e41cf9008b7" }, "inputData": { "type": "integer", "description": "Numeric representation of the transaction input", "example": 123 }, "positionInBlock": { "type": "integer", "description": "Represents the index position of the transaction in the specific block.", "example": 1 }, "recipient": { "type": "string", "description": "String representation of the transaction to address", "example": "0xf163C1592EbC8D3C01c146d95c3ea492b5A88652" }, "sender": { "type": "string", "description": "String representation of the transaction from address", "example": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97" }, "status": { "type": "string", "description": "String representation of the transaction status", "example": "mined" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.", "example": 1618208236 }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount value", "example": "0.07540846" }, "unit": { "type": "string", "example": "SUN" } }, "required": [ "amount", "unit" ] }, "gasLimit": { "type": "integer", "description": "String representation of the transaction gas", "example": 21000 }, "gasUsed": { "type": "integer", "description": "Numeric representation of the transaction gas used", "example": 123456 }, "gasPrice": { "type": "object", "properties": { "amount": { "type": "string", "description": "Numeric representation of the transaction gas price", "example": "12345" }, "unit": { "type": "string", "description": "Defines the specific unit of the fee.", "example": "WEI" } }, "required": [ "amount", "unit" ] }, "blockchainSpecific": { "type": "object", "properties": { "bandwidth": { "type": "string", "description": "Represents the amount of bandwidth used by transaction", "example": "268" }, "energy": { "type": "integer", "description": "Represents the amount of energy used by transaction", "example": 127 } }, "required": [ "bandwidth", "energy" ] } }, "required": [ "contract", "fee", "hash", "inputData", "positionInBlock", "recipient", "sender", "status", "timestamp", "value", "gasLimit", "gasUsed", "gasPrice", "blockchainSpecific" ] }, "ListTransactionsByBlockHashEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListTransactionsByBlockHashEVMRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListTransactionsByBlockHashEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListTransactionsByBlockHashEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListTransactionsByBlockHashEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "DeriveAndSyncNewReceivingAddressesUTXORI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0x5050F69a9786F081509234F1a7F4684b5E5b76C9" }, "format": { "type": "string", "description": "Represents the format of the address.", "example": "P2WPKH" }, "index": { "type": "integer", "description": "Represent the address derivation index", "example": 1 }, "derivationType": { "type": "string", "description": "Represents the derivation type", "example": "bip32", "enum": [ "account", "bip32" ] }, "type": { "type": "string", "description": "Defines the address type.", "example": "change", "enum": [ "change" ] } }, "required": [ "address", "format", "index", "derivationType", "type" ] }, "DeriveAndSyncNewReceivingAddressesUTXOR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesUTXORI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "DeriveAndSyncNewReceivingAddressesUTXOE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "DeriveAndSyncNewReceivingAddressesUTXOE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "DeriveAndSyncNewReceivingAddressesUTXOE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListLatestMinedBlocksEVMRI": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the same as transactionId for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols hash is different from transactionId for SegWit transactions.", "example": "3c7b39671b02df07c5c25c2ce135f3a1615acb47d01337211ece8aa5e5926b72" }, "height": { "type": "integer", "description": "Represents the hight of the block where this transaction was mined/confirmed for first time. The height is defined as the number of blocks in the blockchain preceding this specific block.", "example": 45903259 }, "previousBlockHash": { "type": "string", "description": "Represents the hash of the previous block, also known as the parent block.", "example": "24057417652cd253e328ffc9a44ed3a8b0708c0c598bab73c5799505a1452e01" }, "size": { "type": "integer", "description": "Numeric representation of the block size", "example": 123 }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this block was mined in Unix Timestamp.", "example": 1681893875 }, "transactionsCount": { "type": "integer", "description": "Represents the total number of all transactions as part of this block.", "example": 92 }, "extraData": { "type": "string", "description": "Represents any data that can be included by the miner in the block.", "example": "0xd883010001846765746888676f312e31342e34856c696e757800000000000000eb8c4ee17a97af3c7d18e6cfb87d25bf9a483933d393b4fce778c9a7d64eab76471a8ab92c3a7d131c0f9cfbbd9a54b438c80b491c7a579da0e37db6ca823eda01" }, "gasLimit": { "type": "integer", "description": "Defines the total gas limit of all transactions in the block.", "example": 30000000 }, "gasUsed": { "type": "integer", "description": "Represents the total amount of gas used by all transactions in this block.", "example": 686304 }, "minedInSeconds": { "type": "integer", "description": "Specifies the amount of time required for the block to be mined in second", "example": 3 }, "nonce": { "type": "integer", "description": "Represents a random value that can be adjusted to satisfy the proof of work", "example": 2113101077 }, "totalDifficulty": { "type": "integer", "description": "Defines the total difficulty of the chain until this block, i.e. how difficult it is for a specific miner to mine a new block", "example": 2437536 } }, "required": [ "hash", "height", "previousBlockHash", "size", "timestamp", "transactionsCount", "extraData", "gasLimit", "gasUsed", "minedInSeconds", "nonce", "totalDifficulty" ] }, "ListLatestMinedBlocksEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListLatestMinedBlocksEVMRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListLatestMinedBlocksEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListLatestMinedBlocksEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListLatestMinedBlocksEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetTransactionDetailsByTransactionHashUTXOsRIBSZ": { "type": "object", "properties": { "expiryHeight": { "type": "integer", "description": "Numeric representation of the transaction block height expiration", "example": 123 }, "overwintered": { "type": "boolean", "example": true }, "valueBalance": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the transaction value balance", "example": "0.123" }, "unit": { "type": "string", "example": "ZEC" } }, "required": [ "amount" ] }, "versionGroupId": { "type": "string", "description": "String representation of the transaction version group id", "example": "0b892f2085" } }, "description": "Zcash", "required": [ "expiryHeight", "overwintered", "valueBalance", "versionGroupId" ] }, "GetTransactionDetailsByTransactionHashUTXOsRI": { "type": "object", "properties": { "fee": { "type": "object", "description": "Object representation of the transaction fee", "properties": { "amount": { "type": "string", "description": "String representation of the fee value", "example": "0.00016932" }, "unit": { "type": "string", "description": "String representation of the fee unit", "example": "ZEC" } }, "required": [ "amount", "unit" ] }, "hash": { "type": "string", "description": "String representation of the weight", "example": "295e563cbc9d8965695a16d3b1a62a56224c61c01ef0886e25f58a91704f81b5" }, "id": { "type": "string", "description": "String representation of the transaction identifier (txid)", "example": "4888ee9815af71920cf131dd6e9be13e178bac03f091a5e28b984df8cee9ab21" }, "isConfirmed": { "type": "boolean", "description": "Boolean representation of if the transaction is mined", "example": true }, "isReplaceable": { "type": "boolean", "description": "Boolean representation of whether the transaction RBF (Replace-by-Fee) is enabled", "example": true }, "locktime": { "type": "integer", "format": "int64", "description": "Numeric representation of the transaction locktime", "example": 1234567890 }, "positionInBlock": { "type": "integer", "description": "Numeric representation of the transaction index", "example": 123 }, "size": { "type": "integer", "description": "Numeric representation of the transaction size", "example": 123 }, "timestamp": { "type": "integer", "description": "Numeric representation of the timestamp in seconds since epoch", "example": 1582202940 }, "version": { "type": "integer", "description": "Numeric representation of the transaction version", "example": 1 }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "String representation of the block hash", "example": "00000000003f595096f536e70e7dcbc901e64e6d9fc85603194f15035e7a36b9" }, "height": { "type": "integer", "description": "Numeric representation of the block height", "example": 1939750 } }, "required": [ "hash", "height" ] }, "inputs": { "type": "array", "description": "Object Array representation of transaction inputs", "items": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "String array representation of the addresses", "example": "t2UNzUUx8mWBCRYPRezvA363EYXyEpHokyi" } }, "coinbase": { "type": "string", "description": "String representation of the coinbase hex", "example": "coinbase" }, "outputIndex": { "type": "integer", "description": "Numeric representation of the vout", "example": 1 }, "script": { "type": "object", "properties": { "type": { "type": "string", "description": "String representation of the votype", "example": "pubkeyhash" } }, "required": [ "type" ] }, "transactionId": { "type": "string", "description": "String representation of the txid", "example": "4b66461bf88b61e1e4326356534c135129defb504c7acb2fd6c92697d79eb250" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "0.000144" }, "unit": { "type": "string", "example": "ZEC" } } }, "witnesses": { "type": "array", "items": { "type": "string", "description": "Array String representation of the wintness", "example": "3045022100c11ea5740bcd69f0f68a4914279838014d28923134d18e05c5a5486dfd06cc8c02200dadccec3f07bed0d1040f9e5a155efa5fdd40fc91f92342578d26848da4c6b901" } } }, "required": [ "outputIndex", "script", "transactionId" ] } }, "outputs": { "type": "array", "description": "Object Array representation of transaction outputs", "items": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "String array representation of the addresses", "example": "t1fh5m9GirsQnQqpj7PAJKDpKq6iyWtsj4r" } }, "isSpent": { "type": "boolean", "description": "Boolean representation of is the transaction output spent", "example": true }, "script": { "type": "object", "properties": { "type": { "type": "string", "description": "String representation of the type", "example": "pubkeyhash" } }, "required": [ "type" ] }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "0.000144" }, "unit": { "type": "string", "example": "ZEC" } } } }, "required": [ "isSpent", "script" ] } }, "recipients": { "type": "array", "description": "Object Array representation of transaction receivers", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String representation of the receiver address", "example": "t1ZR1TsMeiiAbBKiRH9kFNnVPZoSya3et5s" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "0.000144" }, "unit": { "type": "string", "example": "ZEC" } }, "required": [ "amount" ] }, "addresses": { "type": "string", "description": "String representation of the receiver address", "example": "t1ZR1TsMeiiAbBKiRH9kFNnVPZoSya3et5s" } }, "required": [ "address", "value", "addresses" ] } }, "senders": { "type": "array", "description": "Object Array representation of transaction senders", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String array representation of the sender address", "example": "t1QBnApxL66n3wd2CEF7SRsU9Fqd2C2GD4k" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "0.00873472" }, "unit": { "type": "string", "example": "ZEC" } }, "required": [ "amount" ] } }, "required": [ "address", "value" ] } }, "blockchainSpecific": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashUTXOsRIBS" } }, "required": [ "fee", "hash", "id", "isConfirmed", "isReplaceable", "locktime", "positionInBlock", "size", "timestamp", "version", "minedInBlock", "inputs", "outputs", "recipients", "senders" ] }, "GetTransactionDetailsByTransactionHashUTXOsRIBS": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashUTXOsRIBSZ" } ] }, "GetTransactionDetailsByTransactionHashUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashUTXOsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetTransactionDetailsByTransactionHashUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetTransactionDetailsByTransactionHashUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetTransactionDetailsByTransactionHashUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListHDWalletXPubYPubZPubTransactionsEVMRI": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the same as `transactionId` for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols `hash` is different from `transactionId` for SegWit transactions.", "example": "0x5ed57b5a5a57866e05cbd570b6422d3f18f6d18773a746014979255179b96d67" }, "positionInBlock": { "type": "integer", "description": "Represents the index position of the transaction in the block.", "example": 1 }, "recipient": { "type": "array", "description": "Represents a list of recipient addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.", "example": "0xFf00000000000000000000000000000000008453" }, "amount": { "type": "string", "description": "Represents the amount received to this address.", "example": "0.000144" }, "isMember": { "type": "boolean", "description": "Defines whether an address is a child address derived from the HD wallet (xPub, yPub, zPub) as boolean.", "example": false } }, "required": [ "address", "amount", "isMember" ] } }, "sender": { "type": "array", "description": "Represents a list of sender addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address which sends this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one sender.", "example": "0x5050F69a9786F081509234F1a7F4684b5E5b76C9" }, "amount": { "type": "string", "description": "Represents the amount sent by this address.", "example": "0.00873472" }, "isMember": { "type": "boolean", "description": "Defines whether an address is a child address derived from the HD wallet (xPub, yPub, zPub) as boolean.", "example": true } }, "required": [ "address", "amount", "isMember" ] } }, "timestamp": { "type": "integer", "description": "Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.", "example": 1582202940 }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the amount of the transaction fee.", "example": "0.00016932" } }, "required": [ "amount" ] }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "Represents the hash of the block where this transaction was mined/confirmed for first time. The hash is defined as a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "0x34ff451d04ca9e776ba9f87c91ae128285c0bae14eb77be7bc82353f73cac18d" }, "height": { "type": "integer", "format": "int64", "description": "Represents the hight of the block where this transaction was mined/confirmed for first time. The height is defined as the number of blocks in the blockchain preceding this specific block.", "example": 1903849 } }, "required": [ "hash", "height" ] } }, "required": [ "hash", "positionInBlock", "recipient", "sender", "timestamp", "fee", "minedInBlock" ] }, "ListHDWalletXPubYPubZPubTransactionsEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsEVMRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListHDWalletXPubYPubZPubTransactionsEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListHDWalletXPubYPubZPubTransactionsEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "ListHDWalletXPubYPubZPubTransactionsEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListHDWalletXPubYPubZPubTransactionsEVME422": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestBodyStructure" }, { "$ref": "#/components/schemas/XpubSyncInProgress" } ] }, "PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubRIBSB": { "type": "object", "properties": { "replaceable": { "type": "boolean", "description": "Representation of whether the transaction is replaceable", "example": false } }, "description": "Bitcoin" }, "PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubRIBSBC": { "type": "object", "properties": { "vout": { "type": "array", "description": "Represents the transaction outputs.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Representation of the address", "example": "bchtest:qzhksklst5p5qeer64gf70ssk69st0q3vcpvplqhny" }, "satoshis": { "type": "integer", "format": "int64", "description": "Representation of the satoshis value", "example": 5904 }, "script": { "type": "string", "description": "Representation of the script", "example": "76a914af685bf05d03406723d5509f3e10b68b05bc116688ac" } }, "required": [ "address", "satoshis", "script" ] } } }, "description": "Bitcoin Cash", "required": [ "vout" ] }, "PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubRIBSL": { "type": "object", "properties": { "replaceable": { "type": "boolean", "description": "Representation of whether the transaction is replaceable", "example": true } }, "description": "Litecoin" }, "PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubRIBSZ": { "type": "object", "properties": { "replaceable": { "type": "boolean", "description": "Representation of whether the transaction is replaceable", "example": false } }, "description": "Zcash" }, "PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubRI": { "type": "object", "properties": { "additionalData": { "type": "string", "description": "Representation of the additional data", "example": "yourAdditionalDataHere" }, "locktime": { "type": "integer", "format": "int64", "description": "Represents the time at which a particular transaction can be added to the blockchain.", "example": 1781965 }, "size": { "type": "integer", "description": "Represents the total size of this transaction.", "example": 243 }, "version": { "type": "integer", "description": "Representation of the transaction's version", "example": 2 }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "When isConfirmed is True - Defines the amount of the transaction fee When isConfirmed is False - For ETH-based blockchains this attribute represents the max fee value.", "example": "0.0000279" }, "unit": { "type": "string", "example": "ZEC" } }, "required": [ "amount", "unit" ] }, "feePerByte": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the fee per byte value", "example": "0.00000014" }, "unit": { "type": "string", "example": "ZEC" } }, "required": [ "amount", "unit" ] }, "inputs": { "type": "array", "description": "Represents the transaction inputs.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Representation of the address", "example": "tmHb1bHWAvK6hHDZEq57cbEz2wgxYEMqdbd" }, "change": { "type": "integer", "format": "int64", "description": "Representation of the change value", "example": 0 }, "derivationIndex": { "type": "integer", "format": "int64", "description": "Representation of the derivation index of the xpub address.", "example": 100 }, "outputIndex": { "type": "integer", "description": "Representation of the output index", "example": 1 }, "satoshis": { "type": "integer", "format": "int64", "description": "Representation of the satoshis value", "example": 100000000 }, "script": { "type": "string", "description": "Representation of the script string", "example": "76a914565d9ded3c1b02611d94efa1edfd4a65fd4132a588ac" }, "sighash": { "type": "string", "description": "Representation of the hash that should be signed.", "example": "c6616518a5b4dd01a9c76d021fafda817d3ea22d2e8f09f7fbae71ad83596e5c" }, "transactionId": { "type": "string", "description": "Represents the reference transaction identifier.", "example": "f27ac39bec0e620fc0d5a25b1a3f5d1fd8e8f023234a615c79101db9cc8c58c1" } }, "required": [ "address", "change", "derivationIndex", "outputIndex", "satoshis", "script", "sighash", "transactionId" ] } }, "outputs": { "type": "array", "description": "Represents the transaction outputs.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Representation of the address", "example": "tmG2WnrxrpfXxPf5Phk6yPZffqQhezhcUsz" }, "satoshis": { "type": "integer", "format": "int64", "description": "Representation of the satoshis value", "example": 1000 }, "script": { "type": "string", "description": "Representation of the script", "example": "76a9144540239415ca840c496f146859374125a1ad6f6188ac" } }, "required": [ "address", "satoshis", "script" ] } }, "blockchainSpecific": { "$ref": "#/components/schemas/PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubRIBS" } }, "required": [ "additionalData", "locktime", "size", "version", "fee", "feePerByte", "inputs", "outputs" ] }, "PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubRIBS": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubRIBSB" }, { "$ref": "#/components/schemas/PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubRIBSBC" }, { "$ref": "#/components/schemas/PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubRIBSL" }, { "$ref": "#/components/schemas/PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubRIBSZ" } ] }, "PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListLogsByTransactionHashEVMRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address from which this log is generated.", "example": "0xD04E772BC0d591fBD288f2E2a86aFA3D3CB647F8" }, "data": { "type": "string", "description": "Representation of the 32 byte non-indexed argument of the log", "example": "0x0000000000000000000000000000000000000000000018aa053302d4ad9e2c9c" }, "isRemoved": { "type": "boolean", "description": "Representation of whether the event was removed", "example": true }, "name": { "type": "string", "description": "Representation of the name of the text event signature", "example": "Transfer (index_topic_1 address from, index_topic_2 address to, uint256 value)" }, "topics": { "type": "array", "items": { "type": "string", "description": "Representation of the topics associated with the event", "example": "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef" } } }, "required": [ "address", "data", "isRemoved", "topics" ] }, "ListLogsByTransactionHashEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListLogsByTransactionHashEVMRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListLogsByTransactionHashEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListLogsByTransactionHashEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListLogsByTransactionHashEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "EstimateContractInteractionGasLimitEVMRI": { "type": "object", "properties": { "gasLimit": { "type": "integer", "description": "Represents the amount of gas used by this specific transaction alone.", "example": 550000 } }, "required": [ "gasLimit" ] }, "EstimateContractInteractionGasLimitEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/EstimateContractInteractionGasLimitEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "EstimateContractInteractionGasLimitEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "EstimateContractInteractionGasLimitEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "EstimateContractInteractionGasLimitEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetHDWalletXPubYPubZPubDetailsEVMRI": { "type": "object", "properties": { "confirmedBalance": { "type": "string", "description": "Specifies the confirmed coins balance of the Wallet.", "example": "0.0021" }, "totalReceived": { "type": "string", "description": "Defines the total currency received to the Wallet.", "example": "0.0002" }, "totalSpent": { "type": "string", "description": "Defines the total currency spent from the Wallet.", "example": "0.0001" }, "unit": { "type": "string", "example": "ETH" } }, "required": [ "confirmedBalance", "totalReceived", "totalSpent", "unit" ] }, "GetHDWalletXPubYPubZPubDetailsEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetHDWalletXPubYPubZPubDetailsEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetHDWalletXPubYPubZPubDetailsEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "GetHDWalletXPubYPubZPubDetailsEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetHDWalletXPubYPubZPubDetailsEVME422": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestBodyStructure" }, { "$ref": "#/components/schemas/XpubSyncInProgress" } ] }, "GetFeeRecommendationsXRPRI": { "type": "object", "properties": { "fast": { "type": "string", "description": "Numeric representation of the fast gas price, calculated from unconfirmed transactions", "example": "0.000025" }, "feeCushionMultiplier": { "type": "string", "description": "Fee cushion multiplier used to multiply the base fee", "example": "1.2" }, "slow": { "type": "string", "description": "Numeric representation of the slow gas price, calculated from unconfirmed transactions", "example": "0.000010" }, "standard": { "type": "string", "description": "Numeric representation of the standard gas price, calculated from unconfirmed transactions", "example": "0.000015" }, "unit": { "type": "string", "description": "Currency unit", "example": "XRP" } }, "required": [ "fast", "feeCushionMultiplier", "slow", "standard", "unit" ] }, "GetFeeRecommendationsXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetFeeRecommendationsXRPRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetFeeRecommendationsXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetFeeRecommendationsXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetFeeRecommendationsXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetTransactionDetailsByTransactionHashEVMRIBSE": { "type": "object", "properties": { "signatureData": { "type": "object", "description": "Representation of the transaction signature method.", "properties": { "functionSignature": { "type": "string", "description": "Representation of the method function signature", "example": "_SIMONdotBlack_(int8[]. int224[])" }, "method": { "type": "string", "description": "Representation of the method function name", "example": "_SIMONdotBlack_" }, "signature": { "type": "string", "description": "Representation of the hex signature", "example": "0x095ea7b3" } } } }, "description": "Ethereum" }, "GetTransactionDetailsByTransactionHashEVMRI": { "type": "object", "properties": { "contract": { "type": "string", "description": "String representation of the transaction contract address", "example": "0xcf5540fffcdc3d510b18bfca6d2b9987b0772559" }, "fee": { "type": "object", "description": "Object representation of the transaction fee", "properties": { "amount": { "type": "string", "description": "String representation of the transaction fee value", "example": "0.00016932" }, "unit": { "type": "string", "example": "ETH" } }, "required": [ "amount", "unit" ] }, "gasLimit": { "type": "integer", "description": "String representation of the transaction gas limit", "example": 552020 }, "gasUsed": { "type": "integer", "description": "String representation of the transaction used gas", "example": 24673 }, "hash": { "type": "string", "description": "String representation of the transaction hash", "example": "0x1ec73b0f61359927d02376b35993b756b1097cb9a857bec23da4c98c4977d2b2" }, "inputData": { "type": "string", "description": "String representation of the transaction input data", "example": "0x67a5cd0600000000000000000000000031f42841c2db5173425b5223809cf3a38fede360" }, "nonce": { "type": "integer", "format": "int64", "description": "Numeric representation of the transaction nonce", "example": 10 }, "positionInBlock": { "type": "integer", "description": "Numeric representation of the transaction index", "example": 1 }, "recipient": { "type": "string", "description": "String representation of the recipient address", "example": "0x2MzakdGTEp8SMWEHKwKM4HYv6uNCBXtHpkV" }, "sender": { "type": "string", "description": "String representation of the sender address", "example": "0x2N5PcdirZUzKF9bWuGdugNuzcQrCbBudxv1" }, "status": { "type": "string", "description": "String representation of the transaction status", "example": "0x1" }, "timestamp": { "type": "integer", "description": "Numeric representation of the timestamp in seconds since epoch", "example": 1582202940 }, "value": { "type": "object", "description": "Object representation of the transacted amount", "properties": { "amount": { "type": "string", "description": "String representation of the transacted amount", "example": "0.000202368455118091" }, "unit": { "type": "string", "example": "ETH" } }, "required": [ "amount", "unit" ] }, "gasPrice": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the transaction gas price", "example": "2994782927" }, "unit": { "type": "string", "example": "WEI" } }, "required": [ "amount", "unit" ] }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "String representation of the block hash", "example": "00000000407f119ecb74b44229228910400aaeb9f4e3b9869955b85a53e9b7db" }, "height": { "type": "integer", "description": "Numeric representation of the block height", "example": 1939750 } }, "required": [ "hash", "height" ] }, "blockchainSpecific": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashEVMRIBS" } }, "required": [ "fee", "gasLimit", "gasUsed", "hash", "inputData", "nonce", "positionInBlock", "recipient", "sender", "status", "timestamp", "value", "gasPrice", "minedInBlock" ] }, "GetTransactionDetailsByTransactionHashEVMRIBS": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashEVMRIBSE" } ] }, "GetTransactionDetailsByTransactionHashEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetTransactionDetailsByTransactionHashEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetTransactionDetailsByTransactionHashEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetTransactionDetailsByTransactionHashEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetTokenDetailsByContractAddressEVMRI": { "type": "object", "properties": { "name": { "type": "string", "description": "String representation of the token name", "example": "Band Protocol" }, "standard": { "type": "string", "description": "String representation of the token standards", "example": "ERC-20" }, "symbol": { "type": "string", "description": "String representation of the token symbol", "example": "AQUA" }, "fungibleValues": { "type": "object", "properties": { "decimals": { "type": "integer", "description": "Defines the decimals allowed for the token.", "example": 6 }, "totalSupply": { "type": "string", "description": "Represent the token total supply", "example": "1000000" } }, "required": [ "totalSupply" ] } }, "required": [ "name", "standard", "symbol" ] }, "GetTokenDetailsByContractAddressEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetTokenDetailsByContractAddressEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetTokenDetailsByContractAddressEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetTokenDetailsByContractAddressEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetTokenDetailsByContractAddressEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetRawTransactionDataUTXOsRI": { "type": "object", "properties": { "transactionHex": { "type": "string", "description": "Represents the raw transaction data in hexadecimal format.", "example": "01000000000101f8cb1cd1892d31aaafa35a92128b3a11469e675261c83a30be5b25ae8c97eeca0100000017160014daaf6d5cb86befe42df851a4d1df052e663754c1ffffffff02403800000000000017a914507a5bd8cac1d9efdf4c0a4bfacb3e0abb4f8d15879cd90c000000000017a91475eb14fa1dc2c72637df3c58bc22d925ca0753af8702483045022100c11ea5740bcd69f0f68a4914279838014d28923134d18e05c5a5486dfd06cc8c02200dadccec3f07bed0d1040f9e5a155efa5fdd40fc91f92342578d26848da4c6b901210287e995526aa6ccb96141bb598fc7f73323279e026c55039d15f0cfbda5dea84100000000" } }, "required": [ "transactionHex" ] }, "GetRawTransactionDataUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetRawTransactionDataUTXOsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetRawTransactionDataUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetRawTransactionDataUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetRawTransactionDataUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListTokensTransfersByTransactionHashEVMRI": { "type": "object", "properties": { "recipient": { "type": "string", "description": "Defines the address to which the recipient receives the transferred tokens.", "example": "0x9e91eb3a35b96f0f0fe71f3c17fe8d29eb406b16" }, "sender": { "type": "string", "description": "Defines the address from which the sender transfers tokens.", "example": "0x9df8a6441e8a3dda75019595d431f9aa0dec475c" }, "tokenData": { "type": "object", "properties": { "name": { "type": "string", "description": "Defines the token's name as a string.", "example": "Tether USD" }, "nonFungibleValues": { "type": "object", "properties": { "tokenId": { "type": "string", "description": "Represents the tokenId value", "example": "430686" } } }, "symbol": { "type": "string", "description": "Defines the token symbol by which the token contract is known. It is usually 3-4 characters in length.", "example": "BAND" }, "contractAddress": { "type": "string", "description": "String representation of contract address of the token that was transferred", "example": "0x7ceb23fd6bc0add59e62ac25578270cff1b9f619" }, "fungibleValues": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the token amount that was transferred", "example": "0.010437808060307336" }, "decimals": { "type": "integer", "description": "String representation of the token decimals", "example": 8 } }, "required": [ "amount" ] }, "standard": { "type": "string", "description": "String representation of the token type", "example": "ERC-20" } }, "required": [ "contractAddress", "fungibleValues", "standard" ] }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the fee value of the transaction in which the token transfer happened", "example": "0.003" }, "unit": { "type": "string", "description": "Unit of the fee amount", "example": "AVAX" } }, "required": [ "amount", "unit" ] } }, "required": [ "recipient", "sender", "tokenData", "fee" ] }, "ListTokensTransfersByTransactionHashEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListTokensTransfersByTransactionHashEVMRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListTokensTransfersByTransactionHashEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListTokensTransfersByTransactionHashEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListTokensTransfersByTransactionHashEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetHDWalletXPubYPubZPubAssetsXRPRI": { "type": "object", "properties": { "confirmedBalance": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the confirmed balance for the specified blockchain protocol.", "example": "0.008516447598774679" }, "unit": { "type": "string", "description": "Specifies the unit of the amount of the confirmed balance.", "example": "XRP" } }, "required": [ "amount", "unit" ] } }, "required": [ "confirmedBalance" ] }, "GetHDWalletXPubYPubZPubAssetsXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsXRPRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetHDWalletXPubYPubZPubAssetsXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetHDWalletXPubYPubZPubAssetsXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" }, { "$ref": "#/components/schemas/InvalidBlockchain" }, { "$ref": "#/components/schemas/InvalidNetwork" }, { "$ref": "#/components/schemas/XpubNotSynced" } ] }, "GetHDWalletXPubYPubZPubAssetsXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetHDWalletXPubYPubZPubAssetsXRPE422": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestBodyStructure" }, { "$ref": "#/components/schemas/XpubSyncInProgress" } ] }, "GetHDWalletXPubYPubZPubAssetsUTXORI": { "type": "object", "properties": { "confirmedBalance": { "type": "object", "properties": { "amount": { "type": "string", "description": "Specifies the confirmed coins balance of the Wallet.", "example": "0.008516447598774679" }, "unit": { "type": "string", "description": "Specifies the unit of the amount of the confirmed balance.", "example": "BTC" } }, "required": [ "amount", "unit" ] } }, "required": [ "confirmedBalance" ] }, "GetHDWalletXPubYPubZPubAssetsUTXOR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsUTXORI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetHDWalletXPubYPubZPubAssetsUTXOE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetHDWalletXPubYPubZPubAssetsUTXOE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidXpub" } ] }, "GetHDWalletXPubYPubZPubAssetsUTXOE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetHDWalletXPubYPubZPubAssetsUTXOE422": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestBodyStructure" }, { "$ref": "#/components/schemas/XpubSyncInProgress" } ] }, "ValidateAddressEVMRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the specific address that will be checked if it's valid or not.", "example": "15XyNC88pujwuuur8DCsXBCfEhJJMzHayU" }, "isValid": { "type": "boolean", "description": "Defines whether the address is valid or not. Set as boolean.", "example": true } }, "required": [ "address", "isValid" ] }, "ValidateAddressEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ValidateAddressEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ValidateAddressEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ValidateAddressEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ValidateAddressEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ValidateAddressXRPRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the specific address that will be checked if it's valid or not.", "example": "rGuhZqkVANWyHQUSWQzCLPKnho9gzVUPng" }, "isValid": { "type": "boolean", "description": "Defines whether the address is valid or not. Set as boolean.", "example": true } }, "required": [ "address", "isValid" ] }, "ValidateAddressXRPR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ValidateAddressXRPRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ValidateAddressXRPE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ValidateAddressXRPE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ValidateAddressXRPE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "BroadcastLocallySignedTransactionRI": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "Represents the unique identifier of a transaction, i.e. it could be `transactionId` in UTXO-based protocols like Bitcoin, and transaction `hash` in Ethereum blockchain.", "example": "347d96855d41b77f1e23048fff11c18e9fe699ee69b0b402338f34189734e0a2" } }, "required": [ "transactionId" ] }, "BroadcastLocallySignedTransactionR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/BroadcastLocallySignedTransactionRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "BroadcastLocallySignedTransactionE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "BroadcastLocallySignedTransactionE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "BroadcastLocallySignedTransactionE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "BroadcastLocallySignedTransactionE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/AlreadyExists" } ] }, "DecodeRawTransactionHexUTXORI": { "type": "object", "properties": { "id": { "type": "string", "description": "Represents the same as transactionId for UTXOs protocols like Bitcoin.", "example": "1ec73b0f61359927d02376b35993b756b1097cb9a857bec23da4c98c4977d2b2" }, "size": { "type": "integer", "description": "Represents the total size of this transaction.", "example": 248 }, "hash": { "type": "string", "example": "1ec73b0f61359927d02376b35993b756b1097cb9a857bec23da4c98c4977d2b2" }, "inputs": { "type": "array", "description": "Inputs of the transaction", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address which send the amount.", "example": "2N5PcdirZUzKF9bWuGdugNuzcQrCbBudxv1" }, "outputIndex": { "type": "integer", "description": "Represents the output of a transaction.", "example": 3 }, "script": { "type": "object", "description": "Script sig of input", "properties": { "asm": { "type": "string", "description": "The asm strands for assembly, which is the symbolic representation of the Bitcoin's Script language op-codes.", "example": "0014daaf6d5cb86befe42df851a4d1df052e663754c1" }, "hex": { "type": "string", "description": "Represents the hex of the public key of the address.", "example": "160014daaf6d5cb86befe42df851a4d1df052e663754c1" }, "type": { "type": "string", "description": "Represents the script type of the reference transaction identifier.", "example": "scripthash" } }, "required": [ "asm", "hex", "type" ] }, "sequence": { "type": "integer", "description": "Represents the script sequence number.", "example": 34 }, "transactionId": { "type": "string", "description": "Represents the transaction inputs' indentifier.", "example": "108c523cba933520905136262f6cdef87d68a1fa4ffb95b1a73f69a07ed2aed3" }, "witnesses": { "type": "array", "items": { "type": "string", "description": "Represents the transaction witness", "example": "3045022100c11ea5740bcd69f0f68a4914279838014d28923134d18e05c5a5486dfd06cc8c02200dadccec3f07bed0d1040f9e5a155efa5fdd40fc91f92342578d26848da4c6b901" } } }, "required": [ "outputIndex", "script", "sequence", "transactionId" ] } }, "locktime": { "type": "integer", "description": "Represents the time at which a particular transaction can be added to the blockchain.", "example": 1781965 }, "outputs": { "type": "array", "description": "Outputs of the transaction", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address which send the amount.", "example": "2MzakdGTEp8SMWEHKwKM4HYv6uNCBXtHpkV" }, "script": { "type": "object", "description": "Script pub key of the transaction", "properties": { "asm": { "type": "string", "description": "Represents the assembly of the script public key of the address.", "example": "OP_HASH160 507a5bd8cac1d9efdf4c0a4bfacb3e0abb4f8d15 OP_EQUAL" }, "hex": { "type": "string", "description": "Represents the hex of the script public key of the address.", "example": "a914507a5bd8cac1d9efdf4c0a4bfacb3e0abb4f8d1587" }, "type": { "type": "string", "description": "Represents the script type.", "example": "scripthash" } }, "required": [ "asm", "hex", "type" ] }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the transaction amount.", "example": "10.334" }, "unit": { "type": "string", "example": "ZEC" } }, "required": [ "unit" ] } }, "required": [ "script" ] } }, "version": { "type": "integer", "description": "Represents the transaction version number.", "example": 2 }, "vsize": { "type": "integer", "description": "Represents the virtual size of this transaction.", "example": 166 }, "weight": { "type": "integer", "description": "Represents the size of Bitcoin block, measured in weight units and including the segwit discount.", "example": 236 } }, "required": [ "id", "size", "hash", "inputs", "locktime", "outputs", "version", "vsize", "weight" ] }, "DecodeRawTransactionHexUTXOR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DecodeRawTransactionHexUTXORI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "DecodeRawTransactionHexUTXOE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "DecodeRawTransactionHexUTXOE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidBlockchain" } ] }, "DecodeRawTransactionHexUTXOE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "PrepareTransactionFromAddressEVMRI": { "type": "object", "properties": { "inputData": { "type": "string", "description": "Representation of the data in hex value", "example": "0x006e0065006b006100760073007400720069006e0067" }, "nonce": { "type": "integer", "description": "Represents the sequential running number for an address, starting from 0 for the first transaction. E.g., if the nonce of a transaction is 10, it would be the 11th transaction sent from the sender's address.", "example": 0 }, "recipient": { "type": "string", "description": "The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.", "example": "0x041c594a0cc194e826bef5411b29c7f27001b7e3" }, "sender": { "type": "string", "description": "Represents the address which sends this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one sender.", "example": "0x03654A9E78771442CAdf8DB37ae60D6a12bAEa9f" }, "sighash": { "type": "string", "description": "Representation of the hash that should be signed", "example": "9f59f25bc9f6cbff293ceee32c1fb25ae82fab23a99b860e26cad800ceadd123" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Representation of the transacted amount", "example": "2000000009340" }, "unit": { "type": "string", "description": "Represents the unit of the amount transacted.", "example": "WEI" } }, "required": [ "amount", "unit" ] }, "fee": { "type": "object", "description": "Defines the amount of the transaction fee.", "properties": { "gasPrice": { "type": "integer", "description": "Represents the price offered to the miner to purchase this amount of gas.", "example": 47125353 }, "maxFeePerGas": { "type": "integer", "description": "String representation of the max fee per gas", "example": 47125353 }, "maxPriorityFeePerGas": { "type": "integer", "description": "String representation of the max priority fee per gas", "example": 47125353 }, "unit": { "type": "string", "description": "String representation of the fee unit", "example": "WEI" } }, "required": [ "gasPrice", "maxFeePerGas", "maxPriorityFeePerGas", "unit" ] }, "gasLimit": { "type": "integer", "description": "Represents the amount of gas used by this specific transaction alone.", "example": 21220 }, "type": { "type": "string", "description": "Representation of the transaction type", "example": "legacy-transaction", "enum": [ "legacy-transaction", "access-list-transaction", "gas-fee-market-transaction" ] } }, "required": [ "inputData", "nonce", "recipient", "sender", "sighash", "value", "fee", "gasLimit", "type" ] }, "PrepareTransactionFromAddressEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/PrepareTransactionFromAddressEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "PrepareTransactionFromAddressEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "PrepareTransactionFromAddressEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "PrepareTransactionFromAddressEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "PrepareAFungibleTokenTransferFromAddressEVMRI": { "type": "object", "properties": { "inputData": { "type": "string", "description": "Representation of the data in hex value", "example": "0x0079006f00750072004100640064006900740069006f006e0061006c00440061007400610048006500720065" }, "nonce": { "type": "integer", "description": "Represents the sequential running number for an address, starting from 0 for the first transaction. E.g., if the nonce of a transaction is 10, it would be the 11th transaction sent from the sender's address.", "example": 0 }, "recipient": { "type": "string", "description": "The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.", "example": "0x534bd102153ef199abae8296a2fae4599fc44cdc" }, "sender": { "type": "string", "description": "Represents the address which sends this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one sender.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, "sigHash": { "type": "string", "description": "Representation of the hash that should be signed", "example": "9f59f25bc9f6cbff293ceee32c1fb25ae82fab23a99b860e26cad800ceadd123" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Representation of the amount to be transferred", "example": "1.09340" } }, "required": [ "amount" ] }, "fee": { "type": "object", "description": "Defines the amount of the transaction fee.", "properties": { "gasPrice": { "type": "integer", "description": "Represents the price offered to the miner to purchase this amount of gas.", "example": 2500000007 }, "maxFeePerGas": { "type": "integer", "description": "Representation of the max fee per gas value", "example": 2000000008 }, "maxPriorityFeePerGas": { "type": "integer", "description": "Representation of the max priority fee per gas value", "example": 2000000000 }, "unit": { "type": "string", "example": "WEI" } }, "required": [ "gasPrice", "maxFeePerGas", "maxPriorityFeePerGas", "unit" ] }, "gasLimit": { "type": "integer", "description": "Represents the amount of gas used by this specific transaction alone.", "example": 552020 }, "type": { "type": "string", "description": "Representation of the transaction type", "example": "legacy-transaction", "enum": [ "legacy-transaction", "access-list-transaction", "gas-fee-market-transaction" ] } }, "required": [ "inputData", "nonce", "recipient", "sender", "sigHash", "value", "fee", "gasLimit", "type" ] }, "PrepareAFungibleTokenTransferFromAddressEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/PrepareAFungibleTokenTransferFromAddressEVMRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "PrepareAFungibleTokenTransferFromAddressEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "PrepareAFungibleTokenTransferFromAddressEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "PrepareAFungibleTokenTransferFromAddressEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "DecodeX-AddressRI": { "type": "object", "properties": { "addressTag": { "type": "integer", "format": "int64", "description": "Defines a specific Tag that is an additional XRP address feature. It helps identifying a transaction recipient beyond a wallet address.", "example": 3999472835 }, "classicAddress": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z" } }, "required": [ "addressTag", "classicAddress" ] }, "DecodeX-AddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DecodeX-AddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "DecodeX-AddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "DecodeX-AddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidBlockchain" }, { "$ref": "#/components/schemas/InvalidNetwork" } ] }, "DecodeX-AddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListUnconfirmedTransactionsByAddressUTXOsRIBSZ": { "type": "object", "properties": { "expiryHeight": { "type": "integer", "description": "Represents a block height after which the transaction will expire.", "example": 123 }, "overwintered": { "type": "boolean", "description": "\"Overwinter\" is the network upgrade for the Zcash blockchain.", "example": true }, "valueBalance": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the transaction value balance.", "example": "0.123" }, "unit": { "type": "string", "example": "ZEC" } }, "required": [ "amount", "unit" ] }, "versionGroupId": { "type": "string", "description": "Represents the transaction version group ID.", "example": "1234567" } }, "description": "Zcash", "required": [ "expiryHeight", "overwintered", "valueBalance", "versionGroupId" ] }, "ListUnconfirmedTransactionsByAddressUTXOsRI": { "type": "object", "properties": { "hash": { "type": "string", "description": "String representation of the transaction hash", "example": "86868a1f4e6c2e675aa0031ca8d78a28f3ffda74185ca9377ff39f9b1c730536" }, "id": { "type": "string", "description": "Represents the unique identifier of a transaction, i.e. it could be `transactionId` in UTXO-based protocols like Bitcoin, and transaction `hash` in Ethereum blockchain.", "example": "3d74a44fe666308242b2c9dd0197a601779d17ba9fe8f7a23612c53a910bc98d" }, "isReplaceable": { "type": "boolean", "description": "Boolean representation of whether the transaction RBF (Replace-by-Fee) is enabled", "example": true }, "locktime": { "type": "integer", "format": "int64", "description": "Numeric representation of the transaction locktime", "example": 1 }, "size": { "type": "integer", "description": "Numeric representation of the transaction size", "example": 123 }, "timestamp": { "type": "integer", "description": "Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.", "example": 1633518942013 }, "version": { "type": "integer", "description": "Numeric representation of the transaction version", "example": 1 }, "inputs": { "type": "array", "description": "Object Array representation of transaction inputs", "items": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "Represents the addresses which send/receive the amount.", "example": "t2UNzUUx8mWBCRYPRezvA363EYXyEpHokyi" } }, "outputIndex": { "type": "integer", "description": "It refers to the index of the output address of this transaction. The index starts from 0.", "example": 1 }, "script": { "type": "object", "properties": { "type": { "type": "string", "description": "Represents the script type of the reference transaction identifier.", "example": "pubkeyhash" } }, "required": [ "type" ] }, "transactionId": { "type": "string", "description": "Represents the reference transaction identifier.", "example": "4b66461bf88b61e1e4326356534c135129defb504c7acb2fd6c92697d79eb250" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Defines the specific amount.", "example": "0.123" }, "unit": { "type": "string", "example": "ZEC" } } }, "witnesses": { "type": "array", "items": { "type": "string", "description": "Represents an array hex-encoded witness data (if there is any) as strings.", "example": "3045022100c11ea5740bcd69f0f68a4914279838014d28923134d18e05c5a5486dfd06cc8c02200dadccec3f07bed0d1040f9e5a155efa5fdd40fc91f92342578d26848da4c6b901" } } }, "required": [ "outputIndex", "script", "transactionId" ] } }, "outputs": { "type": "array", "description": "Object Array representation of transaction outputs", "items": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "Represents the addresses which send the amount.", "example": "t2UNzUUx8mWBCRYPRezvA363EYXyEpHokyi" } }, "isSpent": { "type": "boolean", "description": "Defines whether the transaction output has been spent or not.", "example": true }, "script": { "type": "object", "properties": { "type": { "type": "string", "description": "String representation of the type", "example": "pubkeyhash" } }, "required": [ "type" ] }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the specific amount.", "example": "0.123" }, "unit": { "type": "string", "example": "ZEC" } } } }, "required": [ "isSpent", "script" ] } }, "recipients": { "type": "array", "description": "Represents a list of recipient addresses with the respective amounts.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String representation of the receiver addresses", "example": "tb1qdc0jaryry3u56j94xp5zeyhn9zjuzkqec2mvfh" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "Represents the amount received to this address.", "example": "0.123" }, "unit": { "type": "string", "example": "ZEC" } }, "required": [ "amount", "unit" ] } }, "required": [ "address", "value" ] } }, "senders": { "type": "array", "description": "Object Array representation of transaction senders", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the address of the sender.", "example": "n1eypQAVqQMmDuXffCF3LPXREmF71ecuai" }, "value": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the amount", "example": "0.123" }, "unit": { "type": "string", "example": "ZEC" } }, "required": [ "amount", "unit" ] } }, "required": [ "address", "value" ] } }, "blockchainSpecific": { "$ref": "#/components/schemas/ListUnconfirmedTransactionsByAddressUTXOsRIBS" } }, "required": [ "hash", "id", "isReplaceable", "locktime", "size", "timestamp", "version", "inputs", "outputs", "recipients", "senders" ] }, "ListUnconfirmedTransactionsByAddressUTXOsRIBS": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ListUnconfirmedTransactionsByAddressUTXOsRIBSZ" } ] }, "ListUnconfirmedTransactionsByAddressUTXOsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "offset": { "type": "integer", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, "total": { "type": "integer", "description": "Defines the total number of items returned in the response.", "example": 100 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListUnconfirmedTransactionsByAddressUTXOsRI" }, "example": [] } }, "required": [ "limit", "items", "offset", "total" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListUnconfirmedTransactionsByAddressUTXOsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListUnconfirmedTransactionsByAddressUTXOsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListUnconfirmedTransactionsByAddressUTXOsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListConfirmedTransactionsByAddressEVMRIBST": { "type": "object", "properties": { "bandwidthUsed": { "type": "integer", "description": "Numeric representation of the transaction used bandwidth", "example": 50 }, "energyUsed": { "type": "string", "description": "String representation of the transaction used energy", "example": "100.20" } }, "description": "Tron", "required": [ "bandwidthUsed", "energyUsed" ] }, "ListConfirmedTransactionsByAddressEVMRI": { "type": "object", "properties": { "contract": { "type": "string", "description": "String representation of the transaction contract address", "example": "0x534bD102153EF199abAe8296a2FaE4599fC44Cdc" }, "fee": { "type": "object", "description": "Object representation of the transaction fee", "properties": { "amount": { "type": "string", "description": "String representation of the fee value", "example": "1" }, "unit": { "type": "string", "description": "String representation of the fee unit.", "example": "TRX" } }, "required": [ "amount", "unit" ] }, "gasLimit": { "type": "integer", "description": "String representation of the transaction gas limit", "example": 21000 }, "gasUsed": { "type": "integer", "description": "String representation of the transaction used gas", "example": 21000 }, "hash": { "type": "string", "description": "String representation of the transaction hash", "example": "9580df7e484cdc2012111d5e240a1c46e27be5892d13845429a63e649942cb03" }, "inputData": { "type": "string", "description": "Numeric representation of the transaction input", "example": "2" }, "positionInBlock": { "type": "integer", "description": "Numeric representation of the transaction index", "example": 23 }, "recipient": { "type": "string", "description": "String representation of the transaction to address", "example": "TCzuNDY939KLNQKTrPyZAb2Y1SFUEoNyV8" }, "sender": { "type": "string", "description": "String representation of the transaction from address", "example": "TL32fTDHm5qj9m11QsBnBTj8y3nEEjnLqj" }, "status": { "type": "string", "description": "String representation of the transaction status", "example": "0x1" }, "timestamp": { "type": "integer", "description": "Numeric representation of the timestamp in seconds since epoch", "example": 1738851666 }, "gasPrice": { "type": "object", "properties": { "amount": { "type": "string", "description": "String representation of the transaction gas price", "example": "3558974297" }, "unit": { "type": "string", "description": "String representation of the gas price unit", "example": "WEI" } }, "required": [ "amount", "unit" ] }, "minedInBlock": { "type": "object", "properties": { "hash": { "type": "string", "description": "String representation of the block hash", "example": "000000000422f5756f15d6da892d17147b4906704e5216bde463e177c4e9009e" }, "height": { "type": "integer", "description": "Numeric representation of the block height", "example": 69399925 } }, "required": [ "hash", "height" ] }, "value": { "type": "object", "description": "Object representation of the transacted amount", "properties": { "amount": { "type": "string", "description": "String representation of the amount value", "example": "787.553859" }, "unit": { "type": "string", "description": "String representation of the amount unit.", "example": "TRX" } }, "required": [ "amount", "unit" ] }, "blockchainSpecific": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressEVMRIBS" } }, "required": [ "contract", "fee", "gasLimit", "gasUsed", "hash", "inputData", "positionInBlock", "recipient", "sender", "status", "timestamp", "gasPrice", "minedInBlock", "value" ] }, "ListConfirmedTransactionsByAddressEVMRIBS": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressEVMRIBST" } ] }, "ListConfirmedTransactionsByAddressEVMR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "nextStartingAfter": { "type": "string", "description": "Defines the id of the next page which the next list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "sortingOrder": { "type": "string", "description": "Defines what the sorting order is either ascending or descending.", "example": "ascending" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressEVMRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListConfirmedTransactionsByAddressEVME401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListConfirmedTransactionsByAddressEVME400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListConfirmedTransactionsByAddressEVME403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "AddressCoinsTransactionUnconfirmed": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "referenceId": { "type": "string", "description": "Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.", "example": "6038d09050653d1f0e40584c" }, "idempotencyKey": { "type": "string", "description": "Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.", "example": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c" }, "data": { "type": "object", "description": "Specifies all data, as attributes, included into the callback notification, which depends on the `event`.", "properties": { "product": { "type": "string", "description": "Represents the Crypto APIs 2.0 product which sends the callback.", "example": "BLOCKCHAIN_EVENTS" }, "event": { "type": "string", "description": "Defines the specific event, for which a callback subscription is set.", "example": "ADDRESS_COINS_TRANSACTION_UNCONFIRMED" }, "item": { "type": "object", "description": "Defines an `item` as one result.", "properties": { "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, "address": { "type": "string", "description": "Defines the specific address to which the coin transaction has been sent and is pending confirmation.", "example": "3CzKAnCXt7ePb5NCp5qrAEimrxjY81oLoT" }, "transactionId": { "type": "string", "description": "Defines the unique ID of the specific transaction, i.e. its identification number.", "example": "4b2159770f75a7200ea168eb56ebbf3303b025d838f743fb6e785bc32d5ac65b" }, "amount": { "type": "string", "description": "Defines the amount of coins sent with the transaction that is pending confirmation.", "example": "0.6508984" }, "unit": { "type": "string", "description": "Defines the unit of the transaction, e.g. BTC.", "example": "BTC", "enum": [ "btc", "satoshi", "wei", "gwei", "eth", "doge", "dash", "etc", "xrp", "zil", "matic" ] }, "direction": { "type": "string", "description": "Defines whether the transaction is \"incoming\" or \"outgoing\".", "example": "incoming", "enum": [ "incoming", "outgoing" ] }, "firstSeenInMempoolTimestamp": { "type": "integer", "description": "Defines the exact time the transaction has been first accepted into the mempool to await confirmation as timestamp.", "example": 1610365615 } }, "required": [ "blockchain", "network", "address", "transactionId", "amount", "unit", "direction", "firstSeenInMempoolTimestamp" ] } }, "required": [ "product", "event", "item" ] } }, "required": [ "apiVersion", "referenceId", "idempotencyKey", "data" ] }, "AddressCoinsTransactionConfirmed": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "referenceId": { "type": "string", "description": "Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.", "example": "6038d09050653d1f0e40584c" }, "idempotencyKey": { "type": "string", "description": "Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.", "example": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c" }, "data": { "type": "object", "description": "Specifies all data, as attributes, included into the callback notification, which depends on the `event`.", "properties": { "product": { "type": "string", "description": "Represents the Crypto APIs 2.0 product which sends the callback.", "example": "BLOCKCHAIN_EVENTS" }, "event": { "type": "string", "description": "Defines the specific event, for which a callback subscription is set.", "example": "ADDRESS_COINS_TRANSACTION_CONFIRMED" }, "item": { "type": "object", "description": "Defines an `item` as one result.", "properties": { "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\", \"nile\" are test networks.", "example": "testnet" }, "address": { "type": "string", "description": "Defines the specific address to which the coin transaction has been sent and is confirmed.", "example": "bc1qmjhy4exylset37e6sfjdtfksm8kpcrxknj7cag" }, "minedInBlock": { "type": "object", "description": "Defines the block height in which this transaction was mined and confirmed in.", "properties": { "height": { "type": "integer", "description": "Defines the number of blocks in the blockchain preceding this specific block.", "example": 667861 }, "hash": { "type": "string", "description": "Represents the hash of the block's header, i.e. an output that has a fixed length.", "example": "b00d27cccd5e4f4fa1b28824d9a1e5fef88e6c37cdeb09e37eb39aa1d3d63448" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this transaction was mined in seconds since Unix Epoch time.", "example": 1610365213 } }, "required": [ "height", "hash", "timestamp" ] }, "transactionId": { "type": "string", "description": "Defines the unique ID of the specific transaction, i.e. its identification number.", "example": "b00d27cccd5e4f4fa1b28824d9a1e5fef88e6c37cdeb09e37eb39aa1d3d63448" }, "amount": { "type": "string", "description": "Defines the amount of coins sent with the confirmed transaction.", "example": "0.0315" }, "unit": { "type": "string", "description": "Defines the unit of the transaction, e.g. BTC.", "example": "BTC" }, "direction": { "type": "string", "description": "Defines whether the transaction is \"incoming\" or \"outgoing\".", "example": "incoming", "enum": [ "incoming", "outgoing" ] } }, "required": [ "blockchain", "network", "address", "minedInBlock", "transactionId", "amount", "unit", "direction" ] } }, "required": [ "product", "event", "item" ] } }, "required": [ "apiVersion", "referenceId", "idempotencyKey", "data" ] }, "KaspaAddressCoinsTransactionConfirmed": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "referenceId": { "type": "string", "description": "Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.", "example": "6038d09050653d1f0e40584c" }, "idempotencyKey": { "type": "string", "description": "Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.", "example": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c" }, "data": { "type": "object", "description": "Specifies all data, as attributes, included into the callback notification, which depends on the `event`.", "properties": { "product": { "type": "string", "description": "Represents the Crypto APIs 2.0 product which sends the callback.", "example": "BLOCKCHAIN_EVENTS" }, "event": { "type": "string", "description": "Defines the specific event, for which a callback subscription is set.", "example": "KASPA_ADDRESS_COINS_TRANSACTION_CONFIRMED" }, "item": { "type": "object", "description": "Defines an `item` as one result for Kaspa transaction.", "properties": { "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Kaspa", "example": "kaspa" }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\".", "example": "mainnet" }, "address": { "type": "string", "description": "Defines the specific address to which the coin transaction has been sent and is confirmed.", "example": "kaspa:qrk9decfnl4rayeegp6gd3tc6605zavclkpud5jp78axat5namppwt050d57j" }, "minedInBlock": { "type": "object", "description": "Defines the block height in which this transaction was mined and confirmed in.", "properties": { "hash": { "type": "string", "description": "Represents the hash of the block's header, i.e. an output that has a fixed length.", "example": "ce8fe302c8f46e6275e89b57f9195ea2742f9db0080a2d3deff5c02475c77262" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this transaction was mined in seconds since Unix Epoch time.", "example": 1610365213 } }, "required": [ "hash", "timestamp" ] }, "transactionId": { "type": "string", "description": "Defines the unique ID of the specific transaction, i.e. its identification number.", "example": "9ebfd1bd4177b01a3a1996461499055c2fd3a0291ebb5977abe8346e0aa4d0eb" }, "amount": { "type": "string", "description": "Defines the amount of coins sent with the confirmed transaction.", "example": "16.5" }, "unit": { "type": "string", "description": "Defines the unit of the transaction, e.g. KAS.", "example": "KAS" }, "direction": { "type": "string", "description": "Defines whether the transaction is \"incoming\" or \"outgoing\".", "example": "incoming", "enum": [ "incoming", "outgoing" ] } }, "required": [ "blockchain", "network", "address", "minedInBlock", "transactionId", "amount", "unit", "direction" ] } }, "required": [ "product", "event", "item" ] } }, "required": [ "apiVersion", "referenceId", "idempotencyKey", "data" ] }, "AddressTokensTransactionConfirmedErc-20": { "type": "object", "description": "ERC-20", "properties": { "name": { "type": "string", "description": "Specifies the name of the token.", "example": "Tether USD" }, "symbol": { "type": "string", "description": "Specifies an identifier of the token, where up to five alphanumeric characters can be used for it.", "example": "USDT" }, "decimals": { "type": "string", "description": "Defines how many decimals can be used to break the token.", "example": "6" }, "amount": { "type": "string", "description": "Defines the amount of tokens sent with the confirmed transaction.", "example": "0.00039" }, "contractAddress": { "type": "string", "description": "Defines the address of the contract.", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" } }, "required": [ "name", "symbol", "amount", "contractAddress" ] }, "AddressTokensTransactionConfirmedErc-721": { "type": "object", "description": "ERC-721", "properties": { "name": { "type": "string", "description": "Specifies the name of the token.", "example": "Wonky Stonks" }, "symbol": { "type": "string", "description": "Specifies an identifier of the token, where up to five alphanumeric characters can be used for it.", "example": "WSTK" }, "tokenId": { "type": "string", "description": "Specifies the ID of the token.", "example": "000000000000000000000000dac17f958d2ee523a2206206994597c13d831ec7" }, "contractAddress": { "type": "string", "description": "Specifies the address of the contract.", "example": "0x518ba36f1ca6dfe3bb1b098b8dd0444030e79d9f" } }, "required": [ "name", "symbol", "tokenId", "contractAddress" ] }, "AddressTokensTransactionConfirmedOmni": { "type": "object", "description": "OMNI", "properties": { "name": { "type": "string", "description": "Specifies the name of the token.", "example": "Tether-USDT" }, "propertyId": { "type": "string", "description": "Defines the ID of the property for Omni Layer.", "example": "31" }, "transactionType": { "type": "string", "description": "Defines the type of the transaction.", "example": "Simple Send, DEx Purchase etc." }, "createdByTransactionId": { "type": "string", "description": "The transaction ID used to create the token.", "example": "be5be71feac9e7019fbcdea5a87098a7862a0ee8c60bd5809b4d3b0cda940ddc" }, "amount": { "type": "string", "description": "Defines the amount of tokens sent with the confirmed transaction.", "example": "110.531723" } }, "required": [ "name", "propertyId", "transactionType", "createdByTransactionId", "amount" ] }, "AddressTokensTransactionConfirmedBep-20": { "type": "object", "description": "BEP-20", "properties": { "name": { "type": "string", "description": "Specifies the name of the token.", "example": "BEP-20" }, "symbol": { "type": "string", "description": "Specifies an identifier of the token, where up to five alphanumeric characters can be used for it.", "example": "BEST" }, "decimals": { "type": "string", "description": "Defines how many decimals can be used to break the token.", "example": "8" }, "amount": { "type": "string", "description": "Defines the amount of tokens sent with the confirmed transaction.", "example": "0.00039" }, "contractAddress": { "type": "string", "description": "Defines the address of the contract.", "example": "0xc4a9f4217748390f597e79050de41a39293345d2" } }, "required": [ "name", "symbol", "amount", "contractAddress" ] }, "AddressTokensTransactionConfirmedTrc-20": { "type": "object", "description": "TRC-20", "properties": { "name": { "type": "string" }, "symbol": { "type": "string" }, "decimals": { "type": "string" }, "amount": { "type": "string" }, "contractAddress": { "type": "string" } }, "required": [ "name", "symbol", "amount", "contractAddress" ] }, "AddressTokensTransactionConfirmedTrc-721": { "type": "object", "description": "TRC-721", "properties": { "name": { "type": "string" }, "symbol": { "type": "string" }, "tokenId": { "type": "string" }, "contractAddress": { "type": "string" } }, "required": [ "name", "symbol", "tokenId", "contractAddress" ] }, "AddressTokensTransactionConfirmedToken": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedErc-20" }, { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedErc-721" }, { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedOmni" }, { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedBep-20" }, { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedTrc-20" }, { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedTrc-721" } ] }, "AddressTokensTransactionConfirmed": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "referenceId": { "type": "string", "description": "Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.", "example": "6038d09050653d1f0e40584c" }, "idempotencyKey": { "type": "string", "description": "Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.", "example": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c" }, "data": { "type": "object", "description": "Specifies all data, as attributes, included into the callback notification, which depends on the `event`.", "properties": { "product": { "type": "string", "description": "Represents the Crypto APIs 2.0 product which sends the callback.", "example": "BLOCKCHAIN_EVENTS" }, "event": { "type": "string", "description": "Defines the specific event, for which a callback subscription is set.", "example": "ADDRESS_TOKENS_TRANSACTION_CONFIRMED" }, "item": { "type": "object", "description": "Defines an `item` as one result.", "properties": { "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "goerli" }, "address": { "type": "string", "description": "Defines the specific address to which the transaction has been sent.", "example": "0x7495fede000c8a3b77eeae09cf70fa94cd2d53f5" }, "minedInBlock": { "type": "object", "description": "Refers to the specific block the transaction was mined in.", "properties": { "height": { "type": "integer", "description": "Defines the number of blocks in the blockchain preceding this specific block.", "example": 657915 }, "hash": { "type": "string", "description": "Represents the hash of the block's header, i.e. an output that has a fixed length.", "example": "269b0de44db95beddb6aecc520b375ba8f91f3dc5558a24aa4c26979eb00c7e2" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this transaction was mined in seconds since Unix Epoch time.", "example": 1586365500 } }, "required": [ "height", "hash", "timestamp" ] }, "transactionId": { "type": "string", "description": "Defines the unique ID of the specific transaction, i.e. its identification number.", "example": "0xbe38781783b1b9d480219255ff98e20335a39e13979a66112efa33f05fde0a33" }, "tokenType": { "type": "string", "description": "Defines the type of token sent with the transaction, e.g. ERC 20.", "example": "ERC-20", "enum": [ "ERC-20", "ERC-721", "OMNI", "BEP-20", "TRC-20", "TRC-721" ] }, "token": { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedToken" }, "direction": { "type": "string", "description": "Defines whether the transaction is \"incoming\" or \"outgoing\".", "example": "incoming", "enum": [ "incoming", "outgoing" ] } }, "required": [ "blockchain", "network", "address", "minedInBlock", "transactionId", "tokenType", "token", "direction" ] } }, "required": [ "product", "event", "item" ] } }, "required": [ "apiVersion", "referenceId", "idempotencyKey", "data" ] }, "AddressTokensTransactionConfirmedEachConfirmationErc-20": { "type": "object", "description": "ERC-20", "properties": { "name": { "type": "string", "description": "Specifies the name of the token.", "example": "Tether USD" }, "symbol": { "type": "string", "description": "Specifies an identifier of the token, where up to five alphanumeric characters can be used for it.", "example": "USDT" }, "decimals": { "type": "string", "description": "Defines how many decimals can be used to break the token.", "example": "6" }, "amount": { "type": "string", "description": "Defines the amount of tokens sent with the confirmed transaction.", "example": "11.9" }, "contractAddress": { "type": "string", "description": "Defines the address of the contract.", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" } }, "required": [ "name", "symbol", "amount", "contractAddress" ] }, "AddressTokensTransactionConfirmedEachConfirmationErc-721": { "type": "object", "description": "ERC-721", "properties": { "name": { "type": "string", "description": "Specifies the name of the token.", "example": "Wonky Stonks" }, "symbol": { "type": "string", "description": "Specifies an identifier of the token, where up to five alphanumeric characters can be used for it.", "example": "WSTK" }, "tokenId": { "type": "string", "description": "Specifies the ID of the token.", "example": "5027" }, "contractAddress": { "type": "string", "description": "Specifies the address of the contract.", "example": "0x518ba36f1ca6dfe3bb1b098b8dd0444030e79d9f" } }, "required": [ "name", "symbol", "tokenId", "contractAddress" ] }, "AddressTokensTransactionConfirmedEachConfirmationOmni": { "type": "object", "description": "OMNI", "properties": { "name": { "type": "string", "description": "Specifies the name of the token.", "example": "TetherUSDT" }, "propertyId": { "type": "string", "description": "Defines the ID of the property for Omni Layer.", "example": "31" }, "transactionType": { "type": "string", "description": "Defines the type of the transaction.", "example": "Simple Send, DEx Purchase etc." }, "createdByTransactionId": { "type": "string", "description": "The transaction ID used to create the token.", "example": "be5be71feac9e7019fbcdea5a87098a7862a0ee8c60bd5809b4d3b0cda940ddc" }, "amount": { "type": "string", "description": "Defines the amount of tokens sent with the confirmed transaction.", "example": "190.531725" } }, "required": [ "name", "propertyId", "transactionType", "createdByTransactionId", "amount" ] }, "AddressTokensTransactionConfirmedEachConfirmationBep-20": { "type": "object", "description": "BEP-20", "properties": { "name": { "type": "string", "description": "Specifies the name of the token.", "example": "BEP-20" }, "symbol": { "type": "string", "description": "Specifies an identifier of the token, where up to five alphanumeric characters can be used for it.", "example": "BEST" }, "decimals": { "type": "string", "description": "Defines how many decimals can be used to break the token.", "example": "8" }, "amount": { "type": "string", "description": "Defines the amount of tokens sent with the confirmed transaction.", "example": "0.00039" }, "contractAddress": { "type": "string", "description": "Defines the address of the contract.", "example": "0xc4a9f4217748390f597e79050de41a39293345d2" } }, "required": [ "name", "symbol", "amount", "contractAddress" ] }, "AddressTokensTransactionConfirmedEachConfirmationTrc-20": { "type": "object", "description": "TRC-20", "properties": { "name": { "type": "string" }, "symbol": { "type": "string" }, "decimals": { "type": "string" }, "amount": { "type": "string" }, "contractAddress": { "type": "string" } }, "required": [ "name", "symbol", "amount", "contractAddress" ] }, "AddressTokensTransactionConfirmedEachConfirmationTrc-721": { "type": "object", "description": "TRC-721", "properties": { "name": { "type": "string" }, "symbol": { "type": "string" }, "tokenId": { "type": "string" }, "contractAddress": { "type": "string" } }, "required": [ "name", "symbol", "tokenId", "contractAddress" ] }, "AddressTokensTransactionConfirmedEachConfirmationToken": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedEachConfirmationErc-20" }, { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedEachConfirmationErc-721" }, { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedEachConfirmationOmni" }, { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedEachConfirmationBep-20" }, { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedEachConfirmationTrc-20" }, { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedEachConfirmationTrc-721" } ] }, "AddressTokensTransactionConfirmedEachConfirmation": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "referenceId": { "type": "string", "description": "Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.", "example": "6038d09050653d1f0e40584c" }, "idempotencyKey": { "type": "string", "description": "Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.", "example": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c" }, "data": { "type": "object", "description": "Specifies all data, as attributes, included into the callback notification, which depends on the `event`.", "properties": { "product": { "type": "string", "description": "Represents the Crypto APIs 2.0 product which sends the callback.", "example": "BLOCKCHAIN_EVENTS" }, "event": { "type": "string", "description": "Defines the specific event, for which a callback subscription is set.", "example": "ADDRESS_TOKENS_TRANSACTION_CONFIRMED_EACH_CONFIRMATION" }, "item": { "type": "object", "description": "Defines an `item` as one result.", "properties": { "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\", are test networks.", "example": "goerli" }, "address": { "type": "string", "description": "Defines the specific address to which the transaction has been sent.", "example": "0x7495fede000c8a3b77eeae09cf70fa94cd2d53f5" }, "minedInBlock": { "type": "object", "description": "Refers to the specific block the transaction was mined in.", "properties": { "height": { "type": "integer", "description": "Defines the number of blocks in the blockchain preceding this specific block.", "example": 657915 }, "hash": { "type": "string", "description": "Represents the hash of the block's header, i.e. an output that has a fixed length.", "example": "269b0de44db95beddb6aecc520b375ba8f91f3dc5558a24aa4c26979eb00c7e2" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this transaction was mined in seconds since Unix Epoch time.", "example": 1586365500 } }, "required": [ "height", "hash", "timestamp" ] }, "transactionId": { "type": "string", "description": "Defines the unique ID of the specific transaction, i.e. its identification number.", "example": "0xbe38781783b1b9d480219255ff98e20335a39e13979a66112efa33f05fde0a33" }, "currentConfirmations": { "type": "integer", "description": "Defines the number of currently received confirmations for the transaction.", "example": 2 }, "targetConfirmations": { "type": "integer", "description": "Defines the number of confirmation transactions requested as callbacks, i.e. the system can notify till the n-th confirmation.", "example": 3 }, "tokenType": { "type": "string", "description": "Defines the type of token sent with the transaction, e.g. ERC 20.", "example": "ERC-20", "enum": [ "ERC-20", "ERC-721", "OMNI", "BEP-20", "TRC-20", "TRC-721" ] }, "token": { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedEachConfirmationToken" }, "direction": { "type": "string", "description": "Defines whether the transaction is \"incoming\" or \"outgoing\".", "example": "incoming", "enum": [ "incoming", "outgoing" ] } }, "required": [ "blockchain", "network", "address", "minedInBlock", "transactionId", "currentConfirmations", "targetConfirmations", "tokenType", "token", "direction" ] } }, "required": [ "product", "event", "item" ] } }, "required": [ "apiVersion", "referenceId", "idempotencyKey", "data" ] }, "AddressCoinsTransactionConfirmedEachConfirmation": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "referenceId": { "type": "string", "description": "Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.", "example": "6038d09050653d1f0e40584c" }, "idempotencyKey": { "type": "string", "description": "Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.", "example": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c" }, "data": { "type": "object", "description": "Specifies all data, as attributes, included into the callback notification, which depends on the `event`.", "properties": { "product": { "type": "string", "description": "Represents the Crypto APIs 2.0 product which sends the callback.", "example": "BLOCKCHAIN_EVENTS" }, "event": { "type": "string", "description": "Defines the specific event, for which a callback subscription is set.", "example": "ADDRESS_COINS_TRANSACTION_CONFIRMED_EACH_CONFIRMATION" }, "item": { "type": "object", "description": "Defines an `item` as one result.", "properties": { "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\", \"nile\" are test networks.", "example": "testnet" }, "address": { "type": "string", "description": "Defines the specific address to which the transaction has been sent.", "example": "15282N4BYEwYh3j1dTgJu64Ey5qWn9Po9F" }, "minedInBlock": { "type": "object", "description": "Refers to the specific block the transaction was mined in.", "properties": { "height": { "type": "integer", "description": "Defines the number of blocks in the blockchain preceding this specific block.", "example": 667754 }, "hash": { "type": "string", "description": "Represents the hash of the block's header, i.e. an output that has a fixed length.", "example": "dfe45f6724b550c281107ffaa5880cb280878fb4dbaa742aa21449f3d2340c13" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this transaction was mined in seconds since Unix Epoch time.", "example": 1610365314 } }, "required": [ "height", "hash", "timestamp" ] }, "transactionId": { "type": "string", "description": "Defines the unique ID of the specific transaction, i.e. its identification number.", "example": "cbd3dea703bd2bc78bca69ee61ca14e6ffcdd809d07ebbc3b8fea3c30ea38f33" }, "currentConfirmations": { "type": "integer", "description": "Defines the number of currently received confirmations for the transaction.", "example": 8 }, "targetConfirmations": { "type": "integer", "description": "Defines the number of confirmation transactions requested as callbacks, i.e. the system can notify till the n-th confirmation.", "example": 12 }, "amount": { "type": "string", "description": "Defines the amount of coins sent with the confirmed transaction.", "example": "0.0611" }, "unit": { "type": "string", "description": "Defines the unit of the transaction, e.g. BTC.", "example": "BTC" }, "direction": { "type": "string", "description": "Defines whether the transaction is \"incoming\" or \"outgoing\".", "example": "incoming", "enum": [ "incoming", "outgoing" ] } }, "required": [ "blockchain", "network", "address", "minedInBlock", "transactionId", "currentConfirmations", "targetConfirmations", "amount", "unit", "direction" ] } }, "required": [ "product", "event", "item" ] } }, "required": [ "apiVersion", "referenceId", "idempotencyKey", "data" ] }, "BlockMined": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "referenceId": { "type": "string", "description": "Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.", "example": "6038d09050653d1f0e40584c" }, "idempotencyKey": { "type": "string", "description": "Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.", "example": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c" }, "data": { "type": "object", "description": "Specifies all data, as attributes, included into the callback notification, which depends on the `event`.", "properties": { "product": { "type": "string", "description": "Represents the Crypto APIs 2.0 product which sends the callback.", "example": "BLOCKCHAIN_EVENTS" }, "event": { "type": "string", "description": "Defines the specific event, for which a callback subscription is set.", "example": "BLOCK_MINED" }, "item": { "type": "object", "description": "Defines an `item` as one result.", "properties": { "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, "height": { "type": "integer", "description": "Defines the number of blocks in the blockchain preceding this specific block.", "example": 570008 }, "hash": { "type": "string", "description": "Represents the hash of the block's header, i.e. an output that has a fixed length.", "example": "00000000000000000006ddb5e854505f8b792122b0ac9469c07eb26db414f6fb" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this block was mined in seconds since Unix Epoch time.", "example": 1610365615 } }, "required": [ "blockchain", "network", "height", "hash", "timestamp" ] } }, "required": [ "product", "event", "item" ] } }, "required": [ "apiVersion", "referenceId", "idempotencyKey", "data" ] }, "AddressInternalTransactionConfirmed": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "referenceId": { "type": "string", "description": "Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.", "example": "6038d09050653d1f0e40584c" }, "idempotencyKey": { "type": "string", "description": "Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.", "example": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c" }, "data": { "type": "object", "description": "Specifies all data, as attributes, included into the callback notification, which depends on the `event`.", "properties": { "product": { "type": "string", "description": "Represents the Crypto APIs 2.0 product which sends the callback.", "example": "BLOCKCHAIN_EVENTS" }, "event": { "type": "string", "description": "Defines the specific event, for which a callback subscription is set.", "example": "ADDRESS_INTERNAL_TRANSACTION_CONFIRMED" }, "item": { "type": "object", "description": "Defines an `item` as one result.", "properties": { "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "mainnet" }, "address": { "type": "string", "description": "Defines the specific address of the internal transaction.", "example": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2" }, "minedInBlock": { "type": "object", "description": "Refers to the specific block the transaction was mined in.", "properties": { "height": { "type": "integer", "description": "Defines the number of blocks in the blockchain preceding this specific block.", "example": 12567093 }, "hash": { "type": "string", "description": "Represents the hash of the block's header, i.e. an output that has a fixed length.", "example": "0xa787415dc7c7025a43b87542a57872d1127f30f95daa87097cf5f26ef79d6950" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this transaction was mined in seconds since Unix Epoch time.", "example": 1622797821 } }, "required": [ "height", "hash", "timestamp" ] }, "parentTransactionId": { "type": "string", "description": "Defines the Parent Transaction's unique ID.", "example": "0xc3be8371b32fa2238c44271643446b14c87ff11b77d58f9a1bceb1d1253e79b2" }, "operationId": { "type": "string", "description": "Defines the specific operation's unique ID.", "example": "call_5_0" }, "amount": { "type": "string", "description": "Defines the amount of coins sent with the confirmed transaction.", "example": "0.94891479938916527" }, "unit": { "type": "string", "description": "Defines the unit of the transaction, e.g. Gwei.", "example": "ETH" }, "direction": { "type": "string", "description": "Defines whether the transaction is \"incoming\" or \"outgoing\".", "example": "outgoing", "enum": [ "incoming", "outgoing" ] } }, "required": [ "blockchain", "network", "address", "minedInBlock", "parentTransactionId", "operationId", "amount", "unit", "direction" ] } }, "required": [ "product", "event", "item" ] } }, "required": [ "apiVersion", "referenceId", "idempotencyKey", "data" ] }, "AddressInternalTransactionConfirmedEachConfirmation": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "referenceId": { "type": "string", "description": "Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.", "example": "6038d09050653d1f0e40584c" }, "idempotencyKey": { "type": "string", "description": "Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.", "example": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c" }, "data": { "type": "object", "description": "Specifies all data, as attributes, included into the callback notification, which depends on the `event`.", "properties": { "product": { "type": "string", "description": "Represents the Crypto APIs 2.0 product which sends the callback.", "example": "BLOCKCHAIN_EVENTS" }, "event": { "type": "string", "description": "Defines the specific event, for which a callback subscription is set.", "example": "ADDRESS_INTERNAL_TRANSACTION_CONFIRMED_EACH_CONFIRMATION" }, "item": { "type": "object", "description": "Defines an `item` as one result.", "properties": { "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "mainnet" }, "address": { "type": "string", "description": "Defines the specific address of the internal transaction.", "example": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2" }, "minedInBlock": { "type": "object", "description": "Refers to the specific block the transaction was mined in.", "properties": { "height": { "type": "integer", "description": "Defines the number of blocks in the blockchain preceding this specific block.", "example": 12566992 }, "hash": { "type": "string", "description": "Represents the hash of the block's header, i.e. an output that has a fixed length.", "example": "0x936a34ef544e6fc9fc5f68fb086b9e8ea0e5eca52cb45cb67b27d174bccc35a5" }, "timestamp": { "type": "integer", "description": "Defines the exact date/time when this transaction was mined in seconds since Unix Epoch time.", "example": 1622796751 } }, "required": [ "height", "hash", "timestamp" ] }, "parentTransactionId": { "type": "string", "description": "Defines the Parent Transaction's unique ID.", "example": "0x5fc77216fdfb8c966387030be7bda4bacce0232f7115722ef5b228a223974784" }, "operationId": { "type": "string", "description": "Defines the specific operation's unique ID.", "example": "call_1_0_1_0_3_0" }, "currentConfirmations": { "type": "integer", "description": "Defines the number of currently received confirmations for the transaction.", "example": 2 }, "targetConfirmations": { "type": "integer", "description": "Defines the number of confirmation transactions requested as callbacks, i.e. the system can notify till the n-th confirmation.", "example": 3 }, "amount": { "type": "string", "description": "Defines the amount of coins sent with the confirmed transaction.", "example": "0.05710541741945074" }, "unit": { "type": "string", "description": "Defines the unit of the transaction, e.g. Gwei.", "example": "ETH" }, "direction": { "type": "string", "description": "Defines whether the transaction is \"incoming\" or \"outgoing\".", "example": "outgoing", "enum": [ "incoming", "outgoing" ] } }, "required": [ "blockchain", "network", "address", "minedInBlock", "parentTransactionId", "operationId", "currentConfirmations", "targetConfirmations", "amount", "unit", "direction" ] } }, "required": [ "product", "event", "item" ] } }, "required": [ "apiVersion", "referenceId", "idempotencyKey", "data" ] }, "AddressSyncStatus": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "referenceId": { "type": "string", "description": "Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.", "example": "6038d09050653d1f0e40584c" }, "idempotencyKey": { "type": "string", "description": "Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.", "example": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c" }, "data": { "type": "object", "description": "Specifies all data, as attributes, included into the callback notification, which depends on the `event`.", "properties": { "product": { "type": "string", "description": "Represents the Crypto APIs 2.0 product which sends the callback.", "example": "ADDRESS_HISTORY" }, "event": { "type": "string", "description": "Defines the specific event, for which a callback subscription is set.", "example": "ADDRESS_SYNC_STATUS" }, "item": { "type": "object", "description": "Defines an `item` as one result.", "properties": { "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"goerli\", \"mumbai\" are test networks.", "example": "sepolia" }, "address": { "type": "string", "description": "Represents the address that is syncing", "example": "0x3d0b25fe09e2cd92f06ba776391a122519936e90" }, "status": { "type": "string", "description": "Defines the sync status - \"syncing\" for process in proggress and \"synced\" for finished proccess.", "example": "synced", "enum": [ "syncing", "synced" ] } }, "required": [ "blockchain", "network", "address", "status" ] } }, "required": [ "product", "event", "item" ] } }, "required": [ "apiVersion", "referenceId", "idempotencyKey", "data" ] }, "BroadcastTransactionSuccess": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "referenceId": { "type": "string", "description": "Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.", "example": "6038d09050653d1f0e40584c" }, "idempotencyKey": { "type": "string", "description": "Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.", "example": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c" }, "data": { "type": "object", "description": "Specifies all data, as attributes, included into the callback notification, which depends on the `event`.", "properties": { "product": { "type": "string", "description": "Represents the Crypto APIs 2.0 product which sends the callback.", "example": "BROADCAST_TRANSACTIONS" }, "event": { "type": "string", "description": "Defines the specific event, for which a callback subscription is set.", "example": "BROADCAST_TRANSACTION_SUCCESS" }, "item": { "type": "object", "description": "Defines an `item` as one result.", "properties": { "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "Bitcoin/Ethereum (whichever applicable)" }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "Testnet/Mainnet (whichever applicable)" }, "transactionId": { "type": "string", "description": "Defines the unique ID of the specific transaction, i.e. its identification number.", "example": "347d96855d41b77f1e23048fff11c18e9fe699ee69b0b402338f34189734e0a2" } }, "required": [ "blockchain", "network", "transactionId" ] } }, "required": [ "product", "event", "item" ] } }, "required": [ "apiVersion", "referenceId", "idempotencyKey", "data" ] }, "BroadcastTransactionFail": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "referenceId": { "type": "string", "description": "Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.", "example": "6038d09050653d1f0e40584c" }, "idempotencyKey": { "type": "string", "description": "Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.", "example": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c" }, "data": { "type": "object", "description": "Specifies all data, as attributes, included into the callback notification, which depends on the `event`.", "properties": { "product": { "type": "string", "description": "Represents the Crypto APIs 2.0 product which sends the callback.", "example": "BROADCAST_TRANSACTIONS" }, "event": { "type": "string", "description": "Defines the specific event, for which a callback subscription is set.", "example": "BROADCAST_TRANSACTION_FAIL" }, "item": { "type": "object", "description": "Defines an `item` as one result.", "properties": { "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "Bitcoin/Ethereum (whichever applicable)" }, "network": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\", \"rinkeby\" are test networks.", "example": "Testnet/Mainnet (whichever applicable)" }, "transactionId": { "type": "string", "description": "Defines the unique ID of the specific transaction, i.e. its identification number.", "example": "d83c75dd0f73425a1a85023ba25bc7ff47333c823a0ea19fac28d4abe59fd612" }, "errorMessage": { "type": "string", "description": "Represents the error message received for the transaction.", "example": "Transaction already in block chain" } }, "required": [ "blockchain", "network", "transactionId", "errorMessage" ] } }, "required": [ "product", "event", "item" ] } }, "required": [ "apiVersion", "referenceId", "idempotencyKey", "data" ] } } }, "security": [ { "ApiKey": [] } ], "info": { "title": "CryptoAPIs", "version": "2024-12-12", "versionId": "6707d1a92c703bd75268a9d9", "id": "6707d1aa2feff07686e31030", "description": "Crypto APIs is a complex and innovative infrastructure layer that radically simplifies the development of any Blockchain and Crypto related applications. Organized around REST, Crypto APIs can assist both novice Bitcoin/Ethereum enthusiasts and crypto experts with the development of their blockchain applications. Crypto APIs provides unified endpoints and data, raw data, automatic tokens and coins forwardings, callback functionalities, and much more.", "termsOfService": "https://cryptoapis.io/terms-conditions/", "contact": { "name": "Crypto APIs Team", "url": "https://cryptoapis.io", "email": "developers@cryptoapis.io" }, "license": { "name": "MIT", "url": "http://www.opensource.org/licenses/mit-license.php" } }, "tags": [ { "name": "Overview‌", "description": "## Introduction\r\nWelcome to the Crypto APIs Technical Documentation. Below is a detailed breakdown of our core products, each designed to address specific blockchain development needs. \r\n\r\n### Address Latest\r\n Retrieve real-time address activity from the past 14 days.\r\n \r\n* Data: Balances, transactions, token holdings.\r\n* Supported Chains: Ethereum, Bitcoin, Polygon, and 10+ others.\r\n* Features: Updates with 1-block confirmation.\r\n\r\nUse Cases: Wallet dashboards, compliance checks.\r\n\r\n### Address History\r\nAccess full historical data from Genesis block onward.\r\n* Data: Balances, transactions, token transfers (NFTs/ERC-20), smart contract interactions.\r\n\r\nUse Cases: Audits, tax reporting, forensic analysis.\r\n\r\n### Block Data\r\nFetch detailed metadata and transactions for any block.\r\n\r\n* Includes: Timestamp, hash, miner details, gas usage, uncle blocks.\r\n\r\nUse Cases: Block explorers, network analytics.\r\n\r\n### Transactions Data\r\nTrace transaction-level details across chains.\r\n\r\n* Data: Inputs/outputs, participants, gas fees, status, internal transactions, cross-chain swaps.\r\n\r\nUse Cases: Transaction debuggers, DeFi analytics.\r\n\r\n### Simulate Transactions\r\nPurpose: Test EVM transactions in a risk-free environment.\r\n* Blockchain Transaction Simulator:\r\n* Simulate transactions on Ethereum, Polygon, and BNB Chain.\r\n* Predict outcomes, optimize gas costs, and test bundled transactions.\r\n\r\nUse Cases: DeFi strategy testing, Contract vulnerability checks, Gas fee benchmarking.\r\n\r\n### Blockchain Utils\r\nSimplify cryptographic operations and address management.\r\n\r\nTools: Address validation, X-Address encode/decode.\r\n\r\nUse Cases: Wallet integrations, data formatting.\r\n\r\n### Broadcast Transactions\r\nSubmit signed transactions to miners and monitor status.\r\nFeatures: Real-time tracking, retry failed broadcasts.\r\nUse Cases: Transaction automation, wallet services.\r\n\r\n### HD Wallets Management\r\nSync and manage hierarchical deterministic wallets programmatically.\r\n\r\nFeatures: Track addresses, balances, and histories across 15+ chains.\r\n\r\nUse Cases: Custodial wallets, portfolio trackers.\r\n\r\n### Contracts Data\r\n\r\nPurpose: Retrieve comprehensive metadata for smart contracts to enhance blockchain applications with accurate token information.\r\n\r\nFeatures:\r\n* Detailed Metadata: Access information such as token symbols, names, decimals, and total supply.\r\n* High Performance: Achieve data retrieval with response times as low as 25 milliseconds.\r\n* Extensive Support: Compatible with multiple blockchain networks, including Ethereum, Solana, and more.\r\n\r\nUse Cases: Token management platforms, decentralized applications (dApps), and blockchain analytics tools.\r\n\r\n### Blockchain Fees\r\nEstimate transaction costs dynamically.\r\n\r\nSupported Chains: ETH, BTC, L2 networks.\r\n\r\nFeatures: Congestion-based fee recommendations.\r\n\r\nUse Cases: Gas optimization, DeFi strategies.\r\n\r\n### Blockchain Events\r\nPurpose: Receive instant webhook alerts for on-chain activity.\r\nTriggers: New blocks, mined/unconfirmed transactions, custom confirmations.\r\nFeatures: <100 ms delivery, no node maintenance.\r\nUse Cases: Real-time monitoring, fraud detection.\r\n\r\n### Market Data\r\nPurpose: Access real-time crypto/fiat exchange rates.\r\nPairs: USD, BTC, ETH, and others.\r\nUse Cases: Trading bots, price feeds.\r\n\r\nCrypto APIs offers different pricing plans to fit your specific needs. To see Crypto APIs' available subscription plans, please visit our [dedicated website page]( https://cryptoapis.io/pricing).\r\n\r\n{warning}This documentation and all API References apply **only** to Crypto APIs.{/warning}" }, { "name": "Getting Started", "description": "## Create an account\r\nTo get started with Crypto APIs services the first thing you need to do is create your account at https://app.cryptoapis.io/login. By creating an account you get access to a personalized Crypto APIs Dashboard, where you can monitor and control your API keys, requests, credits, tokens, exchange accounts, and more. \r\n\r\nYou can create your Crypto APIs account manually by adding information to the required fields, or simply use the Social Login provided for Google, GitHub and LinkedIn.\r\n\r\n{note}Please use a valid email address you have access to, in order to be able to receive messages from Crypto APIs needed for user authentication, registration completion and API use.{/note}\r\n\r\n{note}Users can also invite Team members by adding their email addresses. Email addresses that already exist as users type \"Owner\" cannot be invited as Team members.{/note}\r\n\r\n\r\n## The Dashboard\r\nOnce you create an account, you get access to a personalized Crypto APIs [Dashboard](https://app.cryptoapis.io/). Through the dashboard is where you can choose and subscribe to a Crypto APIs blockchain product - Blockchain Data, Blockchain Events, Blockchain Tools, Blockchain Automations, or Crypto Market Data APIs.\r\n\r\nFrom the Dashboard you can:\r\n\r\n- create and manage API keys - for authorization of the API; \r\n- create and manage callback URLs - set URLs for response;\r\n- monitor successful and failed requests, credits, callbacks; \r\n- manage webhooks and tokens;\r\n\r\nThe Crypto APIs Technical and Best use Documentation is public and available to everyone. Still, support levels for a Crypto APIs product vary depending on your subscription.\r\n\r\n## Authenticate requests\r\n\r\nTo use and make calls to any Crypto APIs product, you must create an API key, in order for your requests to be authenticated.\r\n\r\nAn API key is a code unique to the user who generated it. It is used to identify the call to the specific API and track the access to it and its usage. You can generate your API key from within the Crypto APIs [dashboard](https://app.cryptoapis.io) by clicking on the “Create new API key” button. You can generate more than one API key and use a single API key more than once.\r\n\r\n## Pagination in API request\r\n\r\nThe API response uses pagination to break down large result sets into smaller, manageable chunks. Pagination helps optimize performance by limiting the data returned per API request.\r\n\r\nThe following pagination parameters are provided in the API response\r\n\r\nParameter\tType\tDescription:\r\n\r\n* limit\tInteger\tSpecifies the maximum number of records returned per page/request.\r\n* startingAfter\tString (ID)\tIndicates the record after which the current set of results starts. Used for fetching subsequent pages.\r\n* hasMore\tBoolean\tIf true, additional records exist beyond the current set. If false, you've reached the last page.\r\n* nextStartingAfter\tString (ID)\tRepresents the ID to use as the startingAfter parameter in your next request to fetch the subsequent page of results.\r\n* sortingOrder\tString\tIndicates the sorting order of records returned (ascending or descending).\r\nHow to use pagination effectively:\r\n\r\nPerform your initial API request with the desired limit.\r\nIf hasMore is true, use the value from nextStartingAfter as the startingAfter parameter in your next request.\r\nContinue this process until hasMore returns false, indicating all records have been fetched.\r\n\r\nExample Workflow:\r\n\r\n`Request 1`\r\n\r\n`GET /endpoint?limit=10``\r\n\r\nResponse includes:\r\n\r\n```\r\n{\r\n \"limit\": 10,\r\n \"startingAfter\": \"5ca21f92cf5431000105d1a7\",\r\n \"hasMore\": true,\r\n \"nextStartingAfter\": \"5ca21f92cf5431000105d1a7\",\r\n \"sortingOrder\": \"ascending\"\r\n}\r\n```\r\n\r\nRequest 2 (using pagination):\r\n\r\n GET /endpoint?limit=50&startingAfter=5ca21f92cf5431000105d1a7\r\n\r\nRepeat until hasMore is false." }, { "name": "Authentication", "description": "## Create API key\r\n\r\nAPI keys are required as an authentication method with Crypto APIs products. By using an API key you authenticate access to the specific API. Without authentication access to the API is denied. \r\n\r\nYou can generate and manage API keys from within the Crypto APIs Dashboard. By clicking on “Create new API key” you can enter a name and the system will generate a unique for your user key for API authentication. Multiple keys can be generated. Old API keys, that you no longer want to use, can be disabled from the same location.\r\n\r\n## Use API key\r\n\r\nAPI keys are required for the authentication of the calling program to the API. All Crypto APIs keys use the same base URL \"https://rest.cryptoapis.io\". They can be used in test environments such as: Development, QA, and main Production environments.\r\n\r\nWe do not recommend using the same API key for more than one environment. We do recommend to use a single key for one specific environment - Testing, Production, etc. The API key is sensitive private information that we strongly advise to have and keep restricted access to it.\r\n\r\nContent-Type: application/json\r\nX-API-Key: my-api-key\r\n\r\n{warning}It's important to secure your API Key against public access. The custom header option is strongly recommended for a production environment.{/warning}" }, { "name": "What we support", "description": "## Supported Protocols and Networks\r\n\r\n| Blockchain protocol | Network |\r\n| :---: | :---: |\r\n| Bitcoin | Mainnet, Testnet |\r\n| Ethereum | Mainnet, Sepolia |\r\n| Tron | Mainnet, Nile |\r\n| XRP | Mainnet, Testnet |\r\n| Litecoin | Mainnet, Testnet |\r\n| Bitcoin Cash | Mainnet, Testnet |\r\n| Dash | Mainnet, Testnet |\r\n| Doge | Mainnet, Testnet |\r\n| Ethereum Classic | Mainnet, Mordor |\r\n| BNB Smart Chain | Mainnet, Testnet |\r\n| Polygon | Mainnet, Amoy |\r\n| Arbitrum | Mainnet, Sepolia |\r\n| Optimism | Mainnet, Sepolia |\r\n| Base | Mainnet, Sepolia |\r\n| Avalanche | Mainnet, Sepolia |\r\n| Solana | Mainnet, Devnet |\r\n\r\n\r\n## Supported Protocols in Crypto APIs products\r\n\r\n| Product | Supported blockchains |\r\n| :---: | :---: |\r\n| NaaS (Node as a Service) | Bitcoin, Litecoin, Dogecoin, Bitcoin Cash, Ethereum, Ethereum Classic, Binance Smart Chain, Zcash, XRP, Dash, Polygon, Arbitrum, Optimism, Solana, Fantom, Tron, Near, Filecoin, SUI, Avalanche, Base, Cronos, Aurora, Gnosis, Harmony, Starknet, Scroll, Berachain, Blast |\r\n| Address Latest | UTXO- based, EVM-based, Solana, XRP |\r\n| Address History | UTXO- based, EVM-based |\r\n| Block Data | UTXO- based, EVM-based, XRP |\r\n| Contracts Data | EVM-based, Solana |\r\n| Blockchain Utils | UTXO- based, EVM-based, XRP |\r\n| Broadcast Transactions | UTXO- based, EVM-based, XRP |\r\n| HD (Hierarchical Deterministic) wallets management | UTXO- based, EVM-based, XRP |\r\n| Blockchain Fees | UTXO- based, EVM-based |\r\n| Prepare Transactions | EVM-based |\r\n| Transactions Data | UTXO- based, EVM-based, XRP |\r\n| Blockchain Events | UTXO- based, EVM-based, Solana, XRP |\r\n| Market Data | UTXO- based, EVM-based, Solana, XRP |\r\n\r\n## Blockchain Units and Denominations\r\n \r\nEach blockchain protocol has its own native decimal base denomination. The following is a reference for how to convert Bitcoin- and Ethereum-based units.\r\n\r\nBitcoin has 8 decimal places and the smallest unit is called a \"Satoshi\", in honor of the blockchain’s creator, who is known as only Satoshi Nakamoto. 1 Satoshi is equal to 0.00000001 Bitcoin.\r\n\r\nEthereum, on the other hand, has 18 decimal places with the smallest unit called a “wei”. 1 Wei is 0.000000000000000001 of the Ether.\r\n\r\n### Bitcoin Denominations\r\n\r\n| Unit | Denomination |\r\n| :---: | :---: |\r\n| 1 Bitcoin | = 100 000 000 Satoshi |\r\n| 1 Satoshi | = 0.00000001 Bitcoin |\r\n| 1 μBTC (microbitcoin) | = 0.00000100 Bitcoin = 100 Satoshi |\r\n| mBTC (millibitcoin) | = 0.00100000 Bitcoin = 100 000 Satoshi |\r\n| cBTC (centibitcoin or bitcent) | = 0.01000000 Bitcoin = 1 000 000 Satoshi |\r\n| dBTC (decibit or decibitcoin) | = 0.10000000 Bitcoin = 10 000 000 Satoshi |\r\n| daBTC (decabit or decabitcoin) | = 10 Bitcoin = 1e9 Satoshi |\r\n\r\n### Ethereum Denominations\r\n\r\n| Unit | Denomination |\r\n| :---: | :---: |\r\n| 1 Ether | = 1e18 Wei |\r\n| 1 Wei | = 0.000000000000000001 Ether |\r\n| 1 Kwei (babbage) | = 1000 Wei = 0.000000000000001 Ether |\r\n| 1 Mwei (lovelace) | = 1 000 000 Wei = 0.000000000001 Ether |\r\n| 1 Gwei (shannon) | = 1e9 Wei = 0.000000001 Ether |\r\n| 1 Twei (szabo) | = 1e12 Wei = 0.000001 Ether |\r\n| 1 Pwei (finney) | = 1e15 Wei = 0.001 Ether |\r\n\r\n## Supported Fiat Currencies\r\n\r\nAll of the fiat currency options use the standard ISO 8601 currency codes (e.g. USD for US Dollar, EUR for Euro etc.). Unless otherwise stated, endpoints with fiat currency options support these major currency codes:\r\n\r\n| Currency Code | Currency |\r\n| :---: | :--- |\r\n| AED\t| United Arab Emirates Dirham |\r\n| ALL\t| Albanian Lek |\r\n| ARY\t| Peso |\r\n| ATS\t| Authorship |\r\n| AUD\t| Australian Dollar |\r\n| BAM\t| Convertible Mark |\r\n| BEC\t| Convertible Franc |\r\n| BGN\t| Bulgarian Lev |\r\n| BHD\t| Bahraini Dinar |\r\n| BOB\t| Boliviano |\r\n| BOP\t| Peso Boliviano |\r\n| BRC\t| Cruzado |\r\n| BRE\t| Cruzeiro |\r\n| BRL\t| Brazilian Real |\r\n| BSD\t| Bahamian Dollar |\r\n| BUK\t| Burma |\r\n| CAD\t| Canadian Dollar |\r\n| CHC\t| WIR Franc |\r\n| CHF\t| Swiss Franc |\r\n| CNX\t| Peoples Bank Dollar |\r\n| CNY\t| Yuan Renminbi |\r\n| CRC\t| Costa Rican Colon |\r\n| CYP\t| Cyprus Pound |\r\n| CZK\t| Czech Koruna |\r\n| DEM\t| Deutsche Mark |\r\n| DKK\t| Danish Krone |\r\n| ESP\t| Spanish Peseta |\r\n| ETB\t| Ethiopian Birr |\r\n| EUR\t| Euro |\r\n| GBP\t| Pound Sterling |\r\n| GHS\t| Ghana Cedi |\r\n| HKD\t| Hong Kong Dollar |\r\n| HRK\t| Croatian Kuna |\r\n| HUF\t| Forint |\r\n| IDR\t| Rupiah |\r\n| ILS\t| New Israeli Sheqel |\r\n| INR\t| Indian Rupee |\r\n| JPY\t| Yen |\r\n| KRW\t| Won |\r\n| LTT\t| Talonas |\r\n| LUC\t| Luxembourg Convertible Franc |\r\n| MAD\t| Moroccan Dirham |\r\n| MTL\t| Maltese Lira |\r\n| MUR\t| Mauritius Rupee |\r\n| MVR\t| Rufiyaa |\r\n| MXN\t| Mexican Peso |\r\n| MYR\t| Malaysian Ringgit |\r\n| NGN\t| Naira |\r\n| NIC\t| Cordoba |\r\n| NLG\t| Netherlands Guilder |\r\n| NOK\t| Norwegian Krone |\r\n| NZD\t| New Zealand Dollar |\r\n| PEN\t| Nuevo Sol |\r\n| PHP\t| Philippine Peso |\r\n| PLN\t| Zloty |\r\n| RON\t| New Romanian Leu |\r\n| RUB\t| Russian Ruble |\r\n| RUR\t| Russian Ruble |\r\n| SBD\t| Solomon Islands Dollar |\r\n| SDG\t| Sudanese Pound |\r\n| SEK\t| Swedish Krona |\r\n| SGD\t| Singapore Dollar |\r\n| SLL\t| Leone |\r\n| SUR\t| Rouble |\r\n| SVC\t| El Salvador Colon |\r\n| THB\t| Baht |\r\n| TOP\t| Top Coin |\r\n| TRY\t| Turkish Lira |\r\n| TWD\t| New Taiwan Dollar |\r\n| UAH\t| Hryvnia |\r\n| USD\t| US Dollar |\r\n| ZAR\t| Rand |\r\n| XRE\t| Revolver Coin |\r\n\r\nAnd additionally these precious metals and bonds are also supported:\r\n\r\n| Code | Unit |\r\n| :---: | :--- |\r\n| XAG\t| Silver |\r\n| XAU\t| Gold |\r\n| XBB\t| Bond Markets Monetary Unit |\r\n| XBC\t| Bond Markets Unit of Account 9 |\r\n| XPD\t| Petro Dollar |\r\n| XPT\t| Platinum |" }, { "name": "Errors and API status", "description": "## List of errors\r\n\r\nAll requests with a response status code different than 200 (successful HTTP) are considered as a failure of the particular API call and referred to as “HTTPS errors”. When the response (error) is returned an additional JSON is present in the body containing the error message. Depending on what has gone wrong with the API call, the error message is different.\r\n\r\nAs best practice we recommend to store all error messages somewhere along with request data for further manual review.\r\n\r\nThe errors we use follow the HTTP Error Codes Standard. \r\n\r\n| HTTP Status Code | Error it represents |\r\n|:---:|:---:|\r\n|3xx | Redirection Error |\r\n|4xx | Client Error |\r\n|5xx | Server Error |\r\n\r\n\r\nThe structure of the error **always** returns the following values, as listed and described in the example:\r\n\r\n\r\n_**Example:**_\r\n\r\n```\r\n{\r\n \"apiVersion\": \"\", // The current API Version.\r\n \"requestId\": \"\", // Each request has a unique ID, for which the Support team could ask for when contacted.\r\n \"context\": \"\", // Optional: In case you send this value in your request.\r\n \"error\": {\r\n \"code\": \"\", // Error Code, please check our [Errors page](https://developers.cryptoapis.io/technical-documentation/general-information/errors-and-api-statuserrors) to see the full list of error codes.\r\n \"message\": \"\", // Is the human readable error message.\r\n \"details\": \"\" // Optional: Some errors may need more details.\r\n }\r\n}\r\n```\r\n\r\nWe use the following error codes:\r\n\r\n\r\n### General errors\r\n\r\n| Type of code | HTTP Status Code | Error code | Message |\r\n| :---: | :---: | :---: | :---: |\r\n| Client Error | 400 | `uri_not_found` | \"The specified URI has not been found. Check the URI and try again.\" |\r\n| | | `limit_greater_than_allowed` | \"You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions.\" |\r\n| | | `invalid_pagination` | \"The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.\" |\r\n| | 401 | `missing_api_key` | \"The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.\" |\r\n| | | `invalid_api_key` | \"The provided API key is invalid. Please, generate a new one from your Dashboard.” |\r\n| | 402 | `insufficient_credits` | \"You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.\" |\r\n| | 403 | `https_required` | \"The use of HTTP**S** is required.\" |\r\n| | | `endpoint_not_allowed_for_plan` | \"This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.\" |\r\n| | | `data_not_allowed_for_plan` | \"Your subscription plan includes only {days} days of historical data. Please upgrade your plan or contact our team for more information.\" |\r\n| | | `banned_ip_address` | \"This IP address has been banned. To check the reason for that, please contact our team via email.\" |\r\n| | | `endpoint_not_allowed_for_api_key` | “This endpoint is not available for your API key.” |\r\n| | 404 | `resource_not_found` | \"The specified resource has not been found.\" |\r\n| | 405 | `request_method_not_supported` | \"The specified request method ({method}) is not supported for this endpoint. Please check our Documentation and make sure you set the right request method.\" |\r\n| | | `allowed_methods` | \"The specified method **must** be one of the following: {methods}.\" |\r\n| | 409 | `invalid_query_parameter` | \"The query parameter provided is invalid. Please provide a proper query parameter, or refer to the documentation for more information.\" |\r\n| | | `missing_request_body` | \"The required request body is missing, action cannot be performed.\" |\r\n| | | `bad_json` | \"The JSON provided is invalid. Please make sure it's valid and try again.\" |\r\n| | | `invalid_data` | \"The data provided seems to be invalid.\" |\r\n| | | `already_exists` | \"The specified resource already exists.\" |\r\n| | | `callback_url_not_verified` | \"The Callback URL has not been verified. Please, verify the URL from within your Dashboard and try again.\" |\r\n| | | `missing_required_attributes` | \"A required parameter is missing. Please provide all required parameters, or refer to the documentation for more information.\" |\r\n| | | `extra_body_attributes` | \"A provided body parameter is unknown or not specified. Please provide only specified body parameters, or refer to the documentation for more information.\" |\r\n| | | `extra_query_attributes` | \"A provided query parameter is unknown or not specified. Please provide only specified query parameters, or refer to the documentation for more information.\" |\r\n| | 415 | `unsupported_media_type` | \"The selected Media Type is unavailable. The Content-Type header should be 'application/json'.\" |\r\n| | 429 | `request_limit_reached` | \"The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.\" |\r\n| Server Error | 500 | `technical_issues` | \"We are currently facing some technical issues, please try again later.\" |\r\n| | | `unexpected_server_error` | \"An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.\" |\r\n| | 501 | `unimplemented` | \"This {feature} has not been implemented yet.\" |\r\n| | 503 | `temporary_shutdown_endpoint` | \"This endpoint is temporarily stopped due to performance reasons. For more information please contact our team via email.\" |\r\n\r\n\r\n### Custom errors:\r\n\r\n| Type of code | HTTP Status Code | Error code | Message |\r\n| :---: | :---: | :---: | :---: |\r\n| Client Error | 400 | `invalid_blockchain` | \"The provided blockchain is invalid. The blockchain **must** be a supported one. For the full list of supported blockchains please see our Documentation.\" |\r\n| | | `invalid_network` | \"The provided network is invalid. The network **must** be a supported one. For the full list of supported networks please see our Documentation.\" |\r\n| | | `blockchain_data_invalid_address` | \"The provided address is invalid for the mentioned blockchain/network. \" |\r\n| | | `xpub_not_synced` | \"This xPub is not yet synced, please first use the endpoint “Sync HD (xPub, yPub, zPub) wallet” to synchronize it.\" |\r\n| | | `waas_contact_group_is_missing` | \"Contact group was not found.\" |\r\n| | | `transaction_not_signed` | \"The transaction is not properly signed!\" |\r\n| | | `invalid_words_count` | \"Invalid words count! Words count MUST be one of: {validWordsCount}\" |\r\n| | 403 | `wallet_as_a_service_contacts_limit_reached` | \"You have reached the maximum Contacts count which is currently {waasConstraintsCount}. 'Please, upgrade your plan in order to have a higher Contacts count.\" |\r\n| | | `tx_lifecycle_tx_already_has_enough_rejects` | \"This transaction request already has enough rejections.\" |\r\n| | | `tx_lifecycle_user_is_not_rejecter` | \"User with ID: {teamMemberId} is not a rejecter for this transaction request.\" |\r\n| | | `tx_lifecycle_tx_already_rejected_by_this_user` | \"User with ID: {teamMemberId} has already rejected this transaction request.\" |\r\n| | | `tx_lifecycle_tx_already_has_enough_approvals` | \"This transaction request already has enough approvals.\" |\r\n| | | `tx_lifecycle_user_is_not_approver` | \"User with ID: {teamMemberId} is not an approver for this transaction request.\" |\r\n| | | `tx_lifecycle_tx_already_approved_by_this_user` | \"User with ID: {teamMemberId} has already approved this transaction request.\" |\r\n| | | `wallet_as_a_service_deposit_addresses_limit_reached` | \"You have reached the maximum Deposit Addresses count which is currently {depositAddressesCount}. Please, upgrade your plan in order to have a higher Deposit Address count.\" |\r\n| | | `wallet_as_a_service_wallets_limit_reached` | You have reached the maximum Wallets count which is currently {walletsCount}. Please, upgrade your plan in order to have a higher Wallet count. |\r\n| | | `wallet_as_a_service_wallet_recovery_data_already_backed_up` | \"Your Wallet has been already backed up and that action cannot be done again. For further assistance please contact our team.\" |\r\n| | | `blockchain_events_callbacks_limit_reached` | \"You have reached the maximum number of active Blockchain Events subscriptions which is {callbacks_limit} now. Please upgrade your plan to be get higher number of active subscriptions.\" |\r\n| | | `action_requests_user_cannot_approve_request` | \"User with ID: {userId} cannot approve this action request.\" |\r\n| | | `action_requests_request_already_approved_by_this_user` | \"User with ID: {userId} has already approved this action request.\" |\r\n| | | `action_requests_user_cannot_reject_request` | \"User with ID: {userId} cannot reject this action request.\" |\r\n| | | `coins_forwarding_automations_limit_reached` | \"Your current package plan coins forwarding automations limit of {automations_limit} reached. Please contact us if you need more or upgrade your plan.\" |\r\n| | | `tokens_forwarding_automations_limit_reached` | \"Your current package plan tokens forwarding automations limit of {automations_limit} reached. Please contact us if you need more or upgrade your plan.\" |\r\n| | 404 | `blockchain_data_address_not_found` | \"The provided address for this blockchain/network has not been found. Please check it and try again.\" |\r\n| | | `blockchain_data_block_not_found` | \"The specified block has not been found on the specific blockchain.\" |\r\n| | | ` blockchain_data_transaction_not_found` | \"The specified transaction has not been found on the specific blockchain.\" |\r\n| | | `order_book_unknown_symbol_id` | \"This symbol ID cannot be found. Please check all symbol IDs in our Market Data product.\" |\r\n| | | `tokens_forwarding_unknown_from_address` | \"From address was not found for your account.\" |\r\n| | 409 | `blockchain_prepare_transactions_insufficient_funds` | \"Insufficient funds or wrong address applied.\" |\r\n| | | `wallet_as_a_service_token_not_supported` | \"The token is not supported for this blockchain and network. To be supported, please contact our team.\" |\r\n| | | `wallet_as_a_service_no_deposit_addresses_found` | \"Please first create a deposit address for the specific blockchain and network, in order to be able to make transactions.\" |\r\n| | | `wallet_as_a_service_tokens_not_supported` | \"Tokens are not supported for the blockchain specified.\" |\r\n| | | `wallet_as_a_service_address_balance_not_enough` | \"Your address balance is insufficient to complete the action. Please, deposit funds to your address and try again.\" |\r\n| | | `wallet_as_a_service_wallet_balance_not_enough` | \"Your Wallet balance is insufficient to complete the action. Please, deposit funds to your Wallet and try again.\" |\r\n| | 422 | `sign_transaction_error` | \"Transaction could not be signed.\" |\r\n| | | `could_not_calculate_rate_for_pair` | \"Rate could not be calculated due to not enough pair trades data.\" |\r\n| | | `xpub_sync_in_progress` | \"Your wallet (xPub, yPub, zPub) is still syncing, it should take few seconds depending on how many transactions it has.\" |\r\n| | | `invalid_xpub` | \"The provided Xpub is invalid.\" |" }, { "name": "Data Flow Limiting", "description": "## Data Limiting\r\n\r\nData limiting serves three different purposes - it prevents any potential overloading events of the APIs in one way or another; it ensures the best available processing speed and response time on the performed requests; and it provides additional security to Crypto APIs products and the fetched data. Despite its name, the multi-layered functionality of data limiting significantly improves API operations and enhances user experience.\r\n\r\nData limiting varies based on the subscription tier of the Crypto APIs product you have as a customer. For detailed information on Crypto APIs products and the varying levels of data flow limitations across subscription plans, please visit [website](https://cryptoapis.io/pricing). \r\n\r\nCrypto APIs uses the following methods and strategies of limiting data flow:\r\n\r\n### Rate(Throughput) Limiting\r\n\r\n\r\nAPI rate limiting sets limits on the number of credits that can be spent within a certain period of time along with relevant actions that can be taken. This allows ensuring the stability and performance of an API system. These limits are essential for internet security intended to - prevent DDoS and brute force attacks; prevent the overload of an API; and protect its business value from decreasing. The process essentially restricts simultaneous API calls sent with your API key from a single source, as unlimited calls could compromise both the performance and security of the API in question. Additionally, API limiting aids in enhancing the API's scalability, mitigating lags during traffic spikes.\r\n\r\nFor various reasons, the professional service provided by Crypto APIs is subject to API call Rate Limits. These limits, tailored to your usage, are determined by the subscription plan tier you choose. If you wish to increase your Rate limits, feel free to reach out to our team at bizdev@cryptoapis.io to set up a custom subscription.\r\n\r\nTwo different throughput limits associated with different credit per second limits exist:\r\n\r\nThroughput Soft Limit (6,000 credits/sec) is the recommended threshold for data processing or transfer. Usage within this limit is billed at the base rate per credit.\r\nThroughput Hard Limit (12,000 credits/second) represents the maximum allowed throughput. Usage that exceeds the Throughput Soft Limit but remains within the Throughput Hard Limit will be billed at a rate slightly higher than the base rate. Exceeding the Throughput Hard Limit will result in a service interruption.\r\nCost Penalty for Exceeding the Soft Limit\r\nCost penalty is applied when the Throughput Soft Limit is exceeded but data processing and credit consumption limits remain within the Throughput Hard Limit. The cost penalty is calculated through a Cost Multiplier based on your active subscription plan.\r\n\r\nExample within Throughput Soft Limit (6,000 credits/second): If 100 credits per second are consumed, this usage falls within the 6,000 credits per second soft limit. Therefore, clients are charged the base rate for each of the 100 credits, which costs a total cost of 100 credits.\r\n\r\nExample within Throughput Hard Limit (12,000 credits/ second): In a scenario in which 8,000 credits per second are used, the usage is within Throughput Hard Limit, but it is exceeding the Throughput Soft Limit. Therefore, each of the credits consumed will be multiplied by the x2.1 cost penalty multiplier. Thus, 8,000 x 2.1 = 16,800 total credit cost. \r\n\r\n| Subscription Plan | Soft/Hard Throughput limit | Credits cost increase |\r\n| -------- | -------- | -------- |\r\n| Starter | 700/5000 | 2.1 |\r\n| Scale | 2100/15000 | 2.1 |\r\n| Pro | 6300/45000 | 2.1 |\r\n\r\nIn case you exceed the aforementioned limits, your requests will return an HTTPS Status Code 429.\r\n\r\n### Monthly credits\r\n\r\nMonthly credits is the total limit of credits included in the subscription plan which users can spend on different API calls, monitoring and operational activities. The monthly credit limit represents the credits accessible to a user. \r\n\r\nPlease be aware that you are allowed to purchase additional credits if you reach your credit limit. Monthly credit limit is not equal to the total number of credits that can be used. We have implemented this mechanism to assist you in advancing your projects and to remove any barriers that may be delaying or stopping the progress of your business - refer to \"Pay as you Go\" section for more information. \r\n \r\nThe chosen subscription tier of Crypto APIs products determines the amount of monthly credits allocated to a client, corresponding to their selected plan. Selecting higher-tier subscription plans provides clients with more credits which come at better rates. \r\n \r\nNote that one credit does not correspond with the execution of a single request. Credit charges vary for every endpoint with pricing information made available at the bottom of the page with endpoints' example response attributes. For further information on credit charges for each single endpoint, please, navigate to our [Documentation](https://developers.cryptoapis.io), open the endpoint of concern and scroll to the bottom of the page. \r\n\r\nThere are two charge types: \"Request\" and \"List\", where the latter is only for endpoints that can list multiple results and have pagination applied.\r\n\r\n1. The \"Request\" type charges a specific amount of credits per a single request. For different endpoints this could be a different amount, but most often it is 500 credits per 1 request. (The charging type can be different for the different endpoints)\r\n2. The \"List\" type charges a certain amount of credits per a specific count of results. Depending on the specific List endpoint this could vary, e.g. a more complex \"List\" endpoint could charge \"100 credits per every result in the response\".\r\n\r\n### Pay As You Go \r\n\r\nCrypto APIs employs a fair and transparent pricing model, enabling customers to pay solely for the services they use. This model is applicable across all paid subscription plans, meaning that users must be subscribed to an available paid plan of their choice prior to taking advantage of pay as you go. \r\n\r\nThe primary aim of pay-as-you-go is to eliminate any potential barriers present in subscription plans that could hinder our clients' businesses. Rather than being strictly limited to predetermined credit amounts in subscription plans, we enable clients to continue using the services they need without limitations.\r\n\r\nOnce users reach and surpass the daily credits specified in their chosen subscription plan, they will automatically continue to use Crypto APIs services as part of our pay-as-you-go schema. When exceeding the credits of their subscription plans, users will be required to cover the cost of all additional credits for executing all extra API calls that they have made. The pricing for pay-as-you-go credits is determined by the active subscription plan chosen by the customer.\r\n\r\nAs part of the pay-as-you-go model, we introduced different automatic withdrawal limits which correspond with the user's usage. These limits are triggered when specific levels (levels = additional value of services on top of the subscription plan) are reached. For example, when reaching an X amount of additional credits, the automatic withdrawal rule will be enforced for the first time and customers will be automatically charged with the corresponding payable amount. If users continue to use our services beyond that point, the next value limit will be reached afterwards which will trigger the automatic funds withdrawal mechanism for a second time. \r\n\r\nTo get information on the extra value/credit tiers and their thresholds, please contact us at **bizdev@cryptoapis.io**. \r\n\r\n\r\n### Charging structure \r\n\r\nThe pricing structure should offer clarity on how the credit-based model operates within the Crypto APIs suite. Most activities have a more simple structure and are easier to understand. However, some of the APIs work in a more specific way as each of these APIs is divided into a set of activities. Each of them incurs a specific credit cost and has a different weight in the overall pricing.\r\n\r\n#### xPub\r\n\r\nSynchronizing an xPub enables the synchronization of all historical transactions and addresses within an Hierarchical Deterministic (HD) wallet, providing access to data as needed. There are four primary activities associated with xPub synchronization, each incurring different costs:\r\n\r\n| Activity | Definition | Credits |\r\n| -------- | -------- | -------- |\r\n| xPub synchronization | Initiate synchronization through the API. | 30 |\r\n| Delete synced xPub | Remove further synchronization through the API. | 30 |\r\n\r\nAdditional fees:\r\n\r\n| Blockchain protocol | Monitoring per address
credits per day | Processing per operation (indexed transaction)
one-time credits |\r\n|---------------------|---------------------------|-------------------------|\r\n| Ethereum | 200 | 50 |\r\n| Ethereum Classic | 260 | 65 |\r\n| Binance Smart Chain | 500 | 125 |\r\n| XRP | 200 | 50 |\r\n| Bitcoin | 200 | 50 |\r\n| Bitcoin Cash | 240 | 60 |\r\n| Dash | 220 | 55 |\r\n| Dogecoin | 220 | 55 |\r\n| Litecoin | 220 | 55 |\r\n| Zcash | 260 | 65 |\r\n\r\n#### Synced address\r\n\r\nThe address synchronization API functions similarly, with nearly identical actions permitted. It enables verifying historical transaction data associated with the synchronized address. It's important to note that while you can access data from the past 14 days without synchronization, the synchronization itself is necessary for retrieving older data. The actions that are allowed through the address API are:\r\n\r\n| Activity | Definition | Credits |\r\n| -------- | -------- | -------- |\r\n| Address synchronization | Initiate synchronization through the API. | 30 |\r\n| Delete synced address | Remove further synchronization through the API. | 30 |\r\n\r\nAdditional fees:\r\n\r\n| Blockchain protocol | Monitoring per address
credits per day | Processing per operation (indexed transaction)
one-time credits |\r\n|---------------------|---------------------------|-------------------------|\r\n| Ethereum | 200 | 50 |\r\n| Ethereum Classic | 260 | 65 |\r\n| Binance Smart Chain | 500 | 125 |\r\n| Polygon | 400 | 100 |\r\n| Tron | 300 | 75 |\r\n| Bitcoin | 200 | 50 |\r\n| Bitcoin Cash | 240 | 60 |\r\n| Dash | 220 | 55 |\r\n| Dogecoin | 220 | 55 |\r\n| Litecoin | 220 | 55 |\r\n| Zcash | 260 | 65 |\r\n\r\n\r\n#### Blockchain events\r\n\r\nWhen it comes to webhook live events, clients can monitor on-chain activities for specific events such as new block creation, new transactions, token transfers, internal transactions, and beyond. The webhook live events API facilitates the execution of four key activities:\r\n\r\n| Activity | Definition | Credits |\r\n| -------- | -------- | -------- |\r\n| Create Event | Creating and subscribing to a particular event of interest for the client through the API. | 30 |\r\n| Delete Event | Remove future webhook notifications through the API. | 30 |\r\n\r\nAdditional fees:\r\n\r\n| Blockchain protocol | Monitoring per active subscription
credits per day | Processing per operation (sent callback)
one-time credits |\r\n|---------------------|--------------------------------------------------|------------------------------------------------------------------|\r\n| Ethereum | 200 | 50 |\r\n| Ethereum Classic | 260 | 50 |\r\n| Binance Smart Chain | 500 | 50 |\r\n| Polygon | 400 | 50 |\r\n| Arbitrum | 320 | 50 |\r\n| Avalanche | 360 | 50 |\r\n| Base | 240 | 50 |\r\n| Optimism | 280 | 50 |\r\n| Tron | 300 | 50 |\r\n| Solana | 600 | 50 |\r\n| XRP | 200 | 50 |\r\n| Tezos | 260 | 50 |\r\n| Bitcoin | 200 | 50 |\r\n| Bitcoin Cash | 240 | 50 |\r\n| Dash | 220 | 50 |\r\n| Dogecoin | 220 | 50 |\r\n| Litecoin | 220 | 50 |\r\n| Zcash | 260 | 50 |\r\n| Kaspa | 360 | 50 |\r\n\r\n{warning}The credit pricing is subject to change. We advise you to regularly review [pricing](https://cryptoapis.io/pricing) details to ensure accurate project budgeting and cost management.{/warning}" }, { "name": "Standards and Conventions", "description": "## Introduction\r\n\r\nThis article will present and describe principles, standards and conventions we apply to our APIs and processes. The following information may be subject to change and may as well not apply to other software.\r\n\r\nWe use OpenAPI 3 Standard for our Technical Documentation and Endpoints description. All Technical Documentation can be found in the [Developer’s Portal](https://developers.cryptoapis.io). Moreover, all Crypto APIs are REST.\r\n\r\n\r\n## URI\r\n\r\n### URI Structure\r\n\r\nThe Crypto APIs and endpoint URIs follow the RFC 3986 specification and are divided into three main parts, applicable to all Crypto APIs products (Blockchain Events, Blockchain Data, etc.):\r\n\r\n1. The domain and subdomain in the URI always display as: **rest.cryptoapis.io**\r\n2. Next is displayed the product name, where words are separated with spinal-case: **/blockchain-data/**\r\n\r\n_**Example:**_\r\n\r\nrest.cryptoapis.io/blockchain-data/..\r\n\r\nDepending on which product is specified, after that the URI’s structure may look different in each case. The different Crypto APIs products require different query parameters and variables. \r\n\r\nAfter the main URI parts, it is completed with a component and after that - parameters.\r\n\r\n_**Example:**_\r\n\r\n../address/${litecoinValidAddress}\r\n\r\n\r\n### URI Naming Standards\r\n\r\nURIs have to follow the naming standards as listed below:\r\n\r\n- the URI has to be written in all lower cases, except when a specific string requires capital letters;\r\n- the path parameter must use spinal-case ( a hyphen - ) to separate words, e.g. **/blockchain-data**;\r\n- the query parameters must use camelCase to differentiate words, e.g. **/blockchain-data/bitcoin/addresses?offset=10&limit=0**;\r\n- the variables must use camelCase to differentiate words, e.g. **/blockchain-data/bitcoin/addresses/${bitcoinValidAddress}**;\r\n- all URLs must be **HTTPS** - secured, using only HTTP is not accepted.\r\n\r\n\r\n### URI Maximum Length\r\n\r\nThe entire URI cannot exceed 2000 characters in length including any punctuation marks, e.g. commas, hyphens, question marks, pluses or forward slashes.\r\n\r\n\r\n## Request and Response Standards\r\n\r\n### Basic API Request \r\n\r\nMain prerequisites for requests to the Crypto APIs include:\r\n\r\n- requests are sent through HTTPS only to the domain **rest.cryptoapis.io**;\r\n- headers must by default incorporate the JSON content type **application/json**;\r\n- all custom for Crypto APIs attributes are indicated in the beginning with an `x-`, e.g. `x-attribute`;\r\n- request public attributes must be all camelCase, e.g. `\"apiVersion\": 2`, `\"attributeName\": \"attributeValue\"`;\r\n- we enable CORS (Cross-Origin Resource Sharing), for which the API responds with an `Access-Control-Allow-Origin:` header. **Nevertheless**, your users **shouldn’t make** direct API requests from a web application that you are building, as our CORS policy may change at some point without warning and any such requests could be then rejected;\r\n- no random unspecified keys can be added to the Crypto APIs URI, e.g. `?randomKey=randomUnspecifiedValue`, as that will result in a 400 error;\r\n- all requests to the Crypto APIs **must** be authenticated with an API key. Clients can generate API keys through their dedicated API key only after product subscription. Multiple API keys can be generated for a single user. To see more information on Authentication, please see the respective [article](https://developers.cryptoapis.io/v-1.2024-12-12-167/RESTapis/general-information/authentication);\r\n- API keys must be kept secure and private by the users who own them. API keys **must not** be uploaded to a frontend of a mobile or web application or in any open source code, as API keys represent access to the user’s account and the data inside.\r\n\r\n{tip}Best to use one API key for testing and integration purposes, and a separate one for production, known to only a limited number of people.{/tip}\r\n\r\nShortly put, all Crypto APIs requests include:\r\n\r\n```\r\nREST API Base URL: https://rest.cryptoapis.io\r\nAuthentication (API Key + JSON)\r\nRequest Type (GET, POST, PUT, PATCH, DELETE)\r\n```\r\n\r\nOur API Requests incorporate the following HTTP methods:\r\n\r\n| HTTP method | Definition |\r\n|:---:|:---:|\r\n| GET | Retrieve a specified resource/information from the server. |\r\n| POST | Send data to the server and requests to accept it. |\r\n| PUT | Updates a resource. |\r\n| PATCH | Partially updates a resource. |\r\n| DELETE | Deletes a resource. |\r\n\r\n**POST** requests always contain the following body structure:\r\n\r\n\r\n```\r\n{\r\n\t\"apiVersion\": \"2.0\", // The current API version.\r\n\t\"context\": \"You can add any text here.\", // Optional: In case you send this value in the request.\r\n\t\"data\": { // Contains the request parameters.\r\n\t\t\"item\": { // Single item’s details.\r\n\t\t\t\"endpointAttribute\": \"value\" // Parameter data.\r\n\t\t}\r\n\t}\r\n}\r\n```\r\n\r\nIf an endpoint has no parameters, the body structure has less data:\r\n\r\n```\r\n{\r\n\t\"apiVersion\": \"2.0\", // The current API version.\r\n\t\"context\": \"You can add any text here\", // Optional: In case you send this value in the request.\r\n\t\"data\": { // Contains the request parameters.\r\n\t\t\"item\": { } // Single item’s details.\r\n\t}\r\n}\r\n```\r\n\r\n\r\n\r\n### Basic API Response\r\n\r\nResponses to Crypto APIs requests prerequisites: \r\n\r\n- response public attributes must be all camelCase, e.g. `”apiVersion”: 2`, `”customAttribute”: \"customAttribute\"`;\r\n- Crypto APIs requests always return the following parameters:\r\n\r\n```\r\n{\r\n \"apiVersion\": \"\",\r\n \"requestId\": \"\",\r\n \"context\": \"\",\r\n \"data\": {\r\n \"item\": {\r\n }\r\n }\r\n}\r\n```\r\n\r\n- `apiVersion` reflects the version of the software used;\r\n- `requestId` is a unique code used with the purposes of tracking, support, etc.;\r\n- the attribute `data` always contains the result, no matter of the quantity of items in it;\r\n- the attribute `item` specifies the response’s result indicating there is only a single one, when listed as `items` it means there are two or more results, i.e. a list of results, in the response;\r\n- all calculated prices are always in USD currency;\r\n- we use pagination methods to limit the results in the response, specifically on responses that can potentially return hundreds or thousands of results, please see more information in our [Data Flow Limiting section](https://developers.cryptoapis.io/v-1.2024-12-12-167/RESTapis/general-information/data-flow-limiting).\r\n- each response header contains the following keys, which define the user’s credit usage, to see more information on credits, please see our [API Credential Use section](https://developers.cryptoapis.io/v-1.2024-12-12-167/RESTapis/general-information/authentication):\r\n\r\n```\r\n\"x-credits-consumed\"\r\n\"x-credits-available\"\r\n\"x-response-time\"\r\n\"x-throughput-usage\"\r\n```\r\n\r\n\r\n### The `context` parameter\r\n\r\nThe `context` parameter is an optional attribute created with the idea to facilitate users when they make requests in bulk.\r\n\r\nThey can set the `context` attribute as a string with simple text of their choosing. Afterwards each returned information will contain the specific `context` string of its associated request. Through this process users can keep track of the responses that come in.\r\n\r\nFor **GET** requests the attribute can be set as a query parameter. For **POST** requests it can be set as a query or body parameter. In the latter scenario there’s a safety measure embedded in case the user sets `context` as both a query and body parameter - the system will then take into account the body `context` attribute.\r\n\r\n\r\n\r\n## Error and HTTP Code Standards\r\n\r\nThe full list of Errors you can see on our [respective page](https://developers.cryptoapis.io/v-1.2024-12-12-167/RESTapis/general-information/errors-and-api-status). \r\n\r\nThe errors we use follow the HTTP Error Codes Standard. \r\n\r\n| HTTP Status Code | Error it represents |\r\n|:---:|:---:|\r\n|3xx | Redirection Error |\r\n|4xx | Client Error |\r\n|5xx | Server Error |\r\n\r\n\r\nThe structure of the error **always** returns the following values, as listed and described in the example:\r\n\r\n\r\n_**Example:**_\r\n\r\n```\r\n{\r\n \"apiVersion\": \"\", // The current API Version.\r\n \"requestId\": \"\", // Each request has a unique ID, for which the Support team could ask for when contacted.\r\n \"context\": \"\", // Optional: In case you send this value in your request.\r\n \"error\": {\r\n \"code\": \"\", // Error Code, please check our [Errors page](https://developers.cryptoapis.io/v-1.2024-12-12-167/RESTapis/general-information/errors-and-api-status) to see the full list of error codes.\r\n \"message\": \"\", // Is the human readable error message.\r\n \"details\": \"\" // Optional: Some errors may need more details.\r\n }\r\n}\r\n```\r\n\r\n\r\n## Date and Time Formats\r\n\r\nFor all required endpoints that use a time parameter, the accepted value is `timestamp` which is always UTC-based by definition. The human date which corresponds to the `timestamp` is always converted by the system to UNIX Epoch time and returned as an integer.\r\n\r\n_**Example:**_\r\n\r\nHuman time: 09:12:41 AM 28th January 2021\r\n\r\nWhich corresponds to:\r\n\r\nUNIX Epoch time: 1611825161\r\n\r\nHence the system will return `”timestamp”: 1611825161` and not the human time.\r\n\r\nThe UNIX Epoch time is a system that describes a point in time. This would be the amount of time in seconds that have passed since the Unix Epoch which was 00:00:00 UTC on 1 January 1970, minus leap seconds." }, { "name": "Callbacks", "description": "## Callbacks and Main Terminology\r\n\r\nLet's first define some main vocabulary related to callbacks that will make the process easier to talk about.\r\n\r\n\r\n### Callback\r\n\r\nShortly put, a “callback” is a POST request sent from Crypto APIs to a customer’s Callback URL when an event they have already subscribed for occurs.\r\n\r\nNow with a bit more detail, a “callback” is used to describe an event reaction process where a user receives notifications on certain events by having first subscribed to them in the system. The term has become interchangeable with the word “webhook”, used to describe the same thing. The callback is a way for the system to avoid customers constantly calling the Crypto API to check for an update or event they may be expecting. Callbacks can be very useful for customers who expect, track or want to be notified about the state of transactions on the blockchain.\r\n\r\nThere are two sides of the callback - the server side and the customer side. The process follows the customer side subscribing for an event on the server side and the server side notifying the customer side when that event is completed. \r\n\r\nWith Crypto APIs there are endpoints which will lead to callbacks. These include, but are not limited to [Blockchain Events](https://cryptoapis.io/products/blockchain-events).\r\n\r\n\r\n### Callback Events\r\n#### Definition\r\n\r\nSpecific processes are considered an “event”. Simply put, an “event” is something that occurs on the Blockchain or Crypto Market. Crypto APIs incorporates various endpoints which hold different characteristics. You can see endpoints that represent events to which users can subscribe for a callback on our [API Reference page](https://developers.cryptoapis.io/technical-documentation). Such supported for callback endpoints are displayed with an arrow icon next to them to easily view Callback request parameters and response examples.\r\n\r\n#### Types\r\n\r\nThere are a number of different event types. As a Callback event the following are considered:\r\n\r\n- New Block;\r\n- New Incoming Transaction;\r\n- New Outgoing Transaction;\r\n- New Confirmation;\r\n- Already Forwarded Coins, and more.\r\n\r\n\r\n### Callback URL\r\n\r\nCallbacks require what is known as a **”Callback URL”**. It is the destination where Crypto APIs sends the callback notification for the event. Setting up this URL is done entirely on the customer’s side and is the first step to setting up a Callback. \r\n\r\nLet’s see the main step the customer needs to take in order to set up their Callback URL:\r\n\r\nFirst and foremost, the user must verify a domain they have access to in general. This is done in their [Crypto APIs Dashboard](https://app.cryptoapis.io/). \r\n\r\nAfter the domain is verified, then the user can set a specific URL destination to serve as the Callback URL.\r\n\r\n_**Example:**_\r\n\r\nDomain to verify: **”mypage.mydomain.com”**\r\nCallback URL to set: **“mypage.mydomain.com/login/callback”**\r\nCannot use URL: **“mydomain.com/login/callback”**\r\n\r\nDomain to verify: **”mydomain.com”**\r\nCallback URL to set: **“mydomain.com/login/callback”**\r\nCannot use URL: **“mypage.mydomain.com/login/callback”**\r\n\r\n{note}It is most important that the user has access to the Callback URL they set, in order for them to be able to access/see the callback notification when received.{/note}\r\n\r\n\r\n## Crypto APIs Callback basics\r\n\r\nCrypto APIs Callbacks follow certain basics and the same standard that applies to all callback subscriptions.\r\n\r\n- Callback requests sent from Crypto APIs are **always** POST;\r\n- All Crypto APIs headers must by default incorporate the JSON content type **application/json**;\r\n- All Crypto API Callbacks incorporate the use of a Callback URL, without exceptions;\r\n- A customer can subscribe for a callback to as many supported events as they want, as many times as needed;\r\n- The callback functionality in Crypto APIs is identical throughout every product and endpoint that supports it;\r\n- The callback request from Crypto APIs to the customer includes the exact information and parameters as requested by the customer when they first set up the subscription, which are included in the `data` parameter of the code; \r\n- The attribute `x-signature` is a custom for Crypto APIs parameter, as indicated with the `x-` in the beginning;\r\n- The structure of the Callback is always the same no matter the subscription or type of event.\r\n\r\n\r\n## Callback standard structure\r\n\r\nThe callback structure has the following constant parameters:\r\n\r\n```\r\n{\r\n \"apiVersion\": \"2.0\", //**Represents the current Crypto APIa version**\r\n \"referenceId\": \"2921e3df-c671-4d20-b51b-d176d5c1e43g\", //**Represents the unique reference identifier of the callback.**\r\n \"idempotencyKey\": \"3b3359d0ccdb1d3d3ca8dbaa79cb5395b33c5bc52d782f3ea22904abef45d1j4\", //**Specifies a unique ID used by Crypto APIs to recognize consecutive requests with the same data so that not to perform the same operation twice.**\r\n \"data\": { //**Includes information and details on the callback, dependent on the customer’s secret.**\r\n \"product\": \"BLOCKCHAIN_EVENTS\", //**Specifies the product for which the event occurs.**\r\n \"event\": \"BLOCK_MINED\", //**Specifies the actual event type, for which the callback subscription was made.\r\n \"item\": { //**Includes all customer-specific details for the callback.**\r\n }\r\n }\r\n}\r\n```\r\n\r\n\r\n### Reference ID and `referenceId`\r\n\r\nThe `referenceId` indicates a reference to the subscription that has been made by the customer. It is a unique code applicable only for that subscription. Each time a customer sets up an automation or event subscription, the corresponding callback always has a parameter `referenceId`. \r\n\r\n\r\n### Idempotency and `idempotentKey`\r\n\r\nIdempotency represents a process in computing and REST which a server uses to recognize subsequent retries of the same request where the returned result always remains the same. It is a security mechanism for retrying requests without the risk of performing the same operation more than once.\r\n\r\nSuch risks usually can occur when an API call is for some reason disrupted during processing (e.g. network connection error) and a response is not returned. In such cases the API call would be retried. By including an **`idempotencyKey`** in the initial request there is guarantee that the specific action won’t be done more than once.\r\n\r\nThe `idempotencyKey` is generated only on the server-end in the use of Crypto APIs Callbacks. It is added to the Callback request and is unique per initial callback request. `idempotencyKey` values are generated randomly. \r\n\r\nAll original requests containing an `idempotencyKey`, along with their body and response status code (both success and error), are saved by the system. After that, any subsequent requests containing the same `idempotencyKey` will automatically return the same result. \r\n\r\n\r\n## Setting up callbacks\r\n\r\nCallbacks combine certain elements and steps needed to be able to create a correct reaction and on-time notification.\r\n\r\nTheir way of work includes the customer to first set up their callback subscription, and later on, whenever the subscription event occurs, for the Crypto APIs to notify the customer. All steps are taken through API Requests and Responses.\r\n\r\n1. **Customer sets up Callback URL** \r\n\r\n The customer must first have a [verified domain and set up Callback URL](https://app.cryptoapis.io/verify-domain).\r\n\r\n2. **Customer subscribes for an event**\r\n\r\n After verifying their domain, the customer has to send a request to Crypto APIs in order to subscribe for a callback on a certain event. The customer can subscribe to as many events they want, as many times as they need.\r\n\r\n When the customer sends their request to subscribe for an event the system must return a response. If there is no problem, where otherwise an error would result, the response from Crypto APIs would be “201 New resource successfully created”. Then it is confirmed that the callback subscription for that particular event has been set up.\r\n\r\n If the subscription setup has failed, it will return an error, e.g. **Error 409 Conflict**. If an error is returned, there is a mistake or issue with the customer’s request. It must be then fixed so that Crypto APIs can return a successful response. \r\n\r\n3. **Crypto APIs sends the Callback as a request**\r\n\r\n Crypto APIs’ responsibility to the customer is to notify them according to their subscription for that particular event or events **only when it/they occur**. Whenever the event happens Crypto APIs sends a request back to the customer that includes the data on the event, as requested by the customer. This is essentially the “callback” itself. If the callback is not confirmed by the customer side with a “200 OK” response, the system will follow a specific retry strategy.\r\n\r\nIt is important to also clarify that subscribing for an event and setting a callback for it **does not** necessarily mean that the callback will occur soon or even at all. We do everything possible to make sure that callbacks have no delays, errors, or issues, and are received as the events occur. \r\n\r\nStill, not receiving a callback for a subscribed event for a long time could be due to many reasons. There may be events that need to take days, weeks or months to occur even just once, and some that may encounter problems, errors, issues, and never happen at all.\r\n\r\n{warning}A user will **not receive** a notification, an email, a message, a report or any other kind of alert for an event they have subscribed for, when the event has not occurred or will not happen at all, regardless of how much time has passed since the setup of the callback. Setting up a callback ensures the obligation of the system towards the customer to notify them **only when** the event happens.{/warning}\r\n\r\n{warning}Users might at times receive a notification for a callback event more than once, due to many Workers processing those. Make sure you use idempotency and you can also log processed events only once without processing such that are already-logged.{/warning}\r\n\r\n### Callback Retries\r\n\r\nWhen the callback request is sent from Crypto APIs it expects a response from the customer side, as well. \r\n\r\nUntil a status code “200 OK Request has been successful” is received, Crypto APIs will keep retrying the request. There will be 5 retries in total distributed at certain intervals.\r\n\r\n - Crypto APIs will send the requested callback when it’s time and a customer response is expected in the first 5 seconds;\r\n- If a response isn’t received during that time frame the system is prepared to send **in total 5** retries of the callback;\r\n- The first callback retry will be send after 5 min;\r\n- After that, each following callback will take twice as long to be sent compared to the previous one. This is done with the purpose to extend the time during which the customer can at all receive the notification and its retries and provide opportunity for the customer to send a “200 OK” response;\r\n- Additionally, there’s an included **“random value”** into the algorithm as a factor of **”0.2”**, which creates small but important fluctuations in the time frames between callback retries. This ensures that when large volumes of callbacks are sent they would not be in bulk due to having the same time frames, which could otherwise lead to crashes and server issues.\r\n\r\n{note}Time frames in the system are measured in seconds, e.g. first callback retry will be send after 5 min = 300 sec.{/note}\r\n\r\n{warning}If after all callback retries from Crypto APIs there is no successful response from the customer, the callback will end up in a final error and terminate. The system will mark all Blockchain Event subscriptions for the same event type, which have the same callback URL and same webhook ID, as \"disabled\".{/warning} \r\n\r\n\r\n## Callback Security\r\n\r\nCrypto APIs has incorporated a security layer to keep callbacks from being intercepted, duplicated and make sure customers are receiving their callbacks only from Crypto APIs.\r\n\r\n\r\n### Customer’s Secret Key\r\n\r\nThe customer’s request can include data on the event they want to subscribe for and has the option to also have a `callbackSecretKey`. This parameter is an optional security measure for the benefit of the customer. The `callbackSecretKey` can only be generated by the customer. It is used to create a unique hash string in the `x-signature` response header in the callback request sent from Crypto APIs when the event occurs.\r\n\r\nThe `callbackSecretKey`, and thus the `x-signature`, are set up per event subscription, not per single callback. Hence the customer only needs to set up the `callbackSecretKey` once when subscribing for an event. They can use a single `callbackSecretKey` for all subscriptions, or different ones for each subscription. The security is effective enough even with just one common `callbackSecretKey`.\r\n\r\n{warning}Please note that though using the `callbackSecretKey` is an optional step, we recommend it for security purposes! Not using a `callbackSecretKey` means that no security layer will be applied to your callbacks.{/warning}\r\n\r\n\r\n### Callback Signature\r\n\r\nIn the case a customer has included a `callbackSecretKey` in their request to Crypto APIs, the callback (Crypto APIs' request to the customer) includes a specific `x-signature` value which is for verification purposes. It is used by the customer to verify the information they receive is in actuality really coming from Crypto APIs and not a scam.\r\n\r\nThe `x-signature` is provided in the header of the callback and represents a unique hash derived from all the information included in the callback about the event (which must be JSON encoded) and the customer’s `callbackSecretKey`.\r\n\r\nFor the purpose HMAC_SHA256 is used. It stands for Hash-based message authentication code and along with its cryptographic hash function SHA256 it represents higher security than any other authentication code.\r\n\r\nThe cryptographic strength of the HMAC depends upon the size of the `callbackSecretKey` that has been used. The most common attack against HMACs is brute force to uncover that secret key. HMACs are substantially less affected by collisions than their underlying hashing algorithms alone.\r\n\r\nWhen the customer receives the callback request from Crypto APIs, they can first check the `x-signature` before processing the request. By using their `callbackSecretKey`, which only they would know, together with the information from the callback they can generate a hash and compare it to the `x-signature` hash that the Crypto APIs server has returned. They **must** match which only then would authenticate Crypto APIs as the true sender. \r\n\r\nAfter authentication of the callback, the customer can then proceed to processing it. If the authentication with the `x-signature` fails, then the customer **must** ignore it as someone else is sending it.\r\n\r\n_**Example:**_\r\n\r\nHMAC_SHA256 (`callbackSecretKey`, `The quick brown fox jumps over the lazy dog`) = f7bc83f430538424b13298e6aa6fb143ef4d59a14946175997479dbg2d1a3cd8\r\n\r\n`callbackSecretKey` - Represents an optional string the customer can send into their request when they create the callback subscription.\r\n`The quick brown fox jumps over the lazy dog` - Represents everything we post in the body of the server side callback request.\r\n`f7bc83f430538424b13298e6aa6fb143ef4d59a14946175997479dbg2d1a3cd8` - Represents the resulting hash sent in the header (value name: `x-signature`) of the post request.\r\n\r\n\r\n## Callback data returned for UTXO-based transactions\r\n\r\nCalbacks return more specific information in regards to UTXO-based transactions (BTC). This specification applies to the following events:\r\n\r\n- [New unconfirmed coins transactions](https://developers.cryptoapis.io/v-1.2024-12-12-167/RESTapis/create-subscriptions-for/new-unconfirmed-coins-transactions/post);\r\n- [New confirmed coins transactions](https://developers.cryptoapis.io/v-1.2024-12-12-167/RESTapis/create-subscriptions-for/new-confirmed-coins-transactions/post);\r\n- [New confirmed coins transactions and each confirmation](https://developers.cryptoapis.io/v-1.2024-12-12-167/RESTapis/create-subscriptions-for/new-confirmed-coins-transactions-and-each-confirmation/post).\r\n\r\nFor:\r\n\r\n- **1 occurrence of the address in the input** - in the callback we send the amount and the type is outgoing;\r\n- **1 occurrence of address in output** - in the callback we send the amount and the type is incoming;\r\n- **2+ occurrences of address in inputs** - in the callback we send the total calculated amount and the type is outgoing;\r\n- **2+ occurrences of address in outputs** - in the callback we send the total calculated amount and the type is incoming;\r\n- **1 occurrence of address in input AND 1 occurrence of address in output** - in the callback we send the amount in the **input** and the type is outgoing;\r\n- **2+ occurrences of address in input AND 1 occurrence of address in output** - in the callback we send the total calculated amount in the **input** and the type is outgoing;\r\n- **1 occurrence of address in input AND 2+ occurrences of address in output** - in the callback we send the amount in the **input** and the type is outgoing;\r\n- **2+ occurrences of address in input AND 2+ occurrence of address in output** - in the callback we send the total calculated amount in the **input** and the type is outgoing." }, { "name": "Address Latest", "description": "Using Crypto APIs Blockchain Data Unified Endpoints you can get information from all supported blockchain protocols in the same unified way. \r\n\r\nUnified endpoints have the same data on the main level and varying attributes depedning on the selected Blockchain, e.g. Bitcoin, Etehreum, Litecoin, etc." }, { "name": "HD Wallets", "description": "A hierarchical deterministic (HD) wallet is a digital wallet commonly used to store the digital keys for holders of cryptocurrencies, e.g. Bitcoin, Ethereum, etc. Anyone with a copy of both the public and password-like private key can control the cryptocurrency in their account. This also refers to xPub, yPub and zPub. Through our HD Wallet endpoints customers can sync HD wallets, obtain HD wallet details, list HD wallet transactions, and more." }, { "name": "Create Subscriptions for", "description": "With Crypto APIs and Blockchain Events you can set up subscriptions to receive a callback whenever a specific events occurs. Various endpoints are available for callback subscription. Callback subscription can be set from the Crypto APIs Dashboard. They require a Callback URL where the actual callback will be received at.\r\n\r\nCrypto APIs Callbacks will be sent along with a retry logic if the first one is not accepted by the customer's end.\r\n\r\nNote, that a Callback will be sent only when the event occurs. In some cases this may take a long time, in others it may never even happen. This is not up to Crypto APIs.\r\n\r\nIt is important to note that in order to set a valid and working Callback subscription, the domain for the Callback URL must be first verified.\r\n\r\nTo see more information on Callbacks and how they operate, please see our dedicated [documentation](https://developers.cryptoapis.io/technical-documentation/general-information/callbacks)." }, { "name": "Manage Subscriptions", "description": "Manage subscriptions set for event callbacks. These could include listing subscriptions set for the user, deleting subscriptions, etc.\r\n\r\nNote, that a Callback will be sent only when the event occurs. In some cases this may take a long time, in others it may never even happen. This is not up to Crypto APIs.\r\n\r\nIt is important to note that in order to set a valid and working Callback subscription, the domain for the Callback URL must be first verified.\r\n\r\nTo see more information on Callbacks and how they operate, please see our dedicated [documentation](https://developers.cryptoapis.io/technical-documentation/general-information/callbacks)." }, { "name": "Utils", "description": "Crypto APIs useful features and tools for blockchain and crypto operations. Users can utilize these endpoints to validate addresses, broadcast transactions and more." }, { "name": "Address History", "description": "We support ERC-20, ERC-721 standards on Ethereum and Omni Layer on Bitcoin. You can see the full list on [our website](https://cryptoapis.io/)." }, { "name": "XRP (Ripple)", "description": "This section represents only endpoints related to XRP (Ripple) blockchain protocol, relating to obtaining information on transactions, addresses and blocks." }, { "name": "Assets", "description": "Through these endpoints customers can obtain detailed information about assets supported by Crypto APIs, bot crypto and fiat. This is part of the Market Data product." }, { "name": "Exchange Rates", "description": "Use these endpoints to obtain information about cryptocurrency and blockchain exchange rates. This is part of the Market Data product." }, { "name": "Metadata", "description": "Here customers can list meta information about supported assets, both crypto and fiat. This is part of the Market Data product." }, { "name": "Contracts", "description": "Here customers can check information about internal transactions." }, { "name": "Blocks Data", "description": "This category displays Wallet-as-a-Service endpoints which can be used to generate addresses for a Wallet." }, { "name": "Transactions Data", "description": "This category displays Wallet-as-a-Service endpoints which can be used to create transactions." }, { "name": "Informative", "description": "This category displays Wallet-as-a-Service endpoints which can be used to obtain information for the Wallet such as list deposit addresses." }, { "name": "Broadcast transaction", "description": "Through this endpoint customers can broadcast transactions that have been already signed locally. Instead of using a node for broadcasting a signed transaction users can use this endpoint. We then keep the user posted about the status by sending you a callback with a success or failure status." }, { "name": "Blockchain Fees", "description": "This section allow customers to obtain fee recommendations" }, { "name": "Prepare transactions", "description": "Through this section customers can prepare a transaction from an address with private and public keys. The address doesn’t have to belong to a wallet." }, { "name": "Solana", "description": "This section represents only endpoints related to Solana blockchain protocol, relating to obtaining information on transactions, addresses and tokens." }, { "name": "EVM", "description": "" }, { "name": "UTXOs", "description": "" }, { "name": "Manage addresses", "description": "" }, { "name": "Manage HD wallet", "description": "" }, { "name": "HD Wallet data", "description": "" }, { "name": "Transactions Data", "description": "" }, { "name": "API Versioning", "description": "## Crypto APIs API Versioning\r\nAn additional feature in the Crypto APIs system allows us to generate new API versions of our endpoints each time backwards-incompatible changes have been made to them. Versions are generally titled with a date and \"stable\" versions are marked as such.\r\nYou can try out new features and changes in our newer versions not marked as \"stable\".\r\nOur technical documentation lists all available API versions. To view a specific one, select it from the drop down menu.\r\nAll requests use your account's API version, unless you override the API version with a header.\r\n\r\nThe request header that you should use to select a chosen API version:\r\n**header:** x-api-version" }, { "name": "Kaspa", "description": "This section represents only endpoints related to Kaspa blockchain protocol, relating to obtaining information on transactions and addresses." }, { "name": "MCP Servers", "description": "## Crypto APIs MCP Servers\r\n\r\nCrypto APIs provides a suite of **14 standalone MCP servers** that expose blockchain tools to AI clients (Claude, Cursor, Windsurf, n8n, and any MCP-compatible host). Each server is a lightweight Node.js process that connects via stdio or HTTP and covers a specific domain — from address balances and transaction history to fee estimation, local signing, and smart contract data — across 20+ blockchains.\r\n\r\nAll servers are published on npm under the `@cryptoapis-io` scope and are open source on GitHub.\r\n\r\n---\r\n\r\n### Available Servers\r\n\r\n#### Address Data\r\n\r\n**[Address Latest](https://github.com/CryptoAPIs-io/cryptoapis-mcp-address-latest)** — `@cryptoapis-io/mcp-address-latest`\r\nGet current balances, nonces, token holdings, and recent transactions for any address. Supports EVM, UTXO, Solana, XRP, and Kaspa chains.\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-address-latest --api-key YOUR_API_KEY\r\n```\r\n\r\n**[Address History](https://github.com/CryptoAPIs-io/cryptoapis-mcp-address-history)** — `@cryptoapis-io/mcp-address-history`\r\nSync addresses for continuous tracking and retrieve full transaction and token transfer history. Supports EVM and UTXO chains.\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-address-history --api-key YOUR_API_KEY\r\n```\r\n\r\n#### Block Data\r\n\r\n**[Block Data](https://github.com/CryptoAPIs-io/cryptoapis-mcp-block-data)** — `@cryptoapis-io/mcp-block-data`\r\nRetrieve blocks by height or hash, list transactions within a block, and get the latest mined block. Supports EVM, UTXO, and XRP chains.\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-block-data --api-key YOUR_API_KEY\r\n```\r\n\r\n#### Transactions Data\r\n\r\n**[Transactions Data](https://github.com/CryptoAPIs-io/cryptoapis-mcp-transactions-data)** — `@cryptoapis-io/mcp-transactions-data`\r\nLook up transaction details, internal transactions, token transfers, and logs. Supports EVM, UTXO, Solana, XRP, and Kaspa chains.\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-transactions-data --api-key YOUR_API_KEY\r\n```\r\n\r\n#### Blockchain Fees\r\n\r\n**[Blockchain Fees](https://github.com/CryptoAPIs-io/cryptoapis-mcp-blockchain-fees)** — `@cryptoapis-io/mcp-blockchain-fees`\r\nGet fee recommendations, EIP-1559 estimates, and gas estimation for transfers and contract interactions. Supports EVM, UTXO, and XRP.\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-blockchain-fees --api-key YOUR_API_KEY\r\n```\r\n\r\n#### Simulation\r\n\r\n**[Simulate](https://github.com/CryptoAPIs-io/cryptoapis-mcp-simulate)** — `@cryptoapis-io/mcp-simulate`\r\nDry-run EVM transactions to preview outcomes, gas usage, and state changes before broadcasting.\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-simulate --api-key YOUR_API_KEY\r\n```\r\n\r\n#### Transaction Lifecycle\r\n\r\n**[Prepare Transactions](https://github.com/CryptoAPIs-io/cryptoapis-mcp-prepare-transactions)** — `@cryptoapis-io/mcp-prepare-transactions`\r\nBuild unsigned EVM transactions (native coin, ERC-20, ERC-721 transfers) ready for local signing.\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-prepare-transactions --api-key YOUR_API_KEY\r\n```\r\n\r\n**[Signer](https://github.com/CryptoAPIs-io/cryptoapis-mcp-signer)** — `@cryptoapis-io/mcp-signer`\r\nSign transactions locally using private keys. Supports EVM, UTXO, Tron, and XRP. **No API calls are made** — keys never leave your machine. No API key required. Stdio transport only.\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-signer\r\n```\r\n\r\n**[Broadcast](https://github.com/CryptoAPIs-io/cryptoapis-mcp-broadcast)** — `@cryptoapis-io/mcp-broadcast`\r\nSubmit signed raw transactions to blockchain networks for execution.\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-broadcast --api-key YOUR_API_KEY\r\n```\r\n\r\n#### Market Data\r\n\r\n**[Market Data](https://github.com/CryptoAPIs-io/cryptoapis-mcp-market-data)** — `@cryptoapis-io/mcp-market-data`\r\nGet cryptocurrency asset prices, exchange rates between any pair, and market metadata.\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-market-data --api-key YOUR_API_KEY\r\n```\r\n\r\n#### Contracts\r\n\r\n**[Contracts](https://github.com/CryptoAPIs-io/cryptoapis-mcp-contracts)** — `@cryptoapis-io/mcp-contracts`\r\nRead smart contract ABIs and on-chain token/contract data from EVM and Solana blockchains.\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-contracts --api-key YOUR_API_KEY\r\n```\r\n\r\n#### HD Wallets (xPubs)\r\n\r\n**[HD Wallet](https://github.com/CryptoAPIs-io/cryptoapis-mcp-hd-wallet)** — `@cryptoapis-io/mcp-hd-wallet`\r\nManage HD wallets via xPub — sync, activate, derive addresses, and retrieve balances and transactions. Supports EVM, UTXO, and XRP.\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-hd-wallet --api-key YOUR_API_KEY\r\n```\r\n\r\n#### Events & Webhooks\r\n\r\n**[Blockchain Events](https://github.com/CryptoAPIs-io/cryptoapis-mcp-blockchain-events)** — `@cryptoapis-io/mcp-blockchain-events`\r\nCreate and manage webhook subscriptions for on-chain events — confirmed/unconfirmed coin and token transfers, new blocks, transaction confirmations, and more.\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-blockchain-events --api-key YOUR_API_KEY\r\n```\r\n\r\n#### Utilities\r\n\r\n**[Utils](https://github.com/CryptoAPIs-io/cryptoapis-mcp-utils)** — `@cryptoapis-io/mcp-utils`\r\nAddress derivation from xPub, address validation, raw transaction decoding, and encoding utilities for EVM, UTXO, and XRP.\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-utils --api-key YOUR_API_KEY\r\n```\r\n\r\n---\r\n\r\n### Installation\r\n\r\nEvery server runs with a single `npx` command — no cloning or building needed.\r\n\r\n**Claude Desktop / Cursor / Windsurf** — add to your MCP config:\r\n\r\n```json\r\n{\r\n \"mcpServers\": {\r\n \"cryptoapis-market-data\": {\r\n \"command\": \"npx\",\r\n \"args\": [\"-y\", \"@cryptoapis-io/mcp-market-data\", \"--api-key\", \"YOUR_API_KEY\"]\r\n }\r\n }\r\n}\r\n```\r\n\r\nReplace the package name to add any other server. Add multiple entries to use several servers at once.\r\n\r\n**HTTP mode** (for n8n, custom integrations, or remote access):\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-market-data --transport http --api-key YOUR_API_KEY --port 3000\r\n```\r\n\r\nThe server exposes `/mcp` (MCP endpoint) and `/health` (healthcheck). When running multiple servers, assign each a different `--port`.\r\n\r\n---\r\n\r\n### Remote MCP Server\r\n\r\nFor production deployments or when you need all tools behind a single endpoint, Crypto APIs provides a **remote MCP server** — an HTTP server that aggregates all 14 tool packages behind one `/mcp` endpoint.\r\n\r\nThis is ideal when you want to:\r\n- Access all 14 tool packages through a single endpoint\r\n- Share the server across multiple AI clients or team members\r\n- Avoid running separate processes for each package\r\n\r\nThe **official remote endpoint** is available at:\r\n\r\n```\r\nhttps://ai.cryptoapis.io/mcp\r\n```\r\n\r\nPass your API key via the `x-api-key` header. Compatible with any MCP client that supports HTTP Streamable transport.\r\n\r\n#### Product-Scoped Endpoints\r\n\r\nIn addition to the full `/mcp` endpoint, you can connect to a **single product** using `/mcp/{product}`. The scoped endpoint creates a session that only exposes that product's tools — fewer tools means faster initialization and a smaller context for your AI client.\r\n\r\n| Endpoint | Tools |\r\n|----------|-------|\r\n| `/mcp` | All 50 tools from all products |\r\n| `/mcp/address-latest` | Address balances, nonces, recent transactions |\r\n| `/mcp/address-history` | Synced address management and full history |\r\n| `/mcp/block-data` | Block lookup by height/hash |\r\n| `/mcp/transactions-data` | Transaction details, internal txs, token transfers |\r\n| `/mcp/blockchain-fees` | Fee recommendations and gas estimation |\r\n| `/mcp/simulate` | Dry-run EVM transactions |\r\n| `/mcp/prepare-transactions` | Build unsigned EVM transactions |\r\n| `/mcp/broadcast` | Submit signed transactions |\r\n| `/mcp/market-data` | Asset prices and exchange rates |\r\n| `/mcp/contracts` | Smart contract ABIs and token data |\r\n| `/mcp/hd-wallet` | HD wallet (xPub) management |\r\n| `/mcp/blockchain-events` | Webhook subscriptions for on-chain events |\r\n| `/mcp/utils` | Address derivation, validation, decoding |\r\n\r\nFor example, to connect an AI client only to address balance tools:\r\n\r\n```\r\nhttps://ai.cryptoapis.io/mcp/address-latest\r\n```\r\n\r\nThis works with the same `x-api-key` header and the same MCP protocol — the only difference is the set of tools available in the session.\r\n\r\n---\r\n\r\n### Supported Blockchains\r\n\r\n| Type | Blockchains |\r\n|------|------------|\r\n| **EVM** | Ethereum, Ethereum Classic, Binance Smart Chain, Polygon, Avalanche C-Chain, Tron, Arbitrum, Base, Optimism |\r\n| **UTXO** | Bitcoin, Bitcoin Cash, Litecoin, Dogecoin, Dash, Zcash |\r\n| **Other** | XRP, Solana, Kaspa |\r\n\r\nEach blockchain supports mainnet and testnet (where available).\r\n\r\n---\r\n\r\n### Get Your API Key\r\n\r\nSign up at [cryptoapis.io](https://cryptoapis.io) to get your API key and start using the servers." }, { "name": "n8n MCP Client", "description": "## Use Crypto APIs MCP in n8n Workflows\r\n\r\nConnect any Crypto APIs MCP server to n8n's **AI Agent** node via the built-in **MCP Client Tool**. This lets the AI agent autonomously call blockchain tools — fetching balances, estimating fees, looking up transactions, and more — as part of your automated workflows.\r\n\r\n### How It Works\r\n\r\nMCP (Model Context Protocol) is an open standard that lets AI agents discover and call tools dynamically. Each Crypto APIs MCP server exposes a set of blockchain tools over HTTP. n8n's MCP Client connects to these servers so the AI Agent can use them on demand.\r\n\r\n### Setup\r\n\r\n**1. Start the MCP server in HTTP mode:**\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-market-data --transport http --api-key YOUR_API_KEY --port 3000\r\n```\r\n\r\n**2. Wire it into your n8n workflow:**\r\n\r\n- Add an **AI Agent** node\r\n- Under the agent's **Tools** section, click **+ Tool** and select **MCP Client**\r\n- Set the **SSE URL** to `http://localhost:3000/mcp`\r\n\r\nThe AI Agent will automatically discover all available tools and call them as needed.\r\n\r\n### Using Multiple MCP Servers\r\n\r\nEach server defaults to port 3000. Assign different ports when running several at once:\r\n\r\n```bash\r\nnpx @cryptoapis-io/mcp-market-data --transport http --api-key YOUR_API_KEY --port 3000\r\nnpx @cryptoapis-io/mcp-blockchain-fees --transport http --api-key YOUR_API_KEY --port 3001\r\nnpx @cryptoapis-io/mcp-transactions-data --transport http --api-key YOUR_API_KEY --port 3002\r\n```\r\n\r\nAdd a separate **MCP Client Tool** in n8n for each server, pointing to its respective port.\r\n\r\n### Remote MCP Server — No Self-Hosting Required\r\n\r\nCrypto APIs provides an official remote MCP endpoint that aggregates all tools behind a single URL:\r\n\r\n```\r\nhttps://ai.cryptoapis.io/mcp\r\n```\r\n\r\nSet this as the MCP Client URL in n8n and pass your API key via the `x-api-key` header. No local servers to run or manage.\r\n\r\nYou can also connect to a **single product** by appending the product name. This gives the AI agent only the tools it needs — faster discovery and less noise in the context:\r\n\r\n```\r\nhttps://ai.cryptoapis.io/mcp/market-data\r\nhttps://ai.cryptoapis.io/mcp/address-latest\r\nhttps://ai.cryptoapis.io/mcp/blockchain-fees\r\n```\r\n\r\nAvailable products: `address-latest`, `address-history`, `block-data`, `transactions-data`, `blockchain-fees`, `simulate`, `prepare-transactions`, `broadcast`, `market-data`, `contracts`, `hd-wallet`, `blockchain-events`, `utils`.\r\n\r\nFor most n8n workflows a scoped endpoint is the better choice — for example, a fee alert workflow only needs `/mcp/blockchain-fees`, and a portfolio tracker only needs `/mcp/market-data` and `/mcp/address-latest` (one MCP Client Tool per product).\r\n\r\n### Example Workflow Ideas\r\n\r\n- **Portfolio tracker** — Use *Market Data* + *Address Latest* to fetch token balances and live prices on a schedule, then send a summary via email or Slack.\r\n- **Transaction monitor** — Use *Blockchain Events* to set up a webhook for incoming transactions, trigger an n8n workflow on each event, and log details to a Google Sheet.\r\n- **Fee alerts** — Use *Blockchain Fees* on a cron to check gas prices and notify you when fees drop below a threshold.\r\n- **Automated transfers** — Chain *Prepare Transactions* → *Signer* (local) → *Broadcast* to build, sign, and send transactions end-to-end.\r\n\r\n### Notes\r\n\r\n- The **Signer** package is stdio-only (local signing) and does **not** support HTTP — use it as a standalone CLI step.\r\n- For production, run MCP servers as persistent processes (pm2, systemd, Docker) rather than `npx`.\r\n- Get your API key at [cryptoapis.io](https://cryptoapis.io)." }, { "name": "n8n Community Node", "description": "## Use Crypto APIs in n8n Workflows\r\n\r\nThe **Crypto APIs community node** (`@cryptoapis-io/n8n-nodes-cryptoapis`) brings blockchain data and operations directly into n8n — no MCP servers or extra infrastructure required. It calls the Crypto APIs REST API natively and works both as a standard workflow node and as an AI Agent tool.\r\n\r\n### Installation\r\n\r\n1. In n8n, go to **Settings** > **Community Nodes**\r\n2. Search for `@cryptoapis-io/n8n-nodes-cryptoapis` and install it\r\n3. Set up the **Crypto APIs API** credential with your API key from [app.cryptoapis.io](https://app.cryptoapis.io)\r\n\r\nThe node appears as **Crypto APIs** in the node palette and is ready to use.\r\n\r\n### What You Can Do\r\n\r\nThe node exposes **13 resources** covering the full Crypto APIs platform across 20+ blockchains:\r\n\r\n| Resource | What it does |\r\n|----------|-------------|\r\n| **Address Latest** | Get current balances, nonces, token holdings, and recent transactions for EVM, UTXO, Solana, XRP, and Kaspa addresses |\r\n| **Address History** | Sync addresses and retrieve full transaction and token transfer history (EVM, UTXO) |\r\n| **Block Data** | Fetch blocks by height or hash, list block transactions, get the latest mined block (EVM, UTXO, XRP) |\r\n| **Blockchain Fees** | Get fee recommendations, EIP-1559 estimates, and gas estimation for transfers and contract calls (EVM, UTXO, XRP) |\r\n| **Transactions Data** | Look up transaction details, internal transactions, token transfers, and logs (EVM, UTXO, Solana, XRP, Kaspa) |\r\n| **Market Data** | Get asset details, exchange rates, and list supported assets |\r\n| **HD Wallet** | Sync HD wallets, derive addresses, list balances and transactions (EVM, UTXO, XRP) |\r\n| **Prepare Transactions** | Build unsigned EVM transactions — native coin, ERC-20, and ERC-721 transfers |\r\n| **Simulate** | Dry-run an EVM transaction before broadcasting |\r\n| **Broadcast** | Submit signed raw transactions to the network (EVM, UTXO) |\r\n| **Blockchain Events** | Create and manage webhook subscriptions for on-chain events — confirmed/unconfirmed coins, tokens, new blocks, and more |\r\n| **Contracts** | Get token details by contract address (EVM, Solana) |\r\n| **Utils** | Validate addresses, decode raw transactions, derive addresses from xPub, encode/decode XRP X-Addresses |\r\n\r\n### Using It as a Standard Node\r\n\r\nDrag the **Crypto APIs** node into any workflow and configure:\r\n\r\n1. **Resource** — pick from the 13 categories above\r\n2. **Blockchain type** — EVM, UTXO, Solana, XRP, or Kaspa (depending on the resource)\r\n3. **Operation** — the specific action (e.g., Get Balance, List Transactions)\r\n4. **Parameters** — blockchain, network, address, etc.\r\n\r\nPagination is handled automatically — toggle **Return All** to fetch every result, or set a limit.\r\n\r\n### Using It as an AI Agent Tool\r\n\r\nThe node has `usableAsTool` enabled, so it plugs directly into n8n's **AI Agent** node:\r\n\r\n1. Add an **AI Agent** node to your workflow\r\n2. Under **Tools**, click **+ Tool** and select **Crypto APIs**\r\n3. Configure the resource and operation\r\n4. The AI agent can now call this tool autonomously based on user prompts\r\n\r\nThis approach gives the AI agent structured access to specific blockchain operations without needing to run separate MCP servers.\r\n\r\n### Example Workflow Ideas\r\n\r\n- **Portfolio dashboard** — Trigger on a schedule, use *Address Latest* to fetch balances across multiple wallets, aggregate with a *Code* node, and push to a Google Sheet or dashboard.\r\n- **Whale alert bot** — Use *Blockchain Events* to subscribe to large incoming transfers on a watched address, then post alerts to Slack or Telegram.\r\n- **Gas price monitor** — Run *Blockchain Fees* every few minutes, compare against a threshold in an *If* node, and send a notification when gas is cheap.\r\n- **Payment processor** — Receive a webhook, use *Prepare Transactions* to build a payout, sign it externally, then *Broadcast* the result — all in one workflow.\r\n- **Token analytics** — Use *Market Data* to pull exchange rates and *Contracts* to get token details, then combine and store in a database for reporting.\r\n\r\n### Supported Blockchains\r\n\r\n**EVM**: Ethereum, Ethereum Classic, Binance Smart Chain, Polygon, Avalanche C-Chain, Tron, Arbitrum, Base, Optimism\r\n**UTXO**: Bitcoin, Bitcoin Cash, Litecoin, Dogecoin, Dash, Zcash\r\n**Other**: XRP, Solana, Kaspa\r\n\r\nEach blockchain supports mainnet and testnet (where available).\r\n\r\n### Notes\r\n\r\n- The node calls the Crypto APIs REST API directly — no MCP servers or additional services are needed.\r\n- API key is the only credential required. Get one at [cryptoapis.io](https://cryptoapis.io).\r\n- For the MCP-based approach (connecting to Crypto APIs MCP servers via n8n's MCP Client Tool), see the separate MCP integration guide." } ], "paths": { "/hd-wallets/manage/{blockchain}/{network}/{extendedPublicKey}/sync": { "post": { "tags": [ "HD wallet", "Manage HD wallet" ], "operationId": "Sync HD Wallet (xPub, yPub, zPub)", "summary": "Sync HD Wallet (xPub, yPub, zPub)", "description": "HD wallets usually have a lot of addresses and transactions, getting the data on demand is a heavy operation. That's why we have created this feature, to be able to get HD wallet details or transactions this HD wallet must be synced first. In addition to the initial sync we keep updating the synced HD wallets all the time.\r\n\r\n{warning}Any HD wallet sent for syncing will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "ethereum", "zcash", "ethereum-classic", "binance-smart-chain", "xrp", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "mordor", "nile", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncHDWalletXPubYPubZPubRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncHDWalletXPubYPubZPubR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncHDWalletXPubYPubZPubE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncHDWalletXPubYPubZPubE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncHDWalletXPubYPubZPubE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncHDWalletXPubYPubZPubE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "422", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncHDWalletXPubYPubZPubE422" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/manage/{blockchain}/{network}": { "get": { "tags": [ "Manage HD wallet" ], "operationId": "List Synced HD Wallets (xPub, yPub, zPub)", "summary": "List Synced HD Wallets (xPub, yPub, zPub)", "description": "Through this endpoint you can list all of your synced HD Wallets by providing their blockchain protocol and network.", "x-cost": 30, "x-charge-count": 1, "x-is-list": true, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "binance-smart-chain", "bitcoin", "bitcoin-cash", "dash", "dogecoin", "ethereum", "ethereum-classic", "litecoin", "tron", "xrp", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "testnet", "mordor", "nile", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSyncedHDWalletsXPubYPubZPubR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedHDWalletsXPubYPubZPubE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedHDWalletsXPubYPubZPubE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedHDWalletsXPubYPubZPubE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/manage/{blockchain}/{network}/{extendedPublicKey}/status": { "get": { "tags": [ "HD wallet", "Manage HD wallet" ], "operationId": "Get HD Wallet Status (xPub, yPub, zPub)", "summary": "Get HD Wallet Status (xPub, yPub, zPub)", "description": "Through this endpoint you can check current status of an HD Wallet by providing blockchain protocol and network.", "x-cost": 10, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "ethereum", "zcash", "ethereum-classic", "binance-smart-chain", "xrp", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "mordor", "nile", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHDWalletStatusXPubYPubZPubR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletStatusXPubYPubZPubE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletStatusXPubYPubZPubE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletStatusXPubYPubZPubE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/manage/{blockchain}/{network}/{extendedPublicKey}/activate": { "post": { "tags": [ "Manage HD wallet" ], "operationId": "Activate HD Wallet (xPub, yPub, zPub)", "summary": "Activate HD Wallet (xPub, yPub, zPub)", "description": "Through this endpoint you can activate a deactivated HD wallet.\r\n\r\n{warning}Any activated HD wallet will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "binance-smart-chain", "bitcoin", "bitcoin-cash", "dash", "dogecoin", "ethereum", "ethereum-classic", "litecoin", "tron", "xrp", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub6C25R29GcNuxTsDMDmkfBXi2eqg6PyAJtSX8EVMK7scsSVrLfHCLK3LtR3GvAgoGe8vJF7R85BbTxGsSSertPTXzJy2EyJWhHvWTrJmZpHa" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub6C25R29GcNuxTsDMDmkfBXi2eqg6PyAJtSX8EVMK7scsSVrLfHCLK3LtR3GvAgoGe8vJF7R85BbTxGsSSertPTXzJy2EyJWhHvWTrJmZpHa" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "testnet", "mordor", "nile", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivateHDWalletXPubYPubZPubRB" } } } }, "responses": { "200": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivateHDWalletXPubYPubZPubR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ActivateHDWalletXPubYPubZPubE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ActivateHDWalletXPubYPubZPubE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ActivateHDWalletXPubYPubZPubE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ActivateHDWalletXPubYPubZPubE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/manage/{blockchain}/{network}/{extendedPublicKey}": { "delete": { "tags": [ "Manage HD wallet" ], "operationId": "Delete Synced HD Wallet (xPub, yPub, zPub)", "summary": "Delete Synced HD Wallet (xPub, yPub, zPub)", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "binance-smart-chain", "bitcoin", "bitcoin-cash", "dash", "dogecoin", "ethereum", "ethereum-classic", "litecoin", "tron", "xrp", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "testnet", "mordor", "nile", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The delete request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSyncedHDWalletXPubYPubZPubR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeleteSyncedHDWalletXPubYPubZPubE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeleteSyncedHDWalletXPubYPubZPubE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeleteSyncedHDWalletXPubYPubZPubE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blockchain-events/{blockchain}/{network}/address-coins-transactions-unconfirmed": { "post": { "tags": [ "Create Subscriptions for" ], "operationId": "New Unconfirmed Coins Transactions", "summary": "New Unconfirmed Coins Transactions", "description": "Through this endpoint customers can create callback subscriptions for a specific event. In this case the event is when there are new unconfirmed coins transactions for the user. By creating this subscription the user will be notified by Crypto APIs 2.0 when that event occurs. The information is returned per specified address.\r\n\r\nUnconfirmed coins transactions remain in the mempool (memory pool) until they are confirmed by miners and added to the next block. Sometimes spikes in transaction activity can cause delays in confirmations.\r\n\r\n{note}For UTXO-based protocols like Bitcoin, a transaction could have multiple inputs and outputs, which means the address could be both sender and recipient.. [Here](https://project-2a14af.doxify.ai/v-1.2021-03-20-111/RESTapis/general-information/callbacks#callback-data-returned-for-utxo-based-transactions) is how we inform you on that.{/note}\r\n\r\n{warning}We cannot guarantee at 100% that webhooks for unconfirmed transactions will always be received. Some may **not get received** due to the possibility of some nodes not being updated with that information. This can occur in networks with low activity and/or not many nodes, e.g. Testnet networks and rarely Mainnets.{/warning}\r\n\r\n{note}To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks [here](https://project-2a14af.doxify.ai/v-1.2021-03-20-111/RESTapis/general-information/callbacks#callback-url).{/note}\r\n\r\n{note}It is also **important to note** that just because pending unconfirmed transactions are in the mempool, **doesn't necessarily** mean they will get confirmed.{/note}\r\n\r\n{warning}Crypto APIs will notify the user **only when** the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification **will not** be sent if the event does not or cannot occur, or will take long time to occur.{/warning}\r\n\r\n{warning}Any new subscriptions will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUnconfirmedCoinsTransactionsRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUnconfirmedCoinsTransactionsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewUnconfirmedCoinsTransactionsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewUnconfirmedCoinsTransactionsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewUnconfirmedCoinsTransactionsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewUnconfirmedCoinsTransactionsE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "ADDRESS_COINS_TRANSACTION_UNCONFIRMED": { "{$request.BODY#/callbackUrl": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressCoinsTransactionUnconfirmed" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } } }, "/blockchain-events/{blockchain}/{network}/address-coins-transactions-confirmed": { "post": { "tags": [ "Create Subscriptions for" ], "operationId": "New Confirmed Coins Transactions", "summary": "New Confirmed Coins Transactions", "description": "Through this endpoint customers can create callback subscriptions for a specific event. In this case the event is when there are new incoming or outgoing confirmed transactions for coins from/to the customer's address. By creating this subscription the user will be notified by Crypto APIs 2.0 when that event occurs. The information is returned per specified address. \r\n\r\nBeing confirmed means that the transactions are verified by miners and added to the next block.\r\n\r\n{note}For UTXO-based protocols like Bitcoin, a transaction could have multiple inputs and outputs, which means the address could be both sender and recipient. [Here](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-data-returned-for-utxo-based-transactions) is how we inform you on that.{/note}\r\n\r\n{note}To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks [here](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-url).{/note}\r\n\r\n{warning}Crypto APIs will notify the user **only when** the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification **will not** be sent if the event does not or cannot occur, or will take long time to occur.{/warning}\r\n\r\n{warning}Any new subscriptions will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "ethereum", "ethereum-classic", "binance-smart-chain", "zcash", "polygon", "tron", "xrp", "tezos", "optimism", "arbitrum", "avalanche", "solana", "base", "kaspa" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "sepolia", "mordor", "amoy", "nile", "ghostnet", "fuji", "devnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewConfirmedCoinsTransactionsRB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewConfirmedCoinsTransactionsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedCoinsTransactionsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedCoinsTransactionsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedCoinsTransactionsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedCoinsTransactionsE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "ADDRESS_COINS_TRANSACTION_CONFIRMED": { "{$request.BODY#/callbackUrl": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressCoinsTransactionConfirmed" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "KASPA_ADDRESS_COINS_TRANSACTION_CONFIRMED": { "{$request.BODY#/callbackUrl": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KaspaAddressCoinsTransactionConfirmed" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } } }, "/blockchain-events/{blockchain}/{network}/address-tokens-transactions-confirmed": { "post": { "tags": [ "Create Subscriptions for" ], "operationId": "New Confirmed Tokens Transactions", "summary": "New Confirmed Tokens Transactions", "description": "Through this endpoint customers can create callback subscriptions for a specific event. In this case the event is when there are new incoming or outgoing confirmed transactions for tokens from/to the customer's address. By creating this subscription the user will be notified by Crypto APIs 2.0 when that event occurs. The information is returned per specified address. \r\n\r\nBeing confirmed means that the transactions are verified by miners and added to the next block. This endpoint refers to **tokens transactions only, not coins**.\r\n\r\n{note}To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks [here](https://app.cryptoapis.io/verify-domain).{/note}\r\n\r\n{warning}Crypto APIs will notify the user **only when** the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification **will not** be sent if the event does not or cannot occur, or will take long time to occur.{/warning}\r\n\r\n{warning}Any new subscriptions will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "polygon", "tron", "optimism", "arbitrum", "avalanche", "solana", "base" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "testnet", "sepolia", "mordor", "amoy", "nile", "fuji", "devnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewConfirmedTokensTransactionsRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewConfirmedTokensTransactionsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedTokensTransactionsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedTokensTransactionsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedTokensTransactionsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedTokensTransactionsE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "ADDRESS_TOKENS_TRANSACTION_CONFIRMED": { "{$request.BODY#/callbackUrl": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressTokensTransactionConfirmed" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } } }, "/blockchain-events/{blockchain}/{network}/address-tokens-transactions-confirmed-each-confirmation": { "post": { "tags": [ "Create Subscriptions for" ], "operationId": "New Confirmed Tokens Transactions And Each Confirmation", "summary": "New Confirmed Tokens Transactions And Each Confirmation", "description": "Through this endpoint customers can create callback subscriptions for a specific event. In this case the event is when there are new incoming or outgoing confirmed transactions for tokens from/to the customer's address with also a response at each confirmation the transaction has received until the specified confirmations limit is reached. By creating this subscription the user will be notified by Crypto APIs 2.0 when that event occurs. The information is returned per specified address. \r\n\r\nBeing confirmed means that the transactions are verified by miners and added to the next block. This endpoint refers to **tokens transactions only, not coins**.\r\n\r\n{note}To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks [here](https://app.cryptoapis.io/verify-domain).{/note}\r\n\r\n{warning}Crypto APIs will notify the user **only when** the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification **will not** be sent if the event does not or cannot occur, or will take long time to occur.{/warning}\r\n\r\n{warning}Any new subscriptions will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "bitcoin", "ethereum", "ethereum-classic", "binance-smart-chain", "polygon", "tron", "optimism", "arbitrum", "avalanche", "base" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "testnet", "sepolia", "mordor", "amoy", "nile", "fuji" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewConfirmedTokensTransactionsAndEachConfirmationRB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewConfirmedTokensTransactionsAndEachConfirmationR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedTokensTransactionsAndEachConfirmationE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedTokensTransactionsAndEachConfirmationE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedTokensTransactionsAndEachConfirmationE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedTokensTransactionsAndEachConfirmationE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "ADDRESS_TOKENS_TRANSACTION_CONFIRMED_EACH_CONFIRMATION": { "{$request.BODY#/callbackUrl": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressTokensTransactionConfirmedEachConfirmation" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } } }, "/blockchain-events/{blockchain}/{network}/address-coins-transactions-confirmed-each-confirmation": { "post": { "tags": [ "Create Subscriptions for" ], "operationId": "New Confirmed Coins Transactions And Each Confirmation", "summary": "New Confirmed Coins Transactions And Each Confirmation", "description": "Through this endpoint customers can create callback subscriptions for a specific event. In this case the event is when there are new incoming or outgoing confirmed transactions for coins from/to the customer's address with also a response at each confirmation the transaction has received until the specified confirmations limit is reached. By creating this subscription the user will be notified by Crypto APIs 2.0 when that event occurs. The information is returned per specified address. \r\n\r\nBeing confirmed means that the transactions are verified by miners and added to the next block. This endpoint refers to **coins transactions only, not tokens**.\r\n\r\n{note}For UTXO-based protocols like Bitcoin, a transaction could have multiple inputs and outputs, which means the address could be both sender and recipient. [Here](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-data-returned-for-utxo-based-transactions) is how we inform you on that.{/note}\r\n\r\n{note}To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks [here](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-url).{/note}\r\n\r\n{warning}Crypto APIs will notify the user **only when** the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification **will not** be sent if the event does not or cannot occur, or will take long time to occur.{/warning}\r\n\r\n{warning}Any new subscriptions will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "ethereum", "ethereum-classic", "binance-smart-chain", "zcash", "polygon", "tron", "xrp", "tezos", "optimism", "arbitrum", "avalanche", "base" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "sepolia", "mordor", "amoy", "nile", "ghostnet", "fuji" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewConfirmedCoinsTransactionsAndEachConfirmationRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewConfirmedCoinsTransactionsAndEachConfirmationR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedCoinsTransactionsAndEachConfirmationE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedCoinsTransactionsAndEachConfirmationE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedCoinsTransactionsAndEachConfirmationE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedCoinsTransactionsAndEachConfirmationE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "ADDRESS_COINS_TRANSACTION_CONFIRMED_EACH_CONFIRMATION": { "{$request.BODY#/callbackUrl": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressCoinsTransactionConfirmedEachConfirmation" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } } }, "/blockchain-events/{blockchain}/{network}/block-mined": { "post": { "tags": [ "Create Subscriptions for" ], "operationId": "New Block", "summary": "New Block", "description": "Through this endpoint customers can create callback subscriptions for a specific event. In this case the event is when a new block is mined in the specific blockchain. By creating this subscription the user will be notified by Crypto APIs 2.0 when that event occurs. The information is returned per specified address.\r\n\r\nA new block is mined when it is added to the chain once a consensus is reached by the majority of the miners, which is when the block gets validated and added to the blockchain.\r\n\r\n{note}To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks [here](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-url).{/note}\r\n\r\n{warning}Crypto APIs will notify the user **only when** the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification **will not** be sent if the event does not or cannot occur, or will take long time to occur.{/warning}\r\n\r\n{warning}Any new subscriptions will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "ethereum", "ethereum-classic", "binance-smart-chain", "zcash", "polygon", "tron", "xrp", "tezos", "optimism", "arbitrum", "avalanche", "solana", "base" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "sepolia", "mordor", "amoy", "nile", "ghostnet", "fuji", "devnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBlockRB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBlockR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewBlockE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewBlockE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewBlockE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewBlockE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "BLOCK_MINED": { "{$request.BODY#/callbackUrl": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMined" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } } }, "/blockchain-events/{blockchain}/{network}": { "get": { "tags": [ "Manage Subscriptions" ], "operationId": "List Blockchain Events Subscriptions", "summary": "List Blockchain Events Subscriptions", "description": "Through this endpoint the customer can obtain a list of their callback subscriptions for the available Blockchain events.\r\n\r\nCurrently Crypto APIs 2.0 offers certain Blockchain event endpoints which allow the user to subscribe for one/a few/all and receive callback notifications when the specific event occurs.\r\n\r\n{note}To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks [here](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-url).{/note}", "x-cost": 30, "x-charge-count": 1, "x-is-list": true, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "ethereum", "ethereum-classic", "binance-smart-chain", "zcash", "polygon", "tron", "xrp", "tezos", "optimism", "arbitrum", "avalanche", "solana", "base", "kaspa" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet", "sepolia", "mordor", "amoy", "nile", "ghostnet", "fuji", "devnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 10 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBlockchainEventsSubscriptionsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListBlockchainEventsSubscriptionsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListBlockchainEventsSubscriptionsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListBlockchainEventsSubscriptionsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blockchain-events/{blockchain}/{network}/{referenceId}": { "get": { "tags": [ "Manage Subscriptions" ], "operationId": "Get Blockchain Event Subscription Details By Reference ID", "summary": "Get Blockchain Event Subscription Details By Reference ID", "description": "Through this endpoint the customer can get detailed information for a callback subscription by providing its reference ID.\r\n\r\nCurrently Crypto APIs 2.0 offers certain Blockchain event endpoints which allow the user to subscribe for one/a few/all and receive callback notifications when the specific event occurs.", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "ethereum", "ethereum-classic", "binance-smart-chain", "zcash", "polygon", "tron", "xrp", "tezos", "optimism", "arbitrum", "avalanche", "solana", "base", "kaspa" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "sepolia", "mordor", "amoy", "nile", "ghostnet", "fuji", "devnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "referenceId", "required": true, "schema": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "bc243c86-0902-4386-b30d-e6b30fa1f2aa" }, "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "bc243c86-0902-4386-b30d-e6b30fa1f2aa" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBlockchainEventSubscriptionDetailsByReferenceIDR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockchainEventSubscriptionDetailsByReferenceIDE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockchainEventSubscriptionDetailsByReferenceIDE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockchainEventSubscriptionDetailsByReferenceIDE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } }, "delete": { "tags": [ "Manage Subscriptions" ], "operationId": "Delete Blockchain Event Subscription", "summary": "Delete Blockchain Event Subscription", "description": "Through this endpoint the customer can delete blockchain event subscriptions they have by attributes `referenceId` and `network`.\r\n\r\nCurrently Crypto APIs 2.0 offers certain Blockchain event endpoints which allow the user to subscribe for one/a few/all and receive callback notifications when the specific event occurs.\r\n\r\n{note}To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks [here](https://project-2a14af.doxify.ai/v-1.2023-04-25-105/RESTapis/general-information/callbacks#callback-url).{/note}\r\n\r\n{warning}Crypto APIs will notify the user **only when** the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification **will not** be sent if the event does not or cannot occur, or will take long time to occur.{/warning}", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "ethereum", "ethereum-classic", "binance-smart-chain", "zcash", "polygon", "tron", "xrp", "tezos", "optimism", "arbitrum", "avalanche", "solana", "base", "kaspa" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet", "sepolia", "mordor", "amoy", "nile", "ghostnet", "fuji", "devnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "path", "name": "referenceId", "required": true, "schema": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "d3fd6a0e-f2b6-4bb5-9fd3-7944bcec9e9f" }, "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "d3fd6a0e-f2b6-4bb5-9fd3-7944bcec9e9f" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The delete request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteBlockchainEventSubscriptionR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeleteBlockchainEventSubscriptionE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeleteBlockchainEventSubscriptionE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeleteBlockchainEventSubscriptionE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blockchain-events/{blockchain}/{network}/{referenceId}/activate": { "post": { "tags": [ "Manage Subscriptions" ], "operationId": "Activate Blockchain Event Subscription", "summary": "Activate Blockchain Event Subscription", "description": "Through this endpoint customers can reactivate an event subscription (callback) which has been deactivated by the system. Deactivations could happen due to various reasons, most often \"maximum retry attempts reached\".\r\n\r\n{warning}Activating subscriptions will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "ethereum", "ethereum-classic", "binance-smart-chain", "zcash", "polygon", "tron", "xrp", "tezos", "optimism", "arbitrum", "avalanche", "solana", "base", "kaspa" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "sepolia", "mordor", "amoy", "nile", "ghostnet", "fuji", "devnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "referenceId", "required": true, "schema": { "type": "string", "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "bc243c86-0902-4386-b30d-e6b30fa1f2aa" }, "description": "Represents a unique ID used to reference the specific callback subscription.", "example": "bc243c86-0902-4386-b30d-e6b30fa1f2aa" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivateBlockchainEventSubscriptionRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivateBlockchainEventSubscriptionR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ActivateBlockchainEventSubscriptionE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ActivateBlockchainEventSubscriptionE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ActivateBlockchainEventSubscriptionE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blockchain-events/{blockchain}/{network}/address-internal-transactions-confirmed": { "post": { "tags": [ "Create Subscriptions for" ], "operationId": "New Confirmed Internal Transactions", "summary": "New Confirmed Internal Transactions", "description": "Through this endpoint customers can create callback subscriptions for a specific event. In this case the event is when there are new confirmed internal transactions. By creating this subscription the user will be notified by Crypto APIs 2.0 when that event occurs.\r\n\r\nBeing confirmed means that the transactions are verified by miners and added to the next block.\r\n\r\n{note}To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks [here](https://project-2a14af.doxify.ai/v-1.2021-03-20-111/RESTapis/general-information/callbacks#callback-url).{/note}\r\n\r\n{warning}Crypto APIs will notify the user **only when** the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification **will not** be sent if the event does not or cannot occur, or will take long time to occur.{/warning}\r\n\r\n{warning}Any new subscriptions will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum-classic", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "polygon", "tron", "optimism", "arbitrum", "avalanche", "base" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum-classic" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "mordor", "enum": [ "mainnet", "testnet", "sepolia", "mordor", "amoy", "nile", "fuji" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "mordor" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewConfirmedInternalTransactionsRB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewConfirmedInternalTransactionsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedInternalTransactionsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedInternalTransactionsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedInternalTransactionsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedInternalTransactionsE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "ADDRESS_INTERNAL_TRANSACTION_CONFIRMED": { "{$request.BODY#/callbackUrl": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressInternalTransactionConfirmed" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } } }, "/blockchain-events/{blockchain}/{network}/address-internal-transactions-confirmed-each-confirmation": { "post": { "tags": [ "Create Subscriptions for" ], "operationId": "New Confirmed Internal Transactions And Each Confirmation", "summary": "New Confirmed Internal Transactions And Each Confirmation", "description": "Through this endpoint customers can create callback subscriptions for a specific event. In this case the event is when there are new confirmed internal transactions. Includes also a response at each confirmation the transaction receives until the specified confirmations limit is reached. By creating this subscription the user will be notified by Crypto APIs 2.0 when that event occurs. \r\n\r\nBeing confirmed means that the transactions are verified by miners and added to the next block.\r\n\r\n{note}To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks [here](https://project-2a14af.doxify.ai/v-1.2021-03-20-111/RESTapis/general-information/callbacks#callback-url).{/note}\r\n\r\n{warning}Crypto APIs will notify the user **only when** the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification **will not** be sent if the event does not or cannot occur, or will take long time to occur.{/warning}\r\n\r\n{warning}Any new subscriptions will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum-classic", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "polygon", "tron", "optimism", "arbitrum", "avalanche", "base" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum-classic" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "mordor", "enum": [ "mainnet", "testnet", "sepolia", "mordor", "amoy", "nile", "fuji" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "mordor" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewConfirmedInternalTransactionsAndEachConfirmationRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewConfirmedInternalTransactionsAndEachConfirmationR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedInternalTransactionsAndEachConfirmationE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedInternalTransactionsAndEachConfirmationE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedInternalTransactionsAndEachConfirmationE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NewConfirmedInternalTransactionsAndEachConfirmationE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "ADDRESS_INTERNAL_TRANSACTION_CONFIRMED_EACH_CONFIRMATION": { "{$request.BODY#/callbackUrl": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressInternalTransactionConfirmedEachConfirmation" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } } }, "/market-data/metadata/assets": { "get": { "tags": [ "Metadata" ], "operationId": "List Supported Assets", "summary": "List Supported Assets", "description": "This endpoint will return a list of supported assets. The asset could be a cryptocurrency or FIAT assets that we support. Each asset has a unique identifier - `assetId` and a unique symbol in the form of a string, e.g. \"BTC\".", "x-cost": 20, "x-charge-count": 1, "x-is-list": true, "parameters": [ { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, { "in": "query", "name": "type", "required": false, "schema": { "type": "string", "description": "Defines the type of the supported asset. This could be either \"crypto\" or \"fiat\".", "example": "crypto", "enum": [ "fiat", "crypto" ] }, "description": "Defines the type of the supported asset. This could be either \"crypto\" or \"fiat\".", "example": "crypto" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSupportedAssetsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSupportedAssetsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSupportedAssetsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSupportedAssetsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/market-data/exchange-rates/by-symbol/{fromAssetSymbol}/{toAssetSymbol}": { "get": { "tags": [ "Exchange Rates" ], "operationId": "Get Exchange Rate By Asset Symbols", "summary": "Get Exchange Rate By Asset Symbols", "description": "Through this endpoint customers can obtain exchange rates by asset symbols. The process represents the exchange rate value of a single unit of one asset versus another one. Data is provided per unique asset symbol.", "x-cost": 270, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "fromAssetSymbol", "required": true, "schema": { "type": "string", "description": "Defines the base asset symbol to get a rate for.", "example": "btc" }, "description": "Defines the base asset symbol to get a rate for.", "example": "btc" }, { "in": "path", "name": "toAssetSymbol", "required": true, "schema": { "type": "string", "description": "Defines the relation asset symbol in which the base asset rate will be displayed.", "example": "usd" }, "description": "Defines the relation asset symbol in which the base asset rate will be displayed.", "example": "usd" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "calculationTimestamp", "required": false, "schema": { "type": "integer", "description": "Defines the time of the market data used to calculate the exchange rate in UNIX Timestamp. Oldest possible timestamp is 30 days.", "example": 1635514425 }, "description": "Defines the time of the market data used to calculate the exchange rate in UNIX Timestamp. Oldest possible timestamp is 30 days.", "example": 1635514425 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExchangeRateByAssetSymbolsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetExchangeRateByAssetSymbolsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetExchangeRateByAssetSymbolsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetExchangeRateByAssetSymbolsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "422", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetExchangeRateByAssetSymbolsE422" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/market-data/exchange-rates/by-id/{fromAssetId}/{toAssetId}": { "get": { "tags": [ "Exchange Rates" ], "operationId": "Get Exchange Rate By Assets IDs", "summary": "Get Exchange Rate By Assets IDs", "description": "Through this endpoint customers can obtain exchange rates by asset IDs. The process represents the exchange rate value of a single unit of one asset versus another one. Data is provided per unique asset Reference ID.", "x-cost": 270, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "fromAssetId", "required": true, "schema": { "type": "string", "description": "Defines the base asset Reference ID to get a rate for.", "example": "5b1ea92e584bf50020130612" }, "description": "Defines the base asset Reference ID to get a rate for.", "example": "5b1ea92e584bf50020130612" }, { "in": "path", "name": "toAssetId", "required": true, "schema": { "type": "string", "description": "Defines the relation asset Reference ID in which the base asset rate will be displayed.", "example": "5b1ea92e584bf50020130615" }, "description": "Defines the relation asset Reference ID in which the base asset rate will be displayed.", "example": "5b1ea92e584bf50020130615" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "calculationTimestamp", "required": false, "schema": { "type": "integer", "description": "Defines the time of the market data used to calculate the exchange rate in UNIX Timestamp. Oldest possible timestamp is 30 days.", "example": 1618577849 }, "description": "Defines the time of the market data used to calculate the exchange rate in UNIX Timestamp. Oldest possible timestamp is 30 days.", "example": 1618577849 } ], "responses": { "200": { "description": "The request has been successfull.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExchangeRateByAssetsIDsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetExchangeRateByAssetsIDsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetExchangeRateByAssetsIDsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetExchangeRateByAssetsIDsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "422", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetExchangeRateByAssetsIDsE422" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-historical/manage/{blockchain}/{network}": { "post": { "tags": [ "Address History", "Manage addresses" ], "operationId": "Sync Address", "summary": "Sync Address", "description": "Through this endpoint, users can synchronize a specific address with Crypto APIs. Once the synchronization is complete, users will have access to the full historical data associated with the address.\r\n\r\n{warning}Any address sent for syncing will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "example": "ethereum", "default": "ethereum", "enum": [ "polygon", "ethereum", "dash", "tron", "dogecoin", "litecoin", "zcash", "bitcoin-cash", "bitcoin", "ethereum-classic", "binance-smart-chain" ] }, "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "example": "sepolia", "enum": [ "mainnet", "sepolia", "amoy", "testnet", "nile", "mordor" ] }, "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncAddressRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncAddressR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncAddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncAddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncAddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncAddressE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "ADDRESS_SYNC_STATUS": { "{$request.BODY#/callbackUrl": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressSyncStatus" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } }, "get": { "tags": [ "Address History", "Manage addresses" ], "operationId": "List Synced Addresses", "summary": "List Synced Addresses", "description": "Through this endpoint, users can retrieve a comprehensive list of all addresses synced with Crypto APIs, including their synchronization status and any associated data available for tracking and operations.", "x-cost": 30, "x-charge-count": 1, "x-is-list": true, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "example": "polygon", "enum": [ "polygon", "ethereum", "dash", "tron", "dogecoin", "litecoin", "zcash", "bitcoin-cash", "bitcoin", "ethereum-classic", "binance-smart-chain" ] }, "example": "polygon" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "example": "mainnet", "enum": [ "mainnet", "sepolia", "amoy", "testnet", "nile", "mordor" ] }, "example": "mainnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 10 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSyncedAddressesR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressesE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressesE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressesE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/market-data/assets/by-id/{assetId}": { "get": { "tags": [ "Assets" ], "operationId": "Get Asset Details By Asset ID", "summary": "Get Asset Details By Asset ID", "description": "Through this endpoint users can obtain information on assets by `assetId`.\r\n\r\nThe details returned could include information on the latest rate and rate fluctuation of different periods of time - 24 hours, a week, one hour, the encoding of the logo, and more.", "x-cost": 110, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "assetId", "required": true, "schema": { "type": "string", "description": "Defines the unique ID of the specific asset.", "example": "5b1ea92e584bf50020130612" }, "description": "Defines the unique ID of the specific asset.", "example": "5b1ea92e584bf50020130612" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAssetDetailsByAssetIDR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAssetDetailsByAssetIDE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAssetDetailsByAssetIDE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAssetDetailsByAssetIDE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/market-data/assets/by-symbol/{assetSymbol}": { "get": { "tags": [ "Assets" ], "operationId": "Get Asset Details By Asset Symbol", "summary": "Get Asset Details By Asset Symbol", "description": "Through this endpoint users can obtain information on assets by asset symbol.\r\n\r\nThe details returned could include information on the latest rate and rate fluctuation of different periods of time - 24 hours, a week, one hour, the encoding of the logo, and more.", "x-cost": 110, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "assetSymbol", "required": true, "schema": { "type": "string", "description": "Specifies the asset's unique symbol in the Crypto APIs listings.", "example": "BTC" }, "description": "Specifies the asset's unique symbol in the Crypto APIs listings.", "example": "BTC" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAssetDetailsByAssetSymbolR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAssetDetailsByAssetSymbolE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAssetDetailsByAssetSymbolE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAssetDetailsByAssetSymbolE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-historical/manage/{blockchain}/{network}/{address}/activate": { "post": { "tags": [ "Address History", "Manage addresses" ], "operationId": "Activate Synced Address", "summary": "Activate Synced Address", "description": "Through this endpoint, users can activate a previously synced address with Crypto APIs. Once activated, the address will resume tracking, and any new or missing data associated with it will be synchronized and made available for further operations.", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0x3d0b25fe09e2cd92f06ba776391a122519936e90" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0x3d0b25fe09e2cd92f06ba776391a122519936e90" }, { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "polygon", "ethereum", "dash", "tron", "dogecoin", "litecoin", "zcash", "bitcoin-cash", "bitcoin", "ethereum-classic", "binance-smart-chain" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data", "example": "sepolia", "enum": [ "mainnet", "sepolia", "mumbai", "amoy", "testnet", "nile", "mordor" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivateSyncedAddressRB" } } } }, "responses": { "201": { "description": "Successfull Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivateSyncedAddressR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ActivateSyncedAddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ActivateSyncedAddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ActivateSyncedAddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ActivateSyncedAddressE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-historical/manage/{blockchain}/{network}/{address}": { "delete": { "tags": [ "Manage addresses" ], "operationId": "Delete Synced Address", "summary": "Delete Synced Address", "description": "Through this endpoint, users can delete a previously synced address from Crypto APIs. Once deleted, the address will no longer be tracked, and its associated historical data will not be accessible until it is resynced.", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "parameters": [ { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "0x8FafAE7Dd957044088b3d0F67359C327c6200d18" }, "example": "0x8FafAE7Dd957044088b3d0F67359C327c6200d18" }, { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "example": "ethereum", "default": "ethereum", "enum": [ "polygon", "ethereum", "dash", "tron", "dogecoin", "litecoin", "zcash", "bitcoin-cash", "bitcoin", "ethereum-classic", "binance-smart-chain" ] }, "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "example": "mainnet", "default": "mainnet", "enum": [ "mainnet", "sepolia", "mumbai", "amoy", "testnet", "nile", "mordor" ] }, "example": "mainnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The delete request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSyncedAddressR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeleteSyncedAddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeleteSyncedAddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeleteSyncedAddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeleteSyncedAddressE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-historical/utxo/{blockchain}/{network}/{address}/unspent-outputs": { "get": { "tags": [ "Address history UTXOs" ], "operationId": "List Unspent Transaction Outputs By Address UTXOs", "summary": "List Unspent Transaction Outputs By Address UTXOs", "description": "Through this endpoint customers can list their transactions' unspent outputs by `address`.", "x-cost": 530, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Bitcoin": 530, "Bitcoin Cash": 689, "Dash": 583, "Dogecoin": 583, "Litecoin": 583, "Zcash": 689 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dash", "dogecoin", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "testnet", "mainnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the address that has unspend funds per which the result is returned.", "example": "2MtzNEqm2D9jcbPJ5mW7Z3AUNwqt3afZH66" }, "description": "Represents the address that has unspend funds per which the result is returned.", "example": "2MtzNEqm2D9jcbPJ5mW7Z3AUNwqt3afZH66" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUnspentTransactionOutputsByAddressUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListUnspentTransactionOutputsByAddressUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListUnspentTransactionOutputsByAddressUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListUnspentTransactionOutputsByAddressUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "405": { "description": "The specified address is not active. Please, activate your address in order to be able to obtain information from this endpoint.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncAddressNotActive" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/simulate-transactions/evm/ethereum/{network}": { "post": { "tags": [ "Simulate Transactions EVM" ], "operationId": "Simulate Ethereum Transactions", "summary": "Simulate Ethereum Transactions", "description": "Through this endpoint the customer can Simulate transactions and know in advance how they will behave onchain without paying a on chain fee.", "x-cost": 110, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 110, "Ethereum Classic": 143, "Binance Smart Chain": 275, "Polygon": 220, "Arbitrum": 176, "Аvalanche": 198, "Base": 132, "Optimism": 154, "Tron": 165, "Solana": 330, "XRP": 110, "Tezos": 143, "Bitcoin": 110, "Bitcoin Cash": 132, "Dash": 121, "Dogecoin": 121, "Litecoin": 121, "Zcash": 143, "Kaspa": 198 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "sepolia", "mainnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulateEthereumTransactionsRB" } } } }, "responses": { "201": { "description": "Successful transaction result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulateEthereumTransactionsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SimulateEthereumTransactionsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SimulateEthereumTransactionsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SimulateEthereumTransactionsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/utils/bitcoin-cash/{network}/convert-address": { "post": { "tags": [ "Utils", "Tools" ], "operationId": "Convert Bitcoin Cash Address", "summary": "Convert Bitcoin Cash Address", "description": "Through this endpoint customers will be able to convert addresses for the BCH (Bitcoin Cash) protocol from BCH legacy to cash address and vice versa.", "x-cost": 10, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin Cash": 12 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin-cash", "default": "bitcoin-cash", "enum": [ "bitcoin-cash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin-cash" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertBitcoinCashAddressRB" } } } }, "responses": { "201": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertBitcoinCashAddressR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ConvertBitcoinCashAddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ConvertBitcoinCashAddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ConvertBitcoinCashAddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-historical/evm/{blockchain}/{network}/{address}/tokens": { "get": { "tags": [ "Address history EVM" ], "operationId": "List Tokens By Address Synced EVM", "summary": "List Tokens By Address Synced EVM", "description": "Through this endpoint customers can obtain token data by providing an attribute - address. The information that can be returned can include the contract address, the token symbol, type and balance.", "x-cost": 230, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 230, "Ethereum Classic": 299, "Binance Smart Chain": 575, "Polygon": 460, "Tron": 345 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "example": "ethereum", "enum": [ "polygon", "tron", "ethereum", "ethereum-classic", "binance-smart-chain" ] }, "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "example": "sepolia", "enum": [ "amoy", "mainnet", "nile", "sepolia", "mordor", "testnet" ] }, "example": "sepolia" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "String identifier of the address", "example": "0x935ba3DED4074903e6854424235772e4Db862af5" }, "description": "String identifier of the address", "example": "0x935ba3DED4074903e6854424235772e4Db862af5" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successfull.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTokensByAddressSyncedEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTokensByAddressSyncedEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTokensByAddressSyncedEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTokensByAddressSyncedEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "405": { "description": "The specified address is not active. Please, activate your address in order to be able to obtain information from this endpoint.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncAddressNotActive" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/xrp/{network}/{address}/balance": { "get": { "tags": [ "Address latest XRP" ], "operationId": "Get Address Balance XRP", "summary": "Get Address Balance XRP", "description": "Through this endpoint the customer can receive the balance of a given address based on confirmed/synced blocks only. In the case where there are any incoming or outgoing unconfirmed transactions for the specific address, they will not be counted or calculated here. Applies only for coins.", "x-cost": 20, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "XRP": 20 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAddressBalanceXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-historical/utxo/{blockchain}/{network}/{address}/transactions/from-timestamp/{timestamp}": { "get": { "tags": [ "Address history UTXOs" ], "operationId": "List Confirmed Transactions By Address By Timestamp UTXO Historical", "summary": "List Confirmed Transactions By Address By Timestamp UTXO Historical", "description": "This endpoint will list transactions by an attribute `address`. The transactions listed will detail additional information such as hash, height, time of creation in Unix timestamp, etc.", "x-cost": 530, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Bitcoin": 530, "Bitcoin Cash": 689, "Dash": 583, "Dogecoin": 583, "Litecoin": 583, "Zcash": 689 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Bitcoin, Bitcoin Cash.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Bitcoin, Bitcoin Cash.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is test network.", "example": "testnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38" }, { "in": "path", "name": "timestamp", "required": true, "schema": { "type": "integer", "description": "Numeric representation of the starting unix timestamp in seconds since epoch", "example": 1756452184 }, "description": "Numeric representation of the starting unix timestamp in seconds since epoch", "example": 1756452184 }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50, "max": 500 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "sortingOrder", "required": false, "schema": { "type": "string", "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressByTimestampUTXOHistoricalR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressByTimestampUTXOHistoricalE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressByTimestampUTXOHistoricalE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressByTimestampUTXOHistoricalE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "405": { "description": "The specified address is not active. Please, activate your address in order to be able to obtain information from this endpoint.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncAddressNotActive" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-historical/evm/{blockchain}/{network}/{address}/transactions": { "get": { "tags": [ "Address history EVM" ], "operationId": "List Confirmed Transactions By Address EVM history", "summary": "List Confirmed Transactions By Address EVM history", "description": "This endpoint will list transactions by an attribute `address`. The transactions listed will detail additional information such as hash, height, time of creation in Unix timestamp, etc.", "x-cost": 130, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 130, "Ethereum Classic": 169, "Binance Smart Chain": 325, "Polygon": 260, "Tron": 195 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum-classic", "ethereum", "binance-smart-chain", "polygon", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mordor", "mainnet", "testnet", "sepolia", "amoy", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0xc8c960a01ac67c5e1424f7d5afb08a625aff9076" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0xc8c960a01ac67c5e1424f7d5afb08a625aff9076" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "sortingOrder", "required": false, "schema": { "type": "string", "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressEVMHistoryR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressEVMHistoryE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressEVMHistoryE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressEVMHistoryE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "405": { "description": "The specified address is not active. Please, activate your address in order to be able to obtain information from this endpoint.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncAddressNotActive" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/utxo/{blockchain}/{network}/{address}/balance": { "get": { "tags": [ "Address latest UTXOs" ], "operationId": "Get Address Balance UTXOs", "summary": "Get Address Balance UTXOs", "description": "Through this endpoint the customer can receive the balance of a given address based on confirmed/synced blocks only. In the case where there are any incoming or outgoing unconfirmed transactions for the specific address, they will not be counted or calculated here. Applies only for coins.", "x-cost": 510, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 510, "Bitcoin Cash": 612, "Dash": 561, "Dogecoin": 561, "Litecoin": 561, "Zcash": 663 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dash", "dogecoin", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "bc1pp7w6kxnj7lzgm29pmuhezwl0vjdlcrthqukll5gn9xuqfq5n673smy4m63" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "bc1pp7w6kxnj7lzgm29pmuhezwl0vjdlcrthqukll5gn9xuqfq5n673smy4m63" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAddressBalanceUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/evm/{blockchain}/{network}/{address}/balance": { "get": { "tags": [ "Address latest EVM" ], "operationId": "Get Address Balance EVM", "summary": "Get Address Balance EVM", "description": "Through this endpoint the customer can receive the balance of a given address based on confirmed/synced blocks only. In the case where there are any incoming or outgoing unconfirmed transactions for the specific address, they will not be counted or calculated here. Applies only for coins.", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 30, "Ethereum Classic": 39, "Binance Smart Chain": 75, "Polygon": 60, "Arbitrum": 48, "Аvalanche": 54, "Base": 36, "Optimism": 42, "Tron": 45 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "tron", "polygon", "avalanche", "arbitrum", "base", "optimism" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "mordor", "testnet", "nile", "sepolia", "amoy", "fuji" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAddressBalanceEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/solana/{network}/{address}/balance": { "get": { "tags": [ "Address latest Solana" ], "operationId": "Get Address Balance Solana", "summary": "Get Address Balance Solana", "description": "Through this endpoint the customer can receive the balance of a given address based on confirmed/synced blocks only. In the case where there are any incoming or outgoing unconfirmed transactions for the specific address, they will not be counted or calculated here. Applies only for coins.", "x-cost": 25, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Solana": 75 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software", "example": "devnet", "enum": [ "mainnet", "devnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software", "example": "devnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "DCAKxn5PFNN1mBREPWGdk1RXg5aVH9rPErLfBFEi2Emb" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "DCAKxn5PFNN1mBREPWGdk1RXg5aVH9rPErLfBFEi2Emb" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "Represents the public address, which is a compressed and shortened form of a public key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAddressBalanceSolanaR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceSolanaE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceSolanaE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceSolanaE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/contracts/solana/{network}/{contractAddress}/token-details": { "get": { "tags": [ "Contracts Solana" ], "operationId": "Get Token Details by Contract Address Solana", "summary": "Get Token Details by Contract Address Solana", "description": "Though this endpoint customers can obtain information about token details. This can be done by providing the `contact address` parameter.", "x-cost": 105, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Solana": 315 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software", "example": "devnet", "enum": [ "mainnet", "devnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software", "example": "devnet" }, { "in": "path", "name": "contractAddress", "required": true, "schema": { "type": "string", "description": "Defines the specific address of the contract.", "example": "Dn4noZ5jgGfkntzcQSUZ8czkreiZ1ForXYoV2H8Dm7S1" }, "description": "Defines the specific address of the contract.", "example": "Dn4noZ5jgGfkntzcQSUZ8czkreiZ1ForXYoV2H8Dm7S1" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTokenDetailsByContractAddressSolanaR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTokenDetailsByContractAddressSolanaE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTokenDetailsByContractAddressSolanaE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTokenDetailsByContractAddressSolanaE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified token details has not been found on the specific blockchain.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BlockchainDataTokenDetailsNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/xrp/{network}/height/{blockHeight}/details": { "get": { "tags": [ "Blocks XRP" ], "operationId": "Get Block Details By Block Height XRP", "summary": "Get Block Details By Block Height XRP", "description": "Through this endpoint customers can obtain basic information about a given XRP block (a block on the XRP blockchain), specifically by using the `height` parameter. These block details could include the hash of the specific, the previous and the next block, its transactions count, etc.\r\n\r\nSince XRP is a different blockchain than Bitcoin and Ethereum, it isn't unified.", "x-cost": 20, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "XRP": 20 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "path", "name": "blockHeight", "required": true, "schema": { "type": "string", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": "15886156" }, "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": "15886156" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/utxo/{blockchain}/{network}/height/{blockHeight}/transactions": { "get": { "tags": [ "Blocks UTXOs" ], "operationId": "List Transactions by Block Height UTXOs", "summary": "List Transactions by Block Height UTXOs", "description": "This endpoint will list transactions by an attribute `blockHeight`. The transactions listed will detail additional information such as hash, addresses, time of creation in Unix timestamp, etc.", "x-cost": 20, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Bitcoin": 20, "Bitcoin Cash": 24, "Dash": 22, "Dogecoin": 22, "Litecoin": 22, "Zcash": 26 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "dash", "dogecoin", "litecoin", "bitcoin-cash", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "blockHeight", "required": true, "schema": { "type": "integer", "format": "int64", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 673852, "default": 673852 }, "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 673852 }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-historical/evm/{blockchain}/{network}/{address}/transactions/from-timestamp/{timestamp}": { "get": { "tags": [ "Address history EVM" ], "operationId": "List Confirmed Transactions By Address From Timestamp EVM history", "summary": "List Confirmed Transactions By Address From Timestamp EVM history", "description": "This endpoint will list transactions by an attribute `address` and `timestamp`. The `timestamp` is used as a starting point. Default ordering is from old to new and can be changed with optional query parameter `sortingOrder`. The transactions listed will detail additional information such as hash, height, time of creation in Unix timestamp, etc.", "x-cost": 230, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 230, "Ethereum Classic": 299, "Binance Smart Chain": 575, "Polygon": 460, "Tron": 345 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Ethereum Classic.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Ethereum Classic.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"sepolia\" and \"mordor\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "sepolia", "mordor" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"sepolia\" and \"mordor\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0xc8c960a01ac67c5e1424f7d5afb08a625aff9076" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0xc8c960a01ac67c5e1424f7d5afb08a625aff9076" }, { "in": "path", "name": "timestamp", "required": true, "schema": { "type": "integer", "description": "Numeric representation of the starting timestamp in seconds since Unix epoch.", "example": 1760005504 }, "description": "Numeric representation of the starting timestamp in seconds since Unix epoch.", "example": 1760005504 }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 500 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "sortingOrder", "required": false, "schema": { "type": "string", "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressFromTimestampEVMHistoryR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressFromTimestampEVMHistoryE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressFromTimestampEVMHistoryE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressFromTimestampEVMHistoryE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "405": { "description": "The specified address is not active. Please, activate your address in order to be able to obtain information from this endpoint.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncAddressNotActive" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/kaspa/{network}/{address}/transactions": { "get": { "tags": [ "Address latest Kaspa" ], "operationId": "List Confirmed Transactions By Address Kaspa", "summary": "List Confirmed Transactions By Address Kaspa", "description": "This endpoint will list transactions by an attribute `address`. The transactions listed will detail additional information such as hash, time of creation in Unix timestamp, etc.", "x-cost": 510, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Kaspa": 918 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "mainnet", "enum": [ "mainnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "mainnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "String representation of the address", "example": "kaspa:qpamkvhgh0kzx50gwvvp5xs8ktmqutcy3dfs9dc3w7lm9rq0zs76vf959mmrp" }, "description": "String representation of the address", "example": "kaspa:qpamkvhgh0kzx50gwvvp5xs8ktmqutcy3dfs9dc3w7lm9rq0zs76vf959mmrp" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressKaspaR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressKaspaE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressKaspaE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressKaspaE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/xrp/{network}/hash/{blockHash}/transactions": { "get": { "tags": [ "Blocks XRP" ], "operationId": "List Transactions By Block Hash XRP", "summary": "List Transactions By Block Hash XRP", "description": "This endpoint will list transactions by an attribute `blockHash`. The transactions listed will detail additional information such as hash, addresses, time of creation in Unix timestamp, etc.\r\n\r\nSince XRP is a different blockchain than Bitcoin and Ethereum, it isn't unified.", "x-cost": 20, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "XRP": 20 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "path", "name": "blockHash", "required": true, "schema": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "14754656235f865a74eba27791fd41a47bdfe07fe811ff6d78f53db32e129e39" }, "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "14754656235f865a74eba27791fd41a47bdfe07fe811ff6d78f53db32e129e39" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsByBlockHashXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHashXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHashXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHashXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/evm/{blockchain}/{network}/latest/details": { "get": { "tags": [ "Blocks EVM" ], "operationId": "Get Last Mined Block EVM", "summary": "Get Last Mined Block EVM", "description": "Through this endpoint customers can fetch the last mined block in a specific blockchain network, along with its details. These could include the hash of the specific, the previous and the next block, its transactions count, its height, etc. \r\n\r\nBlockchain specific data is information such as version, nonce, size, bits, merkleroot, etc.", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 30, "Ethereum Classic": 39, "Binance Smart Chain": 75, "Polygon": 60, "Arbitrum": 48, "Аvalanche": 54, "Base": 36, "Optimism": 42, "Tron": 45 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "tron", "binance-smart-chain" ] }, "description": "Represents the specific blockchain protocol name", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used", "example": "sepolia", "enum": [ "mainnet", "mordor", "nile", "testnet", "sepolia" ] }, "description": "Represents the name of the blockchain network used", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLastMinedBlockEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetLastMinedBlockEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetLastMinedBlockEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetLastMinedBlockEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified block has not been found on the specific blockchain.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BlockchainDataBlockNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/xrp/{network}/hash/{blockHash}/details": { "get": { "tags": [ "Blocks XRP" ], "operationId": "Get Block Details By Block Hash XRP", "summary": "Get Block Details By Block Hash XRP", "description": "Through this endpoint customers can obtain basic information about a given XRP block (a block on the XRP blockchain), specifically by using the `hash` parameter. These block details could include the hash of the specific, the previous and the next block, the number of included transactions, etc. \r\n\r\nSince XRP is a different blockchain than Bitcoin and Ethereum, it isn't unified.", "x-cost": 20, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "XRP": 20 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "path", "name": "blockHash", "required": true, "schema": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "1ab0614d2a438da8b23086cbceef7d443edbd295d9c7619fc8a19c7618bc22c9" }, "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "1ab0614d2a438da8b23086cbceef7d443edbd295d9c7619fc8a19c7618bc22c9" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/xrp/{network}/latest": { "get": { "tags": [ "Blocks XRP" ], "operationId": "List Latest Mined Blocks XRP", "summary": "List Latest Mined Blocks XRP", "description": "Through this endpoint customers can list **up to 50** from the latest blocks that were mined.", "x-cost": 20, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "XRP": 20 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\"", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\"", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "count", "required": false, "schema": { "type": "string", "description": "Specifies how many records were requested.", "default": "10" }, "description": "Specifies how many records were requested." } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLatestMinedBlocksXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListLatestMinedBlocksXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListLatestMinedBlocksXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListLatestMinedBlocksXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/utxo/{blockchain}/{network}/latest": { "get": { "tags": [ "Blocks UTXOs" ], "operationId": "List Latest Mined Blocks UTXOs", "summary": "List Latest Mined Blocks UTXOs", "description": "Through this endpoint customers can list **up to 50** from the latest blocks that were mined.", "x-cost": 20, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Bitcoin": 20, "Bitcoin Cash": 24, "Dash": 22, "Dogecoin": 22, "Litecoin": 22, "Zcash": 26 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\"", "example": "testnet", "enum": [ "testnet", "mainnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\"", "example": "testnet" }, { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dash", "dogecoin", "zcash" ] }, "description": "Represents the specific blockchain protocol name", "example": "bitcoin" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "count", "required": false, "schema": { "type": "integer", "description": "Specifies how many records were requested.", "example": 2, "default": 10 }, "description": "Specifies how many records were requested.", "example": 2 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLatestMinedBlocksUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListLatestMinedBlocksUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListLatestMinedBlocksUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListLatestMinedBlocksUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/evm/{blockchain}/{network}/height/{blockHeight}/details": { "get": { "tags": [ "Blocks EVM" ], "operationId": "Get Block Details By Block Height EVM", "summary": "Get Block Details By Block Height EVM", "description": "Through this endpoint customers can obtain basic information about a given mined block, specifically by using the `height` parameter. These block details could include the hash of the specific, the previous and the next block, its transactions count, its height, etc. \r\n\r\nBlockchain specific data is information such as version, nonce, size, bits, merkleroot, etc.", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 30, "Ethereum Classic": 39, "Binance Smart Chain": 75, "Polygon": 60, "Arbitrum": 48, "Аvalanche": 54, "Base": 36, "Optimism": 42, "Tron": 45 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "tron" ] }, "description": "Represents the specific blockchain protocol name", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used.", "example": "sepolia", "enum": [ "mainnet", "mordor", "testnet", "sepolia", "nile" ] }, "description": "Represents the name of the blockchain network used.", "example": "sepolia" }, { "in": "path", "name": "blockHeight", "required": true, "schema": { "type": "integer", "format": "int64", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 673852 }, "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 673852 }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified block has not been found on the specific blockchain.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BlockchainDataBlockNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/xrp/{network}/{address}/transactions": { "get": { "tags": [ "Address latest XRP" ], "operationId": "List Transactions by Address XRP", "summary": "List Transactions by Address XRP", "description": "This endpoint will list XRP transactions by a attribute `address`. The transactions listed will detail additional information such as hash, height, time of creation in Unix timestamp, etc.\r\n\r\n{note}Please note that retrieving data will provide the most recent 14 days (1,209,600 seconds) of transactions from the current moment. To access the full historical data, please refer to the Address History APIs.{/note}", "x-cost": 110, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "XRP": 110 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "sortingOrder", "required": false, "schema": { "type": "string", "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, { "in": "query", "name": "transactionType", "required": false, "schema": { "type": "string", "example": "payment", "enum": [ "account-set", "account-delete", "check-cancel", "check-cash", "check-create", "deposit-preauth", "escrow-cancel", "escrow-create", "escrow-finish", "offer-cancel", "offer-create", "payment", "payment-channel-claim", "payment-channel-create", "payment-channel-fund", "set-regular-key", "signer-list-set", "ticket-create", "trust-set" ] }, "example": "payment" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsByAddressXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByAddressXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByAddressXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByAddressXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/utxo/{blockchain}/{network}/hash/{blockHash}/transactions": { "get": { "tags": [ "Blocks UTXOs" ], "operationId": "List Transactions by Block Hash UTXOs", "summary": "List Transactions by Block Hash UTXOs", "description": "This endpoint will list transactions by an attribute `transactionHash`. The transactions listed will detail additional information such as addresses, height, time of creation in Unix timestamp, etc.", "x-cost": 20, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Bitcoin": 20, "Bitcoin Cash": 24, "Dash": 22, "Dogecoin": 22, "Litecoin": 22, "Zcash": 26 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "testnet", "mainnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "blockHash", "required": true, "schema": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "00000000000000127080d8bcf84f4ad830a71ea0aadce3632579b6b2f26cd94b" }, "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "00000000000000127080d8bcf84f4ad830a71ea0aadce3632579b6b2f26cd94b" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsByBlockHashUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHashUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHashUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHashUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/evm/{blockchain}/{network}/{address}/next-available-nonce": { "get": { "tags": [ "Address latest EVM" ], "operationId": "Get Next Available Nonce EVM", "summary": "Get Next Available Nonce EVM", "description": "Through this endpoint customers can get information about the next available nonce by providing the specific blockchain, network and address.", "x-cost": 20, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 20, "Ethereum Classic": 26, "Binance Smart Chain": 50, "Polygon": 40, "Arbitrum": 32, "Аvalanche": 36, "Base": 24, "Optimism": 28, "Tron": 30 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "mordor", "testnet", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNextAvailableNonceEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetNextAvailableNonceEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetNextAvailableNonceEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetNextAvailableNonceEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/evm/{blockchain}/{network}/{address}/internal-transactions": { "get": { "tags": [ "Address latest EVM" ], "operationId": "List Internal Transactions By Address EVM", "summary": "List Internal Transactions By Address EVM", "description": "Through this endpoint customers can list internal transactions by the `address` attribute.\r\n\r\n{note}Please note that retrieving data will provide the most recent 14 days (1,209,600 seconds) of transactions from the current moment. To access the full historical data, please refer to the Address History APIs.{/note}", "x-cost": 320, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 320, "Ethereum Classic": 416, "Binance Smart Chain": 800, "Polygon": 640, "Arbitrum": 512, "Аvalanche": 576, "Base": 384, "Optimism": 448, "Tron": 480 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "polygon", "avalanche", "arbitrum", "base", "optimism", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "mordor", "testnet", "sepolia", "amoy", "fuji", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "String identifier of the address document represented in CryptoAPIs", "example": "0x3d0b25fe09e2cd92f06ba776391a122519936e90" }, "description": "String identifier of the address document represented in CryptoAPIs", "example": "0x3d0b25fe09e2cd92f06ba776391a122519936e90" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "sortingOrder", "required": false, "schema": { "type": "string", "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInternalTransactionsByAddressEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListInternalTransactionsByAddressEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListInternalTransactionsByAddressEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListInternalTransactionsByAddressEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/evm/{blockchain}/{network}/{extendedPublicKey}/transactions/prepare": { "post": { "tags": [ "HD Wallet Data EVM" ], "operationId": "Prepare A Transaction From an Address in HD Wallet (xPub, yPub, zPub) EVM", "summary": "Prepare A Transaction From an Address in HD Wallet (xPub, yPub, zPub) EVM", "description": "Through the “Prepare an account-based transaction from xPub” endpoint users can prepare a transaction for signing from a synced with Crypto APIs address from the specific xPub. This endpoint applies to all supported account-based blockchain protocols, e.g. Ethereum, BSC, etc", "x-cost": 130, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 130, "Ethereum Classic": 169, "Binance Smart Chain": 325, "Tron": 195 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "binance-smart-chain", "ethereum-classic", "ethereum" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\" are test networks.", "example": "sepolia", "enum": [ "testnet", "mainnet", "mordor", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub6CsGdqTDEVRnLmpWN218HBwJqfhqSx46iA8ByzEA5Bz9jfwU3TSg9U7ambKgJyykvCraHQ6sAFAddMGFdPzhXrRanKbHnnkbDTyRPyn5gRJ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub6CsGdqTDEVRnLmpWN218HBwJqfhqSx46iA8ByzEA5Bz9jfwU3TSg9U7ambKgJyykvCraHQ6sAFAddMGFdPzhXrRanKbHnnkbDTyRPyn5gRJ" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareATransactionFromAnAddressInHDWalletXPubYPubZPubEVMRB" } } } }, "responses": { "200": { "description": "The resource has been successfully submitted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareATransactionFromAnAddressInHDWalletXPubYPubZPubEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareATransactionFromAnAddressInHDWalletXPubYPubZPubEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareATransactionFromAnAddressInHDWalletXPubYPubZPubEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareATransactionFromAnAddressInHDWalletXPubYPubZPubEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/utxo/{blockchain}/{network}/{extendedPublicKey}/addresses": { "get": { "tags": [ "HD Wallet Data UTXO" ], "operationId": "List Synced Addresses UTXO", "summary": "List Synced Addresses UTXO", "x-cost": 120, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Bitcoin": 120, "Bitcoin Cash": 144, "Dash": 132, "Dogecoin": 132, "Litecoin": 132, "Zcash": 156 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "zcash" ] }, "description": "Represents the specific blockchain protocol name", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\"", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\"", "example": "testnet" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "addressFormat", "required": false, "schema": { "type": "string", "description": "Defines the address format value.", "enum": [ "p2pkh", "p2sh", "p2wpkh", "p2pkh-cash", "p2sh-cash" ] }, "description": "Defines the address format value." }, { "in": "query", "name": "isChangeAddress", "required": false, "schema": { "type": "string", "description": "Defines if the address is change addres or not.", "example": "false", "default": "true" }, "description": "Defines if the address is change addres or not.", "example": "false" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSyncedAddressesUTXOR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressesUTXOE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressesUTXOE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressesUTXOE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/utxo/{blockchain}/{network}/{extendedPublicKey}/transactions": { "get": { "tags": [ "HD Wallet Data UTXO" ], "operationId": "List HD Wallet (xPub, yPub, zPub) Transactions UTXO", "summary": "List HD Wallet (xPub, yPub, zPub) Transactions UTXO", "description": "This endpoint will list HD Wallet transactions.", "x-cost": 520, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Bitcoin": 520, "Bitcoin Cash": 624, "Dash": 572, "Dogecoin": 572, "Litecoin": 572, "Zcash": 676 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "zcash" ] }, "description": "Represents the specific blockchain.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" is a test network.", "example": "testnet" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the master public key (xPub) of the account.", "example": "tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w" }, "description": "Defines the master public key (xPub) of the account.", "example": "tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, { "in": "query", "name": "derivation", "required": false, "schema": { "type": "string", "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account", "enum": [ "account", "bip32" ] }, "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsUTXOR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsUTXOE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsUTXOE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsUTXOE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "422", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsUTXOE422" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blockchain-fees/utxo/{blockchain}/{network}/smart": { "get": { "tags": [ "Blockchain Fees UTXOs" ], "operationId": "Estimate Transaction Smart Fee UTXOs", "summary": "Estimate Transaction Smart Fee UTXOs", "description": "Through this endpoint, customers can estimate the approximate fee per kilobyte needed for a transaction to begin confirmation within the `confirmationTarget` blocks when possible. After which it will return the number of blocks for which the estimate is valid.", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 30, "Bitcoin Cash": 36, "Dash": 33, "Dogecoin": 33, "Litecoin": 33, "Zcash": 39 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "litecoin", "dash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "testnet", "mainnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "confirmationTarget", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Integer representation of confirmation target in blocks that estimation will be valid for", "example": 2 }, "description": "Integer representation of confirmation target in blocks that estimation will be valid for", "example": 2 }, { "in": "query", "name": "estimateMode", "required": false, "schema": { "type": "string", "description": "String representation of the address", "example": "economical", "enum": [ "economical", "conservative" ] }, "description": "String representation of the address", "example": "economical" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateTransactionSmartFeeUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateTransactionSmartFeeUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateTransactionSmartFeeUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateTransactionSmartFeeUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "501": { "description": "This {feature} has not been implemented yet.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/Unimplemented" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/utxo/{blockchain}/{network}/{extendedPublicKey}/unspent-outputs": { "get": { "tags": [ "HD Wallet Data UTXO" ], "operationId": "List HD Wallet (xPub, yPub, zPub) UTXOs", "summary": "List HD Wallet (xPub, yPub, zPub) UTXOs", "description": "Through this endpoint you can list HD wallet's UTXOs (Unspent Transaction Outputs) by providing extended public key of an already synced HD wallet.", "x-cost": 520, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Bitcoin": 520 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "tpubDDCs6jf3Tg8VTts6EBCNpibVanPQpSkmYRLAXVvuhcuC6ZcbYtEizqERj8D4TBukuvjNSjtjEbKYdtFuRG5WuisrirZG9m5L8wUvf4bHhgQ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "tpubDDCs6jf3Tg8VTts6EBCNpibVanPQpSkmYRLAXVvuhcuC6ZcbYtEizqERj8D4TBukuvjNSjtjEbKYdtFuRG5WuisrirZG9m5L8wUvf4bHhgQ" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, { "in": "query", "name": "derivation", "required": false, "schema": { "type": "string", "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account", "enum": [ "account", "bip32" ] }, "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "422", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubUTXOsE422" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/evm/{blockchain}/{network}/{address}/tokens-transfers": { "get": { "tags": [ "Address latest EVM" ], "operationId": "List Confirmed Tokens Transfers By Address EVM", "summary": "List Confirmed Tokens Transfers By Address EVM", "description": "Through this endpoint customers can obtain a list with **confirmed** token transfers by the `address` attribute. Token transfers may include information such as addresses of the sender and recipient, token name, token symbol, etc.\r\n\r\n{note}This refers only to transfers done for **confirmed tokens** not coins.{/note}\r\n\r\n{note}Please note that retrieving data will provide the most recent 14 days (1,209,600 seconds) of transactions from the current moment. To access the full historical data, please refer to the Address History APIs.{/note}", "x-cost": 220, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 220, "Ethereum Classic": 286, "Binance Smart Chain": 550, "Polygon": 440, "Arbitrum": 352, "Аvalanche": 396, "Base": 264, "Optimism": 308, "Tron": 330 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Ethereum Classic, etc.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "tron", "polygon", "avalanche", "arbitrum", "base", "optimism" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Ethereum Classic, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "mordor", "testnet", "nile", "sepolia", "amoy", "fuji" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "sortingOrder", "required": false, "schema": { "type": "string", "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConfirmedTokensTransfersByAddressEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTokensTransfersByAddressEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTokensTransfersByAddressEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTokensTransfersByAddressEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/utxo/{blockchain}/{network}/{extendedPublicKey}/addresses/derive-and-sync-change": { "post": { "tags": [ "HD Wallet Data UTXO" ], "operationId": "Derive And Sync New Change Addresses UTXO", "summary": "Derive And Sync New Change Addresses UTXO", "description": "Through this endpoint users can derive 100 change addresses, starting from the last index we have data for, which are then added to the xPub, subscribed for syncing, and start recording data. If no data is available, it will start from index 0. We use type P2WPKH.\r\n\r\n{warning}Deriving addresses will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 35, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 35, "Bitcoin Cash": 42, "Dash": 39, "Dogecoin": 39, "Litecoin": 39, "Zcash": 46 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub6DSqNgZke91RZBXk9s8tBknGPiVB7AQqVyxHCLEM49D3VGeMWg6qmSDruSn7SgQApVH1M8cSvjXfDmhRysDt9hZWFAMcZf4X1DAzd23G4ZQ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub6DSqNgZke91RZBXk9s8tBknGPiVB7AQqVyxHCLEM49D3VGeMWg6qmSDruSn7SgQApVH1M8cSvjXfDmhRysDt9hZWFAMcZf4X1DAzd23G4ZQ" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeriveAndSyncNewChangeAddressesUTXORB" } } } }, "responses": { "200": { "description": "Successfull Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeriveAndSyncNewChangeAddressesUTXOR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveAndSyncNewChangeAddressesUTXOE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveAndSyncNewChangeAddressesUTXOE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveAndSyncNewChangeAddressesUTXOE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/{blockchain}/{network}/{extendedPublicKey}/transactions": { "get": { "tags": [ "HD Wallet Data XRP" ], "operationId": "List HD Wallet (xPub, yPub, zPub) Transactions XRP", "summary": "List HD Wallet (xPub, yPub, zPub) Transactions XRP", "description": "This endpoint will list HD Wallet transactions.", "x-cost": 40, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "XRP": 40 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain.", "example": "xrp", "default": "xrp", "enum": [ "xrp" ] }, "description": "Represents the specific blockchain.", "example": "xrp" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the master public key (xPub) of the account.", "example": "tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w" }, "description": "Defines the master public key (xPub) of the account.", "example": "tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" is a test network.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "derivation", "required": false, "schema": { "type": "string", "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "enum": [ "account", "bip32" ] }, "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly." }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 10 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "422", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsXRPE422" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/evm/{blockchain}/{network}/{extendedPublicKey}/addresses/derive-and-sync": { "post": { "tags": [ "HD Wallet Data EVM" ], "operationId": "Derive And Sync New Receiving Addresses EVM", "summary": "Derive And Sync New Receiving Addresses EVM", "description": "Through this endpoint users can derive 100 receiving addresses, starting from the last index we have data for, which are then added to the xPub, subscribed for syncing, and start recording data. If no data is available, it will start from index 0. We use type P2WPKH.\r\n\r\n{warning}Deriving addresses will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 35, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 35, "Ethereum Classic": 46, "Binance Smart Chain": 88, "Tron": 53 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "sepolia", "mordor", "testnet", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub6DSqNgZke91RZBXk9s8tBknGPiVB7AQqVyxHCLEM49D3VGeMWg6qmSDruSn7SgQApVH1M8cSvjXfDmhRysDt9hZWFAMcZf4X1DAzd23G4ZQ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub6DSqNgZke91RZBXk9s8tBknGPiVB7AQqVyxHCLEM49D3VGeMWg6qmSDruSn7SgQApVH1M8cSvjXfDmhRysDt9hZWFAMcZf4X1DAzd23G4ZQ" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesEVMRB" } } } }, "responses": { "200": { "description": "Successfull Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/evm/{blockchain}/{network}/{extendedPublicKey}/addresses": { "get": { "tags": [ "HD Wallet Data EVM" ], "operationId": "List Synced Addresses EVM", "summary": "List Synced Addresses EVM", "description": "Through this endpoint users can list all addresses that Crypto APIs has synced for a specific xPub. This includes previous and current/new xPubs, what addresses we’ve synced for them, etc.", "x-cost": 30, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 30, "Ethereum Classic": 39, "Binance Smart Chain": 75, "Tron": 45 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "etherum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "etherum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "sepolia", "mordor", "testnet", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "addressFormat", "required": false, "schema": { "type": "string", "description": "Defines the address format value.", "example": "base58", "enum": [ "standard", "base58" ] }, "description": "Defines the address format value.", "example": "base58" }, { "in": "query", "name": "isChangeAddress", "required": false, "schema": { "type": "string", "description": "Defines if the address is change addres or not.", "example": "false", "default": "true" }, "description": "Defines if the address is change addres or not.", "example": "false" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSyncedAddressesEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressesEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressesEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressesEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/evm/{blockchain}/{network}/{extendedPublicKey}/assets": { "get": { "tags": [ "HD Wallet Data EVM" ], "operationId": "Get HD Wallet (xPub, yPub, zPub) Assets EVM", "summary": "Get HD Wallet (xPub, yPub, zPub) Assets EVM", "description": "This endpoint will return details on assets we support for a specified from the customer extended public key (xPub). These could be cryptocurrencies, fungible or non-fungible (NFT) tokens. Each asset has a unique identifier - assetId, and a unique symbol in the form of a string, e.g. \"USDT\".", "x-cost": 220, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 220, "Ethereum Classic": 286, "Binance Smart Chain": 550, "Tron": 330 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "tron", "ethereum-classic", "ethereum", "binance-smart-chain" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "nile", "mordor", "sepolia", "testnet", "mainnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "derivation", "required": false, "schema": { "type": "string", "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account", "default": "account", "enum": [ "account", "bip32" ] }, "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "422", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsEVME422" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/transactions/solana/{network}/{signature}/details": { "get": { "tags": [ "Transactions Data Solana" ], "operationId": "Get Transaction Details By Transaction Hash Solana", "summary": "Get Transaction Details By Transaction Hash Solana", "description": "Through this endpoint customers can obtain details about a signature by the transaction's unique identifier.", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Solana": 90 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software", "example": "devnet", "enum": [ "mainnet", "devnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software", "example": "devnet" }, { "in": "path", "name": "signature", "required": true, "schema": { "type": "string", "description": "String representation of the transaction's signature", "example": "2KGuERep8VNbpDbyLxxXKV8uFik5ECSx5zrRAgUyzAbGCXGVg2Xb62Yda8TVD3xjxsmGkSNDSm5cVstgLjfnmte5" }, "description": "String representation of the transaction's signature", "example": "2KGuERep8VNbpDbyLxxXKV8uFik5ECSx5zrRAgUyzAbGCXGVg2Xb62Yda8TVD3xjxsmGkSNDSm5cVstgLjfnmte5" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "Represents the `signature` for Solana blockchain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashSolanaR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashSolanaE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashSolanaE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashSolanaE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified transaction has not been found on the specific blockchain.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BlockchainDataTransactionNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/utils/{blockchain}/{network}/xpubs/{extendedPublicKey}/derive-addresses": { "get": { "tags": [ "Features" ], "operationId": "Derive HD Wallet (xPub, yPub, zPub) Change Or Receiving Addresses", "summary": "Derive HD Wallet (xPub, yPub, zPub) Change Or Receiving Addresses", "description": "Through this endpoint, customers can derive up to 10 addresses - both change and receive, from a certain HD Wallet (xPub, yPub, zPub), by providing an extended public key. By default the system creates a receiving/deposit address, unless the isChange attribute is set to 'true'. In that case the system derives a 'change' address. The change address can be derived only for UTXO based blockchains, for all the rest, this endpoint always creates a deposit/receiving address.", "x-cost": 10, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 10, "Ethereum Classic": 13, "Binance Smart Chain": 25, "Tron": 15, "XRP": 10, "Bitcoin": 10, "Bitcoin Cash": 12, "Dash": 11, "Dogecoin": 11, "Litecoin": 11, "Zcash": 13 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "ethereum", "ethereum-classic", "xrp", "binance-smart-chain", "zcash", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "mordor", "nile", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "addressFormat", "required": false, "schema": { "type": "string", "description": "Represents the format of the address.", "example": "p2sh", "enum": [ "p2pkh", "p2sh", "p2wpkh", "standard", "p2sh-cash", "p2pkh-cash", "classic", "base58" ] }, "description": "Represents the format of the address.", "example": "p2sh" }, { "in": "query", "name": "addressesCount", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Represents the addresses count.", "example": 2 }, "description": "Represents the addresses count.", "example": 2 }, { "in": "query", "name": "isChange", "required": false, "schema": { "type": "boolean", "description": "Defines if the specific address is a change or deposit address. If the value is True - it is a change address, if it is False - it is a Deposit address.", "example": true }, "description": "Defines if the specific address is a change or deposit address. If the value is True - it is a change address, if it is False - it is a Deposit address.", "example": true }, { "in": "query", "name": "startIndex", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 3 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 3 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeriveHDWalletXPubYPubZPubChangeOrReceivingAddressesR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveHDWalletXPubYPubZPubChangeOrReceivingAddressesE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveHDWalletXPubYPubZPubChangeOrReceivingAddressesE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveHDWalletXPubYPubZPubChangeOrReceivingAddressesE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/{blockchain}/{network}/{extendedPublicKey}/details": { "get": { "tags": [ "HD Wallet Data XRP" ], "operationId": "Get HD Wallet (xPub, yPub, zPub) Details XRP", "summary": "Get HD Wallet (xPub, yPub, zPub) Details XRP", "description": "HD wallet details is useful endpoint to get the most important data about HD wallet without the need to do a lot of calculations, once the HD Wallet is synced using Sync endpoint we keep it up to date and we calculate these details in advance.", "x-cost": 120, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "XRP": 120 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "xrp", "default": "xrp", "enum": [ "xrp" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "xrp" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "derivation", "required": false, "schema": { "type": "string", "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account", "enum": [ "account", "bip32" ] }, "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "422", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsXRPE422" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/utils/evm/{blockchain}/{network}/decode-raw-transaction": { "post": { "tags": [ "Utils", "Tools EVM" ], "operationId": "Decode Raw Transaction Hex EVM", "summary": "Decode Raw Transaction Hex EVM", "description": "Through this endpoint customers can decode a raw transaction hex and see the decoded transactions' details.", "x-cost": 10, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 10, "Ethereum Classic": 13, "Binance Smart Chain": 25, "Polygon": 20, "Arbitrum": 16, "Аvalanche": 18, "Base": 12, "Optimism": 14, "Tron": 15 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "sepolia" }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecodeRawTransactionHexEVMRB" } } } }, "responses": { "200": { "description": "Decoded transaction data attributes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecodeRawTransactionHexEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DecodeRawTransactionHexEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DecodeRawTransactionHexEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DecodeRawTransactionHexEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-historical/utxo/{blockchain}/{network}/{address}/transactions": { "get": { "tags": [ "Address history UTXOs" ], "operationId": "List Confirmed Transactions By Address UTXO Historical", "summary": "List Confirmed Transactions By Address UTXO Historical", "description": "This endpoint will list transactions by an attribute `address`. The transactions listed will detail additional information such as hash, height, time of creation in Unix timestamp, etc.", "x-cost": 130, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Bitcoin": 130, "Bitcoin Cash": 169, "Dash": 143, "Dogecoin": 143, "Litecoin": 143, "Zcash": 169 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "zcash", "bitcoin-cash", "litecoin", "dogecoin", "dash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, { "in": "query", "name": "sortingOrder", "required": false, "schema": { "type": "string", "example": "descending", "default": "descending", "enum": [ "ascending", "descending" ] }, "example": "descending" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressUTXOHistoricalR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressUTXOHistoricalE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressUTXOHistoricalE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressUTXOHistoricalE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "405": { "description": "The specified address is not active. Please, activate your address in order to be able to obtain information from this endpoint.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncAddressNotActive" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blockchain-fees/evm/{blockchain}/{network}/estimate-native-coin-transfer-gas-limit": { "post": { "tags": [ "Blockchain Fees EVM" ], "operationId": "Estimate Native Coin Transfer Gas Limit EVM", "summary": "Estimate Native Coin Transfer Gas Limit EVM", "description": "This endpoint helps customer in estimating the gas limit needed for a transaction. It gives information for gas expenses when sending ether to contracts or making a transaction with additional data in it.", "x-cost": 40, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 40, "Ethereum Classic": 52, "Binance Smart Chain": 100, "Polygon": 80, "Arbitrum": 64, "Аvalanche": 72, "Base": 48, "Optimism": 56, "Tron": 60 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "arbitrum", "avalanche", "base", "optimism", "polygon", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "sepolia", "enum": [ "mainnet", "mordor", "testnet", "sepolia", "fuji", "amoy", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateNativeCoinTransferGasLimitEVMRB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateNativeCoinTransferGasLimitEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateNativeCoinTransferGasLimitEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateNativeCoinTransferGasLimitEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateNativeCoinTransferGasLimitEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/transactions/kaspa/{network}/{transactionId}": { "get": { "tags": [ "Transactions Data Kaspa" ], "operationId": "Get Transaction Details By Transaction Id Kaspa", "summary": "Get Transaction Details By Transaction Id Kaspa", "description": "Through this endpoint customers can obtain details about a signature by the transaction's unique identifier.", "x-cost": 45, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Kaspa": 81 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software", "example": "mainnet", "enum": [ "mainnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software", "example": "mainnet" }, { "in": "path", "name": "transactionId", "required": true, "schema": { "type": "string", "description": "String identifier of the transaction ID", "example": "794af341e2fc00b732a60a4fb5ee238c6289fec30c21bbadf326cc448d2c312e" }, "description": "String identifier of the transaction ID", "example": "794af341e2fc00b732a60a4fb5ee238c6289fec30c21bbadf326cc448d2c312e" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionIdKaspaR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionIdKaspaE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionIdKaspaE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionIdKaspaE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified transaction has not been found on the specific blockchain.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BlockchainDataTransactionNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/utils/{blockchain}/{network}/encode-x-address/{classicAddress}/{addressTag}": { "get": { "tags": [ "Utils", "Tools XRP" ], "operationId": "Encode X-Address", "summary": "Encode X-Address", "description": "Through this endpoint, customers can encode an encoded XRP address with tag, by providing the specific x-address. The response includes the encoded classic address and the tag.", "x-cost": 10, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "XRP": 10 }, "parameters": [ { "in": "path", "name": "addressTag", "required": true, "schema": { "type": "integer", "format": "int64", "description": "Defines a specific Tag that is an additional XRP address feature. It helps identifying a transaction recipient beyond a wallet address.", "example": 3999472835 }, "description": "Defines a specific Tag that is an additional XRP address feature. It helps identifying a transaction recipient beyond a wallet address.", "example": 3999472835 }, { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "xrp", "default": "xrp", "enum": [ "xrp" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "xrp" }, { "in": "path", "name": "classicAddress", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EncodeX-AddressR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EncodeX-AddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EncodeX-AddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EncodeX-AddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-historical/evm/{blockchain}/{network}/{address}/tokens-transfers": { "get": { "tags": [ "Address history EVM" ], "operationId": "List Synced Address Tokens Transfer EVM", "summary": "List Synced Address Tokens Transfer EVM", "description": "Through this endpoint customers can obtain a list with confirmed token transfers by the address attribute. Token transfers may include information such as addresses of the sender and recipient, token name, token symbol, etc.", "x-cost": 230, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 230, "Ethereum Classic": 299, "Binance Smart Chain": 575, "Polygon": 460, "Tron": 345 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "example": "ethereum", "enum": [ "ethereum", "polygon", "tron", "ethereum-classic", "binance-smart-chain" ] }, "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "example": "sepolia", "enum": [ "sepolia", "amoy", "mainnet", "nile", "mordor", "testnet" ] }, "example": "sepolia" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "String identifier of the address document represented in CryptoAPIs", "example": "0x3d0b25fe09e2cd92f06ba776391a122519936e90" }, "description": "String identifier of the address document represented in CryptoAPIs", "example": "0x3d0b25fe09e2cd92f06ba776391a122519936e90" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50, "max": 200 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "sortingOrder", "required": false, "schema": { "type": "string", "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSyncedAddressTokensTransferEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressTokensTransferEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressTokensTransferEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressTokensTransferEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "405": { "description": "The specified address is not active. Please, activate your address in order to be able to obtain information from this endpoint.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncAddressNotActive" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/xrp/{network}/{address}/next-available-sequence": { "get": { "tags": [ "Address latest XRP" ], "operationId": "Next Available Sequence XRP", "summary": "Next Available Sequence XRP", "description": "Through this endpoint customers can get information about the next available sequence", "x-cost": 20, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "XRP": 20 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\" is test networks.", "example": "mainnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\" is test networks.", "example": "mainnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "r3ViKjYAk4f7WX2pGeL9ivoS9bEMUhgB8N" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "r3ViKjYAk4f7WX2pGeL9ivoS9bEMUhgB8N" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NextAvailableSequenceXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NextAvailableSequenceXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NextAvailableSequenceXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NextAvailableSequenceXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-historical/evm/{blockchain}/{network}/{address}/statistics": { "get": { "tags": [ "Address history EVM" ], "operationId": "Get Address Statistics EVM", "summary": "Get Address Statistics EVM", "description": "Through this endpoint the customer can receive the number of confirmed transactions, token transfers and internal transactions of a given address based on confirmed/synced blocks only. In the case where there are any incoming or outgoing unconfirmed transactions for the specific address, they will not be counted or calculated here.", "x-cost": 230, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 230, "Ethereum Classic": 299, "Binance Smart Chain": 575, "Polygon": 460, "Tron": 345 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Ethereum Classic.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Ethereum Classic.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"sepolia\" and \"mordor\" are test networks.", "example": "sepolia", "enum": [ "sepolia", "mainnet", "mordor" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"sepolia\" and \"mordor\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0xfad4a236c87880035497043f24ea58d73c3e50de" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0xfad4a236c87880035497043f24ea58d73c3e50de" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAddressStatisticsEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressStatisticsEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressStatisticsEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressStatisticsEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/NotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "405": { "description": "The specified address is not active. Please, activate your address in order to be able to obtain information from this endpoint.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncAddressNotActive" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/transactions/xrp/{network}/{transactionHash}": { "get": { "tags": [ "Transactions Data XRP" ], "operationId": "Get Transaction Details By Transaction Hash XRP", "summary": "Get Transaction Details By Transaction Hash XRP", "description": "Through this endpoint customers can obtain details about a XRP transaction by the transaction's unique identifier. \r\n\r\nSince XRP is a different blockchain than Bitcoin and Ethereum, it isn't unified.", "x-cost": 20, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "XRP": 20 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "path", "name": "transactionHash", "required": true, "schema": { "type": "string", "description": "Represents the same as `transactionId` for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols `hash` is different from `transactionId` for SegWit transactions.", "example": "36a1737481edec87bacc3101dfb752ae2c76f9171e7edebe587e330c1ea77c8d" }, "description": "Represents the same as `transactionId` for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols `hash` is different from `transactionId` for SegWit transactions.", "example": "36a1737481edec87bacc3101dfb752ae2c76f9171e7edebe587e330c1ea77c8d" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/utxo/{blockchain}/{network}/{address}/transactions": { "get": { "tags": [ "Address latest UTXOs" ], "operationId": "List Confirmed Transactions By Address UTXOs", "summary": "List Confirmed Transactions By Address UTXOs", "description": "This endpoint will list transactions by an attribute `address`. The transactions listed will detail additional information such as hash, height, time of creation in Unix timestamp, etc.\r\n\r\n{note}Please note that retrieving data will provide the most recent 14 days (1,209,600 seconds) of transactions from the current moment. To access the full historical data, please refer to the Address History APIs.{/note}", "x-cost": 110, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Bitcoin": 110, "Bitcoin Cash": 132, "Dash": 121, "Dogecoin": 121, "Litecoin": 121, "Zcash": 143 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "String representation of the address", "example": "bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38" }, "description": "String representation of the address", "example": "bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, { "in": "query", "name": "sortingOrder", "required": false, "schema": { "type": "string", "example": "ascending", "default": "ascending", "enum": [ "ascending", "descending" ] }, "example": "ascending" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/utils/utxo/{blockchain}/{network}/validate-address": { "post": { "tags": [ "Tools UTXOs" ], "operationId": "Validate Address UTXO", "summary": "Validate Address UTXO", "description": "This endpoint checks user public addresses whether they are valid or not.", "x-cost": 10, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 10, "Bitcoin Cash": 12, "Dash": 11, "Dogecoin": 11, "Litecoin": 11, "Zcash": 13, "Kaspa": 18 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAddressUTXORB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAddressUTXOR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressUTXOE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressUTXOE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressUTXOE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-historical/evm/{blockchain}/{network}/{address}/internal-transactions": { "get": { "tags": [ "Address history EVM" ], "operationId": "List Synced Address Internal Transactions EVM", "summary": "List Synced Address Internal Transactions EVM", "description": "Through this endpoint customers can list internal transactions by the address attribute.", "x-cost": 330, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 330, "Ethereum Classic": 429, "Binance Smart Chain": 825, "Polygon": 660, "Tron": 495 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "example": "ethereum", "enum": [ "ethereum", "polygon", "tron", "ethereum-classic", "binance-smart-chain" ] }, "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "example": "sepolia", "enum": [ "sepolia", "amoy", "mainnet", "nile", "mordor", "testnet" ] }, "example": "sepolia" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "String identifier of the address document represented in CryptoAPIs", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, "description": "String identifier of the address document represented in CryptoAPIs", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "sortingOrder", "required": false, "schema": { "type": "string", "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request was successfull.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSyncedAddressInternalTransactionsEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressInternalTransactionsEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressInternalTransactionsEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressInternalTransactionsEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "405": { "description": "The specified address is not active. Please, activate your address in order to be able to obtain information from this endpoint.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/SyncAddressNotActive" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/kaspa/{network}/{address}/balance": { "get": { "tags": [ "Address latest Kaspa" ], "operationId": "Get Address Balance Kaspa", "summary": "Get Address Balance Kaspa", "description": "Through this endpoint the customer can receive the balance of a given address based on confirmed/synced blocks only. In the case where there are any incoming or outgoing unconfirmed transactions for the specific address, they will not be counted or calculated here. Applies only for coins.", "x-cost": 510, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Kaspa": 918 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "mainnet", "enum": [ "mainnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "mainnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "kaspa:qrt9hh06x96r63h8rn086at8w6kh2qs45azgy09j5ntcyuf5n9vdcghqmlw77" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "kaspa:qrt9hh06x96r63h8rn086at8w6kh2qs45azgy09j5ntcyuf5n9vdcghqmlw77" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAddressBalanceKaspaR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceKaspaE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceKaspaE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressBalanceKaspaE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/prepare-transactions/evm/{blockchain}/{network}/non-fungible-tokens": { "post": { "tags": [ "Prepare Transactions EVMs" ], "operationId": "Prepare A Non Fungible Token Transfer From Address EVM", "summary": "Prepare A Non Fungible Token Transfer From Address EVM", "description": "Using this endpoint customers can prepare a non-fungible token transfer from an address with private and public keys. The address doesn’t have to belong to a wallet. The response will include the transaction fee in Wei.", "x-cost": 85, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 85, "Ethereum Classic": 111, "Binance Smart Chain": 213, "Polygon": 170, "Arbitrum": 136, "Аvalanche": 153, "Base": 102, "Optimism": 119, "Tron": 128 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "binance-smart-chain", "ethereum" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"mordor\" are test networks.", "example": "sepolia", "enum": [ "testnet", "mainnet", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"mordor\" are test networks.", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareANonFungibleTokenTransferFromAddressEVMRB" } } } }, "responses": { "201": { "description": "The resource has been successfully submitted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareANonFungibleTokenTransferFromAddressEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareANonFungibleTokenTransferFromAddressEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareANonFungibleTokenTransferFromAddressEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareANonFungibleTokenTransferFromAddressEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blockchain-fees/evm/{blockchain}/{network}/eip-1559": { "get": { "tags": [ "Blockchain Fees EVM" ], "operationId": "Get EIP 1559 Fee Recommendations EVM", "summary": "Get EIP 1559 Fee Recommendations EVM", "description": "Through this endpoint customers can obtain fee recommendations specifically for EIP 1559.", "x-cost": 40, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 40, "Ethereum Classic": 52, "Binance Smart Chain": 100, "Polygon": 80, "Arbitrum": 64, "Аvalanche": 72, "Base": 48, "Optimism": 56, "Tron": 60 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "sepolia", "enum": [ "mainnet", "sepolia", "amoy" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "sepolia" }, { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum.", "example": "ethereum", "enum": [ "ethereum", "polygon", "optimism", "arbitrum", "base" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum.", "example": "ethereum" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEIP1559FeeRecommendationsEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetEIP1559FeeRecommendationsEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetEIP1559FeeRecommendationsEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetEIP1559FeeRecommendationsEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/solana/{network}/addresses/{address}/tokens": { "get": { "tags": [ "Address latest Solana" ], "operationId": "List Tokens By Address Solana", "summary": "List Tokens By Address Solana", "description": "Through this endpoint customers can obtain token data by providing an attribute - address. The information that can be returned can include the contract address, the token symbol, type and balance.\r\n\r\n{note}Please be advised that retrieving Solana (beta) data will provide you with the most recent day of transactions. For access to full historical data, kindly reach out to our support team.{/note}", "x-cost": 40, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Solana": 120 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software.", "example": "devnet", "enum": [ "mainnet", "devnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software.", "example": "devnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "6y5KFgn1Ven8256v27s4KVi3thrqryujBBWwoCbSkGJz" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "6y5KFgn1Ven8256v27s4KVi3thrqryujBBWwoCbSkGJz" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTokensByAddressSolanaR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTokensByAddressSolanaE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTokensByAddressSolanaE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTokensByAddressSolanaE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blockchain-fees/evm/{blockchain}/{network}/estimate-token-transfer-gas-limit": { "post": { "tags": [ "Blockchain Fees EVM" ], "operationId": "Estimate Token Transfer Gas Limit EVM", "summary": "Estimate Token Transfer Gas Limit EVM", "description": "This endpoint helps customer in estimating the Contract Gas Limit needed for a transaction. It gives information for gas expenses for a specific contract when sending ethers or making a transaction with additional data in it.", "x-cost": 40, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 40, "Ethereum Classic": 52, "Binance Smart Chain": 100, "Polygon": 80, "Arbitrum": 64, "Аvalanche": 72, "Base": 48, "Optimism": 56, "Tron": 60 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "arbitrum", "avalanche", "base", "optimism", "polygon", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "sepolia", "enum": [ "mainnet", "mordor", "testnet", "sepolia", "fuji", "amoy", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateTokenTransferGasLimitEVMRB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateTokenTransferGasLimitEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateTokenTransferGasLimitEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateTokenTransferGasLimitEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateTokenTransferGasLimitEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/solana/{network}/{address}/transactions": { "get": { "tags": [ "Address latest Solana" ], "operationId": "List Transactions By Address Solana", "summary": "List Transactions By Address Solana", "description": "This endpoint will list transactions by an attribute address. The transactions listed will detail additional information such as hash, height, time of creation in Unix timestamp, etc.\r\n\r\n{note}Please be advised that retrieving Solana data will provide you with the most recent day of transactions. For access to full historical data, kindly reach out to our support team.{/note}", "x-cost": 30, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Solana": 90 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software.", "example": "devnet", "enum": [ "mainnet", "devnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software.", "example": "devnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "DUVULQ5bLhvrMwV6BzqPPEQ9RYJ2pVkqwmByBHKNGpVf" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "DUVULQ5bLhvrMwV6BzqPPEQ9RYJ2pVkqwmByBHKNGpVf" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "string", "description": "Defines how many items should be returned in the response per page basis.", "example": "10" }, "description": "Defines how many items should be returned in the response per page basis.", "example": "10" }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "String representation of the transaction signature to start searching backwards from. If not provided the search starts from the top of the highest max confirmed block", "example": "64ca21f92cf5431000105d1a" }, "description": "String representation of the transaction signature to start searching backwards from. If not provided the search starts from the top of the highest max confirmed block", "example": "64ca21f92cf5431000105d1a" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsByAddressSolanaR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByAddressSolanaE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByAddressSolanaE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByAddressSolanaE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-historical/utxo/{blockchain}/{network}/{address}/statistics": { "get": { "tags": [ "Address history UTXOs" ], "operationId": "Get Address Statistics UTXOs", "summary": "Get Address Statistics UTXOs", "description": "Through this endpoint the customer can receive the number of confirmed transactions of a given address based on confirmed/synced blocks only. In the case where there are any incoming or outgoing unconfirmed transactions for the specific address, they will not be counted or calculated here. Applies only for coins.", "x-cost": 530, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 530, "Bitcoin Cash": 689, "Dash": 583, "Dogecoin": 583, "Litecoin": 583, "Zcash": 689 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Bitcoin, Bitcoin Cash.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Bitcoin, Bitcoin Cash.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while \"testnet\" is test network.", "example": "testnet", "enum": [ "testnet", "mainnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while \"testnet\" is test network.", "example": "testnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "bc1pp7w6kxnj7lzgm29pmuhezwl0vjdlcrthqukll5gn9xuqfq5n673smy4m63" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "bc1pp7w6kxnj7lzgm29pmuhezwl0vjdlcrthqukll5gn9xuqfq5n673smy4m63" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAddressStatisticsUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressStatisticsUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressStatisticsUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetAddressStatisticsUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/utxo/{blockchain}/{network}/{extendedPublicKey}/details": { "get": { "tags": [ "HD Wallet Data UTXO" ], "operationId": "Get HD Wallet (xPub, yPub, zPub) Details UTXO", "summary": "Get HD Wallet (xPub, yPub, zPub) Details UTXO", "description": "HD wallet details is useful endpoint to get the most important data about HD wallet without the need to do a lot of calculations, once the HD Wallet is synced using Sync endpoint we keep it up to date and we calculate these details in advance.", "x-cost": 40, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 40, "Bitcoin Cash": 48, "Dash": 44, "Dogecoin": 44, "Litecoin": 44, "Zcash": 52 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "zcash", "bitcoin-cash", "dash", "dogecoin", "litecoin" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "testnet", "mainnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "derivation", "required": false, "schema": { "type": "string", "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account", "default": "account", "enum": [ "account", "bip32" ] }, "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsUTXOR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsUTXOE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsUTXOE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsUTXOE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "422", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsUTXOE422" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/utxo/{blockchain}/{network}/hash/{blockHash}/details": { "get": { "tags": [ "Blocks UTXOs" ], "operationId": "Get Block Details By Block Hash UTXOs", "summary": "Get Block Details By Block Hash UTXOs", "description": "Through this endpoint customers can obtain basic information about a given mined block, specifically by using the `hash` parameter. These block details could include the hash of the specific, the previous and the next block, its transactions count, its height, etc. \r\n\r\nBlockchain specific data is information such as version, nonce, size, bits, merkleroot, etc.", "x-cost": 20, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 20, "Bitcoin Cash": 24, "Dash": 22, "Dogecoin": 22, "Litecoin": 22, "Zcash": 26 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "blockHash", "required": true, "schema": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "0000000006b3f483bec16b8a85c632bdd30a14a202c83a9148002c9ee441dd0c" }, "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "0000000006b3f483bec16b8a85c632bdd30a14a202c83a9148002c9ee441dd0c" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified block has not been found on the specific blockchain.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BlockchainDataBlockNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/evm/{blockchain}/{network}/height/{blockHeight}/transactions": { "get": { "tags": [ "Blocks EVM" ], "operationId": "List Transactions by Block Height EVM", "summary": "List Transactions by Block Height EVM", "description": "This endpoint will list transactions by an attribute `blockHeight`. The transactions listed will detail additional information such as hash, addresses, time of creation in Unix timestamp, etc.\r\n\r\n{note}Only transactions from blocks produced in the last 14 days (1,209,600 seconds) are available through this endpoint.{/note}", "x-cost": 20, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 20, "Ethereum Classic": 26, "Binance Smart Chain": 50, "Polygon": 40, "Arbitrum": 32, "Аvalanche": 36, "Base": 24, "Optimism": 28, "Tron": 30 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "tron" ] }, "description": "Represents the specific blockchain protocol name", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "mordor", "testnet", "sepolia", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "blockHeight", "required": true, "schema": { "type": "integer", "format": "int64", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 673852 }, "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 673852 }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified block has not been found on the specific blockchain.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BlockchainDataBlockNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/utxo/{blockchain}/{network}/height/{blockHeight}/details": { "get": { "tags": [ "Blocks UTXOs" ], "operationId": "Get Block Details By Block Height UTXOs", "summary": "Get Block Details By Block Height UTXOs", "description": "Through this endpoint customers can obtain basic information about a given mined block, specifically by using the `height` parameter. These block details could include the hash of the specific, the previous and the next block, its transactions count, its height, etc. \r\n\r\nBlockchain specific data is information such as version, nonce, size, bits, merkleroot, etc.", "x-cost": 20, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 20, "Bitcoin Cash": 24, "Dash": 22, "Dogecoin": 22, "Litecoin": 22, "Zcash": 26 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "blockHeight", "required": true, "schema": { "type": "integer", "format": "int64", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 673852, "default": 673852 }, "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 673852 }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHeightUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified block has not been found on the specific blockchain.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BlockchainDataBlockNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/{blockchain}/{network}/{extendedPublicKey}/addresses": { "get": { "tags": [ "HD Wallet Data XRP" ], "operationId": "List Synced Addresses XRP", "summary": "List Synced Addresses XRP", "description": "Through this endpoint users can list all addresses that Crypto APIs has synced for a specific xPub. This includes previous and current/new xPubs, what addresses we’ve synced for them, etc.", "x-cost": 30, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "XRP": 30 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "xrp", "default": "xrp", "enum": [ "xrp" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "xrp" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "addressFormat", "required": false, "schema": { "type": "string", "description": "Defines the address format value.", "example": "classic", "enum": [ "classic" ] }, "description": "Defines the address format value.", "example": "classic" }, { "in": "query", "name": "isChangeAddress", "required": false, "schema": { "type": "boolean", "description": "Defines if the address is change addres or not.", "example": false }, "description": "Defines if the address is change addres or not.", "example": false }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 10 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSyncedAddressesXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressesXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressesXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSyncedAddressesXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/utxo/{blockchain}/{network}/latest/details": { "get": { "tags": [ "Blocks UTXOs" ], "operationId": "Get Last Mined Block UTXOs", "summary": "Get Last Mined Block UTXOs", "description": "Through this endpoint customers can fetch the last mined block in a specific blockchain network, along with its details. These could include the hash of the specific, the previous and the next block, its transactions count, its height, etc. \r\n\r\nBlockchain specific data is information such as version, nonce, size, bits, merkleroot, etc.", "x-cost": 20, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 20, "Bitcoin Cash": 24, "Dash": 22, "Dogecoin": 22, "Litecoin": 22, "Zcash": 26 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLastMinedBlockUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetLastMinedBlockUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetLastMinedBlockUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetLastMinedBlockUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified block has not been found on the specific blockchain.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BlockchainDataBlockNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blockchain-fees/evm/{blockchain}/{network}/mempool": { "get": { "tags": [ "Blockchain Fees EVM" ], "operationId": "Get Fee Recommendations EVM", "summary": "Get Fee Recommendations EVM", "description": "Through this endpoint customers can obtain fee recommendations. Our fees recommendations are based on Mempool data which makes them much more accurate than fees based on already mined blocks. Calculations are done in real time live.", "x-cost": 40, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 40, "Ethereum Classic": 52, "Binance Smart Chain": 100, "Polygon": 80, "Arbitrum": 64, "Аvalanche": 72, "Base": 48, "Optimism": 56, "Tron": 60 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "polygon", "optimism", "arbitrum", "base", "avalanche" ] }, "description": "Represents the specific blockchain protocol name", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used", "example": "sepolia", "enum": [ "mainnet", "mordor", "testnet", "sepolia", "amoy", "fuji" ] }, "description": "Represents the name of the blockchain network used", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFeeRecommendationsEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetFeeRecommendationsEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetFeeRecommendationsEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetFeeRecommendationsEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/{blockchain}/{network}/{extendedPublicKey}/addresses/derive-and-sync": { "post": { "tags": [ "HD Wallet Data XRP" ], "operationId": "Derive And Sync New Receiving Addresses XRP", "summary": "Derive And Sync New Receiving Addresses XRP", "description": "Through this endpoint users can derive 100 receiving addresses, starting from the last index we have data for, which are then added to the xPub, subscribed for syncing, and start recording data. If no data is available, it will start from index 0. We use type P2WPKH.\r\n\r\n{warning}Deriving addresses will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 35, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "XRP": 35 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "xrp", "default": "xrp", "enum": [ "xrp" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "xrp" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub6DSqNgZke91RZBXk9s8tBknGPiVB7AQqVyxHCLEM49D3VGeMWg6qmSDruSn7SgQApVH1M8cSvjXfDmhRysDt9hZWFAMcZf4X1DAzd23G4ZQ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub6DSqNgZke91RZBXk9s8tBknGPiVB7AQqVyxHCLEM49D3VGeMWg6qmSDruSn7SgQApVH1M8cSvjXfDmhRysDt9hZWFAMcZf4X1DAzd23G4ZQ" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesXRPRB" } } } }, "responses": { "200": { "description": "Successfull Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blockchain-fees/utxo/{blockchain}/{network}/mempool": { "get": { "tags": [ "Blockchain Fees UTXOs" ], "operationId": "Get Fee Recommendations UTXOs", "summary": "Get Fee Recommendations UTXOs", "description": "Through this endpoint customers can obtain fee recommendations. Our fees recommendations are based on Mempool data which makes them much more accurate than fees based on already mined blocks. Calculations are done in real time live.", "x-cost": 160, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 160, "Bitcoin Cash": 192, "Dash": 176, "Dogecoin": 176, "Litecoin": 176, "Zcash": 208 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "dogecoin", "dash", "litecoin", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFeeRecommendationsUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetFeeRecommendationsUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetFeeRecommendationsUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetFeeRecommendationsUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/transactions/evm/{blockchain}/{network}/{transactionHash}/internal": { "get": { "tags": [ "Transactions Data EVM" ], "operationId": "List Internal Transaction Details by Transaction Hash EVM", "summary": "List Internal Transaction Details by Transaction Hash EVM", "description": "Through this endpoint customers can list internal transactions along with their details by a specific attribute `transactionHash`, which is the parent transaction's Hash.\r\n\r\nAn internal transaction is the result of a smart contract being triggered by an EOA or a subsequent contract call.\r\n\r\n{note}Please be advised that retrieving Polygon (beta) data will provide you with the most recent 14 days of transactions. For access to full historical data, kindly reach out to our support team.{/note}", "x-cost": 170, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 170, "Ethereum Classic": 221, "Binance Smart Chain": 425, "Polygon": 340, "Arbitrum": 272, "Аvalanche": 306, "Base": 204, "Optimism": 238, "Tron": 255 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum", "binance-smart-chain", "ethereum-classic", "polygon", "optimism", "arbitrum", "base", "avalanche", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "testnet", "mordor", "sepolia", "amoy", "fuji", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "transactionHash", "required": true, "schema": { "type": "string", "description": "String identifier of the parent transaction of the internal transaction represented in CryptoAPIs.", "example": "0xbc8245ba5cccb524d91256224689ac0f16678321a266bab8197ad7daab4c9e16" }, "description": "String identifier of the parent transaction of the internal transaction represented in CryptoAPIs.", "example": "0xbc8245ba5cccb524d91256224689ac0f16678321a266bab8197ad7daab4c9e16" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been sussessful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInternalTransactionDetailsByTransactionHashEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListInternalTransactionDetailsByTransactionHashEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListInternalTransactionDetailsByTransactionHashEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListInternalTransactionDetailsByTransactionHashEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/evm/{blockchain}/{network}/hash/{blockHash}/details": { "get": { "tags": [ "Blocks EVM" ], "operationId": "Get Block Details By Block Hash EVM", "summary": "Get Block Details By Block Hash EVM", "description": "Through this endpoint customers can obtain basic information about a given mined block, specifically by using the `hash` parameter. These block details could include the hash of the specific, the previous and the next block, its transactions count, its height, etc. \r\n\r\nBlockchain specific data is information such as version, nonce, size, bits, merkleroot, etc.", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 30, "Ethereum Classic": 39, "Binance Smart Chain": 75, "Polygon": 60, "Arbitrum": 48, "Аvalanche": 54, "Base": 36, "Optimism": 42, "Tron": 45 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "mordor", "testnet", "sepolia", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "blockHash", "required": true, "schema": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "0x4a1579ba43fc4ea961f7aeeef9259b981a3654d138183a3b7b9920783762e1bc" }, "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "0x4a1579ba43fc4ea961f7aeeef9259b981a3654d138183a3b7b9920783762e1bc" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetBlockDetailsByBlockHashEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified block has not been found on the specific blockchain.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BlockchainDataBlockNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/xrp/{network}/latest/details": { "get": { "tags": [ "Blocks XRP" ], "operationId": "Get Latest Mined Block XRP", "summary": "Get Latest Mined Block XRP", "description": "Through this endpoint customers can fetch the last mined XRP block in the blockchain, along with its details. These could include the hash of the specific, the previous and the next block, its transactions count, its height, etc. \r\n\r\nSince XRP is a different blockchain than Bitcoin and Ethereum, it isn't unified.", "x-cost": 20, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "XRP": 20 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLatestMinedBlockXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetLatestMinedBlockXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetLatestMinedBlockXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetLatestMinedBlockXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/xrp/{network}/height/{blockHeight}/transactions": { "get": { "tags": [ "Blocks XRP" ], "operationId": "List Transactions By Block Height XRP", "summary": "List Transactions By Block Height XRP", "description": "This endpoint will list transactions by an attribute `blockHeight`. The transactions listed will detail additional information such as hash, addresses, time of creation in Unix timestamp, etc.", "x-cost": 20, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "XRP": 20 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "path", "name": "blockHeight", "required": true, "schema": { "type": "integer", "format": "int64", "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 15971358 }, "description": "Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".", "example": 15971358 }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHeightXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/evm/{blockchain}/{network}/hash/{blockHash}/transactions": { "get": { "tags": [ "Blocks EVM" ], "operationId": "List Transactions by Block Hash EVM", "summary": "List Transactions by Block Hash EVM", "description": "This endpoint will list transactions by an attribute `transactionHash`. The transactions listed will detail additional information such as addresses, height, time of creation in Unix timestamp, etc.\r\n\r\n{note}Only transactions from blocks produced in the last 14 days (1,209,600 seconds) are available through this endpoint.{/note}", "x-cost": 20, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 20, "Ethereum Classic": 26, "Binance Smart Chain": 50, "Polygon": 40, "Arbitrum": 32, "Аvalanche": 36, "Base": 24, "Optimism": 28, "Tron": 30 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "tron" ] }, "description": "Represents the specific blockchain protocol name", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "mordor", "testnet", "sepolia", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "blockHash", "required": true, "schema": { "type": "string", "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "0x4a1579ba43fc4ea961f7aeeef9259b981a3654d138183a3b7b9920783762e1bc" }, "description": "Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "0x4a1579ba43fc4ea961f7aeeef9259b981a3654d138183a3b7b9920783762e1bc" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsByBlockHashEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHashEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHashEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByBlockHashEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/utxo/{blockchain}/{network}/{extendedPublicKey}/addresses/derive-and-sync": { "post": { "tags": [ "HD Wallet Data UTXO" ], "operationId": "Derive And Sync New Receiving Addresses UTXO", "summary": "Derive And Sync New Receiving Addresses UTXO", "description": "Through this endpoint users can derive 100 receiving addresses, starting from the last index we have data for, which are then added to the xPub, subscribed for syncing, and start recording data. If no data is available, it will start from index 0. We use type P2WPKH.\r\n\r\n{warning}Deriving addresses will lead to additional credits consumption on daily bases! Please, refer to **Data Flow Limiting** in the **General Information** section for details.{/warning}", "x-cost": 35, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 35, "Bitcoin Cash": 42, "Dash": 39, "Dogecoin": 39, "Litecoin": 39, "Zcash": 46 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub6DSqNgZke91RZBXk9s8tBknGPiVB7AQqVyxHCLEM49D3VGeMWg6qmSDruSn7SgQApVH1M8cSvjXfDmhRysDt9hZWFAMcZf4X1DAzd23G4ZQ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub6DSqNgZke91RZBXk9s8tBknGPiVB7AQqVyxHCLEM49D3VGeMWg6qmSDruSn7SgQApVH1M8cSvjXfDmhRysDt9hZWFAMcZf4X1DAzd23G4ZQ" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesUTXORB" } } } }, "responses": { "200": { "description": "Successfull Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesUTXOR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesUTXOE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesUTXOE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DeriveAndSyncNewReceivingAddressesUTXOE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blocks/evm/{blockchain}/{network}/latest": { "get": { "tags": [ "Blocks EVM" ], "operationId": "List Latest Mined Blocks EVM", "summary": "List Latest Mined Blocks EVM", "description": "Through this endpoint customers can list **up to 50** from the latest blocks that were mined.", "x-cost": 30, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 30, "Ethereum Classic": 39, "Binance Smart Chain": 75, "Polygon": 60, "Arbitrum": 48, "Аvalanche": 54, "Base": 36, "Optimism": 42, "Tron": 45 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used", "example": "sepolia", "enum": [ "mordor", "mainnet", "testnet", "sepolia", "nile" ] }, "description": "Represents the name of the blockchain network used", "example": "sepolia" }, { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name", "example": "ethereum", "enum": [ "ethereum-classic", "ethereum", "binance-smart-chain", "tron" ] }, "description": "Represents the specific blockchain protocol name", "example": "ethereum" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "count", "required": false, "schema": { "type": "integer", "description": "Specifies how many records were requested.", "example": 2, "default": 10 }, "description": "Specifies how many records were requested.", "example": 2 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLatestMinedBlocksEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListLatestMinedBlocksEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListLatestMinedBlocksEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListLatestMinedBlocksEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/transactions/utxo/{blockchain}/{network}/{transactionHash}": { "get": { "tags": [ "Transactions Data UTXOs" ], "operationId": "Get Transaction Details By Transaction Hash UTXOs", "summary": "Get Transaction Details By Transaction Hash UTXOs", "description": "Through this endpoint customers can obtain details about a transaction by the transaction's unique identifier. In UTXO-based protocols like BTC there are attributes such as `transactionId` and transaction `hash`. They still could be different. In protocols like Ethereum there is only one unique value and it's `hash`.", "x-cost": 20, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 20, "Bitcoin Cash": 24, "Dash": 22, "Dogecoin": 22, "Litecoin": 22, "Zcash": 26 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "transactionHash", "required": true, "schema": { "type": "string", "description": "String identifier of the transaction", "example": "295e563cbc9d8965695a16d3b1a62a56224c61c01ef0886e25f58a91704f81b5" }, "description": "String identifier of the transaction", "example": "295e563cbc9d8965695a16d3b1a62a56224c61c01ef0886e25f58a91704f81b5" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/evm/{blockchain}/{network}/{extendedPublicKey}/transactions": { "get": { "tags": [ "HD Wallet Data EVM" ], "operationId": "List HD Wallet (xPub, yPub, zPub) Transactions EVM", "summary": "List HD Wallet (xPub, yPub, zPub) Transactions EVM", "description": "This endpoint will list HD Wallet transactions.", "x-cost": 220, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 220, "Ethereum Classic": 286, "Binance Smart Chain": 550, "Tron": 330 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "tron" ] }, "description": "Represents the specific blockchain.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" is a test network.", "example": "sepolia", "enum": [ "mainnet", "sepolia", "mordor", "testnet", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" is a test network.", "example": "sepolia" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the master public key (xPub) of the account.", "example": "tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w" }, "description": "Defines the master public key (xPub) of the account.", "example": "tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 }, { "in": "query", "name": "derivation", "required": false, "schema": { "type": "string", "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account", "enum": [ "account" ] }, "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "422", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListHDWalletXPubYPubZPubTransactionsEVME422" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/utxo/{blockchain}/{network}/{extendedPublicKey}/transactions/prepare": { "post": { "tags": [ "HD Wallet Data UTXO" ], "operationId": "Prepare A UTXO-Based Transaction From HD Wallet (xPub, yPub, zPub)", "summary": "Prepare A UTXO-Based Transaction From HD Wallet (xPub, yPub, zPub)", "description": "Through the “Prepare a UTXO-based transaction from xPub” endpoint users can prepare a transaction for signing from all synced with Crypto APIs addresses for the specific xPub. This is based on the `selectionStrategy` and the addresses’ balances. In the case a user has an address not synced with Crypto APIs, it will not be included. This endpoint applies to all supported UTXO-based blockchain protocols, e.g. Bitcoin, Litecoin, etc.", "x-cost": 530, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 530, "Bitcoin Cash": 636, "Dash": 583, "Dogecoin": 583, "Litecoin": 583, "Zcash": 689 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "testnet", "mainnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "tpubDCNoSqt3HF32yq8VU6mgapTuW1FzENZa3C5dKUF6WCQzubWz2nA1yxUhMQWkhhkD58Uc8YiuD8cmB3y5tihqAv4zT2GNyqKTNLchHJmsvt9" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "tpubDCNoSqt3HF32yq8VU6mgapTuW1FzENZa3C5dKUF6WCQzubWz2nA1yxUhMQWkhhkD58Uc8YiuD8cmB3y5tihqAv4zT2GNyqKTNLchHJmsvt9" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubRB" } } } }, "responses": { "200": { "description": "The resource has been successfully submitted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareAUTXO-BasedTransactionFromHDWalletXPubYPubZPubE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/transactions/evm/{blockchain}/{network}/{transactionHash}/logs": { "get": { "tags": [ "Transactions Data EVM" ], "operationId": "List Logs By Transaction Hash EVM", "summary": "List Logs By Transaction Hash EVM", "description": "This endpoint allows customers to retrieve transaction logs associated with a specific blockchain transaction. In blockchain technology, transaction logs are essential for auditing, debugging, and monitoring the execution of smart contracts and transactions. This endpoint provides a convenient and efficient way to access these logs.", "x-cost": 30, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 30, "Ethereum Classic": 39, "Binance Smart Chain": 75, "Polygon": 60, "Arbitrum": 48, "Аvalanche": 54, "Base": 36, "Optimism": 42, "Tron": 45 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "transactionHash", "required": true, "schema": { "type": "string", "description": "Represents the unique identifier of a transaction, i.e. it could be transactionId in UTXO-based protocols like Bitcoin, and transaction hash in Ethereum blockchain.", "example": "0x77041a2573f9edb5c443172acf369dc218102b006624bf0f276f32637807550f" }, "description": "Represents the unique identifier of a transaction, i.e. it could be transactionId in UTXO-based protocols like Bitcoin, and transaction hash in Ethereum blockchain.", "example": "0x77041a2573f9edb5c443172acf369dc218102b006624bf0f276f32637807550f" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLogsByTransactionHashEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListLogsByTransactionHashEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListLogsByTransactionHashEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListLogsByTransactionHashEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified transaction has not been found on the specific blockchain.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BlockchainDataTransactionNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blockchain-fees/evm/{blockchain}/{network}/estimate-contract-interaction-gas-limit": { "post": { "tags": [ "Blockchain Fees EVM" ], "operationId": "Estimate Contract Interaction Gas Limit EVM", "summary": "Estimate Contract Interaction Gas Limit EVM", "description": "This endpoint helps customer in estimating the Contract Interaction Gas Limit needed for a transaction. It gives information for gas expenses for a specific contract when calling a specific function.", "x-cost": 40, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 40, "Ethereum Classic": 52, "Binance Smart Chain": 100, "Polygon": 80, "Arbitrum": 64, "Аvalanche": 72, "Base": 48, "Optimism": 56, "Tron": 60 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Arbitrum.", "example": "arbitrum", "enum": [ "arbitrum", "avalanche", "base", "optimism", "polygon", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Arbitrum.", "example": "arbitrum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "sepolia", "enum": [ "sepolia", "mainnet", "fuji", "amoy", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateContractInteractionGasLimitEVMRB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateContractInteractionGasLimitEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateContractInteractionGasLimitEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateContractInteractionGasLimitEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateContractInteractionGasLimitEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/evm/{blockchain}/{network}/{extendedPublicKey}/details": { "get": { "tags": [ "HD Wallet Data EVM" ], "operationId": "Get HD Wallet (xPub, yPub, zPub) Details EVM", "summary": "Get HD Wallet (xPub, yPub, zPub) Details EVM", "description": "HD wallet details is useful endpoint to get the most important data about HD wallet without the need to do a lot of calculations, once the HD Wallet is synced using Sync endpoint we keep it up to date and we calculate these details in advance.", "x-cost": 120, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 120, "Ethereum Classic": 156, "Binance Smart Chain": 300, "Tron": 180 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "sepolia", "mordor", "testnet", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "derivation", "required": false, "schema": { "type": "string", "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "default": "account", "enum": [ "account" ] }, "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly." } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "422", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubDetailsEVME422" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blockchain-fees/xrp/{network}/mempool": { "get": { "tags": [ "Blockchain Fees XRP" ], "operationId": "Get Fee Recommendations XRP", "summary": "Get Fee Recommendations XRP", "description": "Through this endpoint customers can obtain fee recommendations. Our fees recommendations are based on Mempool data which makes them much more accurate than fees based on already mined blocks. Calculations are done in real time live.", "x-cost": 40, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "XRP": 40 }, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\"", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\"", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFeeRecommendationsXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetFeeRecommendationsXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetFeeRecommendationsXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetFeeRecommendationsXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/transactions/evm/{blockchain}/{network}/{transactionHash}": { "get": { "tags": [ "Transactions Data EVM" ], "operationId": "Get Transaction Details By Transaction Hash EVM", "summary": "Get Transaction Details By Transaction Hash EVM", "description": "Through this endpoint customers can obtain details about a transaction by the transaction's unique identifier.", "x-cost": 30, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 30, "Ethereum Classic": 39, "Binance Smart Chain": 75, "Polygon": 60, "Arbitrum": 48, "Аvalanche": 54, "Base": 36, "Optimism": 42, "Tron": 45 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "polygon", "avalanche", "arbitrum", "base", "optimism", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "mainnet", "enum": [ "mainnet", "mordor", "testnet", "sepolia", "amoy", "fuji", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "mainnet" }, { "in": "path", "name": "transactionHash", "required": true, "schema": { "type": "string", "description": "String identifier of the transaction hash", "example": "0x6897997eb03ae5220d9a1f9d8f5fc3f1e2ee26b3087da2b7dc4e3660f0dd11bd" }, "description": "String identifier of the transaction hash", "example": "0x6897997eb03ae5220d9a1f9d8f5fc3f1e2ee26b3087da2b7dc4e3660f0dd11bd" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsByTransactionHashEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified transaction has not been found on the specific blockchain.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BlockchainDataTransactionNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/contracts/evm/{blockchain}/{network}/{contractAddress}/token-details": { "get": { "tags": [ "Contracts EVM" ], "operationId": "Get Token Details by Contract Address EVM", "summary": "Get Token Details by Contract Address EVM", "description": "Though this endpoint customers can obtain information about token details. This can be done by providing the `contact address` parameter.\r\n\r\n{note}This address is **not** the same as the smart contract creator address.{/note}", "x-cost": 90, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 90, "Ethereum Classic": 117, "Binance Smart Chain": 225, "Polygon": 180, "Arbitrum": 144, "Аvalanche": 162, "Base": 108, "Optimism": 126, "Tron": 135 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "mordor", "testnet", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "contractAddress", "required": true, "schema": { "type": "string", "description": "Defines the specific address of the contract.", "example": "0x534bD102153EF199abAe8296a2FaE4599fC44Cdc" }, "description": "Defines the specific address of the contract.", "example": "0x534bD102153EF199abAe8296a2FaE4599fC44Cdc" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTokenDetailsByContractAddressEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTokenDetailsByContractAddressEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTokenDetailsByContractAddressEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTokenDetailsByContractAddressEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/transactions/utxo/{blockchain}/{network}/{transactionHash}/raw-data": { "get": { "tags": [ "Transactions Data UTXOs" ], "operationId": "Get Raw Transaction Data UTXOs", "summary": "Get Raw Transaction Data UTXOs", "description": "Through this endpoint customers can get information on a transaction in its raw format by providing its `transactionId`.", "x-cost": 20, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 20, "Bitcoin Cash": 24, "Dash": 22, "Dogecoin": 22, "Litecoin": 22, "Zcash": 26 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "path", "name": "transactionHash", "required": true, "schema": { "type": "string", "description": "Represents the unique identifier of a transaction, i.e. it could be transactionId in UTXO-based protocols like Bitcoin, and transaction hash in Ethereum blockchain.", "example": "4b66461bf88b61e1e4326356534c135129defb504c7acb2fd6c92697d79eb250" }, "description": "Represents the unique identifier of a transaction, i.e. it could be transactionId in UTXO-based protocols like Bitcoin, and transaction hash in Ethereum blockchain.", "example": "4b66461bf88b61e1e4326356534c135129defb504c7acb2fd6c92697d79eb250" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRawTransactionDataUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetRawTransactionDataUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetRawTransactionDataUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetRawTransactionDataUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified transaction has not been found on the specific blockchain.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BlockchainDataTransactionNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/transactions/evm/{blockchain}/{network}/{transactionHash}/tokens-transfers": { "get": { "tags": [ "Transactions Data EVM" ], "operationId": "List Tokens Transfers By Transaction Hash EVM", "summary": "List Tokens Transfers By Transaction Hash EVM", "description": "Through this endpoint customers can obtain a list with token transfers by the `transactionHash` attribute. Token transfers may include information such as addresses of the sender and recipient, token name, token symbol, etc.\r\n\r\n{note}Please be advised that retrieving Polygon (beta) data will provide you with the most recent 14 days of transactions. For access to full historical data, kindly reach out to our support team.{/note}\r\n\r\n{note}This refers only to transfers done for **tokens** not coins.{/note}", "x-cost": 95, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 95, "Ethereum Classic": 124, "Binance Smart Chain": 238, "Polygon": 190, "Arbitrum": 152, "Аvalanche": 171, "Base": 114, "Optimism": 133, "Tron": 143 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Ethereum Classic, etc.", "example": "ethereum", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "polygon", "optimism", "arbitrum", "base", "avalanche", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Ethereum Classic, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mainnet", "mordor", "testnet", "sepolia", "amoy", "fuji", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "transactionHash", "required": true, "schema": { "type": "string", "description": "Represents the hash of the transaction, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "0xbc8245ba5cccb524d91256224689ac0f16678321a266bab8197ad7daab4c9e16" }, "description": "Represents the hash of the transaction, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.", "example": "0xbc8245ba5cccb524d91256224689ac0f16678321a266bab8197ad7daab4c9e16" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTokensTransfersByTransactionHashEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTokensTransfersByTransactionHashEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTokensTransfersByTransactionHashEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTokensTransfersByTransactionHashEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/{blockchain}/{network}/{extendedPublicKey}/assets": { "get": { "tags": [ "HD Wallet Data XRP" ], "operationId": "Get HD Wallet (xPub, yPub, zPub) Assets XRP", "summary": "Get HD Wallet (xPub, yPub, zPub) Assets XRP", "description": "This endpoint will return details on assets we support for a specified from the customer extended public key (xPub). These could be cryptocurrencies, fungible or non-fungible (NFT) tokens. Each asset has a unique identifier - assetId, and a unique symbol in the form of a string, e.g. \"USDT\".", "x-cost": 120, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "XRP": 120 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "xrp", "default": "xrp", "enum": [ "xrp" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "xrp" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub68SyZPMPpZUy9QB2fk2J28b5Rwd6jeWKind3K8oziZuVcL7wWZiXZNCPKuh42ejSpTLYngQ9Gbzj9a1Ap2QQmoFs2sMSbUvkEr8D3GW7MrR" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "xpub68SyZPMPpZUy9QB2fk2J28b5Rwd6jeWKind3K8oziZuVcL7wWZiXZNCPKuh42ejSpTLYngQ9Gbzj9a1Ap2QQmoFs2sMSbUvkEr8D3GW7MrR" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "derivation", "required": false, "schema": { "type": "string", "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account", "enum": [ "account", "bip32" ] }, "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "422", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsXRPE422" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/hd-wallets/utxo/{blockchain}/{network}/{extendedPublicKey}/assets": { "get": { "tags": [ "HD Wallet Data UTXO" ], "operationId": "Get HD Wallet (xPub, yPub, zPub) Assets UTXO", "summary": "Get HD Wallet (xPub, yPub, zPub) Assets UTXO", "description": "This endpoint will return details on assets we support for a specified from the customer extended public key (xPub). These could be cryptocurrencies, fungible or non-fungible (NFT) tokens. Each asset has a unique identifier - assetId, and a unique symbol in the form of a string, e.g. \"USDT\".", "x-cost": 520, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 520, "Bitcoin Cash": 624, "Dash": 572, "Dogecoin": 572, "Litecoin": 572, "Zcash": 676 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "zcash", "bitcoin-cash", "dash", "dogecoin", "litecoin" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "testnet", "mainnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "extendedPublicKey", "required": true, "schema": { "type": "string", "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, "description": "Defines the account extended publicly known key which is used to derive all child public keys.", "example": "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "derivation", "required": false, "schema": { "type": "string", "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account", "default": "account", "enum": [ "account", "bip32" ] }, "description": "The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.", "example": "account" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsUTXOR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsUTXOE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsUTXOE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsUTXOE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "422", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetHDWalletXPubYPubZPubAssetsUTXOE422" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/utils/evm/{blockchain}/{network}/validate-address": { "post": { "tags": [ "Utils", "Tools EVM" ], "operationId": "Validate Address EVM", "summary": "Validate Address EVM", "description": "This endpoint checks user public addresses whether they are valid or not.", "x-cost": 10, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 10, "Ethereum Classic": 13, "Binance Smart Chain": 25, "Polygon": 20, "Arbitrum": 16, "Аvalanche": 18, "Base": 12, "Optimism": 14, "Tron": 15 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "ethereum", "ethereum-classic", "binance-smart-chain", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "mordor", "nile", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAddressEVMRB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAddressEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/utils/xrp/{blockchain}/{network}/validate-address": { "post": { "tags": [ "Utils", "Tools XRP" ], "operationId": "Validate Address XRP", "summary": "Validate Address XRP", "description": "This endpoint checks user public addresses whether they are valid or not.", "x-cost": 10, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "XRP": 10 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "xrp" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAddressXRPRB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAddressXRPR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressXRPE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressXRPE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressXRPE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/broadcast-transactions/{blockchain}/{network}": { "post": { "tags": [ "Broadcast Locally Sign Transactions" ], "operationId": "Broadcast Locally Signed Transaction", "summary": "Broadcast Locally Signed Transaction", "description": "Through this endpoint customers can broadcast transactions that have been already signed locally. Instead of using a node for broadcasting a signed transaction users can use this endpoint. We then keep the user posted about the status by sending you a callback with a success or failure status.\r\n\r\n{warning}This can be prepared and signed **only** locally, not through the API. We can provide support only for the process of broadcasting.{/warning}", "x-cost": 50, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 50, "Ethereum Classic": 65, "Binance Smart Chain": 125, "Polygon": 100, "Arbitrum": 80, "Аvalanche": 90, "Base": 60, "Optimism": 70, "Tron": 75, "Solana": 150, "XRP": 50, "Tezos": 65, "Bitcoin": 50, "Bitcoin Cash": 60, "Dash": 55, "Dogecoin": 55, "Litecoin": 55, "Zcash": 65, "Kaspa": 90 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "ethereum", "ethereum-classic", "zcash", "binance-smart-chain", "xrp", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet", "mordor", "nile", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastLocallySignedTransactionRB" } } } }, "responses": { "200": { "description": "The resource has been successfully submitted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastLocallySignedTransactionR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BroadcastLocallySignedTransactionE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BroadcastLocallySignedTransactionE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BroadcastLocallySignedTransactionE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/BroadcastLocallySignedTransactionE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "BROADCAST_TRANSACTION_SUCCESS": { "{$request.BODY#/callbackUrl": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastTransactionSuccess" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "BROADCAST_TRANSACTION_FAIL": { "{$request.BODY#/callbackUrl": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastTransactionFail" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } } }, "/utils/utxo/{blockchain}/{network}/decode-raw-transaction": { "post": { "tags": [ "Tools UTXOs" ], "operationId": "Decode Raw Transaction Hex UTXO", "summary": "Decode Raw Transaction Hex UTXO", "x-cost": 10, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Bitcoin": 10, "Bitcoin Cash": 12, "Dash": 11, "Dogecoin": 11, "Litecoin": 11, "Zcash": 13, "Kaspa": 18 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "dash", "dogecoin", "litecoin", "zcash" ] }, "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "example": "mainnet" }, "example": "mainnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecodeRawTransactionHexUTXORB" } } } }, "responses": { "200": { "description": "Decoded raw hex transaction data attributes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecodeRawTransactionHexUTXOR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DecodeRawTransactionHexUTXOE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DecodeRawTransactionHexUTXOE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DecodeRawTransactionHexUTXOE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/prepare-transactions/evm/{blockchain}/{network}/native-coins": { "post": { "tags": [ "Prepare Transactions EVMs" ], "operationId": "Prepare Transaction From Address EVM", "summary": "Prepare Transaction From Address EVM", "description": "Through this endpoint customers can prepare a transaction from an address with private and public keys. The address doesn’t have to belong to a wallet.\r\nThe response will include the transaction fee in Wei.", "x-cost": 60, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 60, "Ethereum Classic": 78, "Binance Smart Chain": 150, "Polygon": 120, "Arbitrum": 96, "Аvalanche": 108, "Base": 72, "Optimism": 84, "Tron": 90 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "binance-smart-chain", "ethereum-classic", "ethereum" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "sepolia", "enum": [ "testnet", "mordor", "mainnet", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "sepolia" }, { "in": "path", "name": "type", "required": true, "schema": { "type": "string", "description": "Enum representation of the transaction type", "default": "legacy-transaction", "enum": [ "legacy-transaction" ] }, "description": "Enum representation of the transaction type" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareTransactionFromAddressEVMRB" } } } }, "responses": { "201": { "description": "The resource has been successfully submitted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareTransactionFromAddressEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareTransactionFromAddressEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareTransactionFromAddressEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareTransactionFromAddressEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/prepare-transactions/evm/{blockchain}/{network}/fungible-tokens": { "post": { "tags": [ "Prepare Transactions EVMs" ], "operationId": "Prepare A Fungible Token Transfer From Address EVM", "summary": "Prepare A Fungible Token Transfer From Address EVM", "description": "Using this endpoint customers can prepare a fungible token transfer from an address with private and public keys. The address doesn’t have to belong to a wallet. The response will include the transaction fee in Wei.", "x-cost": 80, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "Ethereum": 80, "Ethereum Classic": 104, "Binance Smart Chain": 200, "Polygon": 160, "Arbitrum": 128, "Аvalanche": 144, "Base": 96, "Optimism": 112, "Tron": 120 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum-classic", "binance-smart-chain", "ethereum" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"mordor\" are test networks.", "example": "sepolia", "enum": [ "mordor", "testnet", "mainnet", "sepolia" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"mordor\" are test networks.", "example": "sepolia" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareAFungibleTokenTransferFromAddressEVMRB" } } } }, "responses": { "201": { "description": "The resource has been successfully submitted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareAFungibleTokenTransferFromAddressEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareAFungibleTokenTransferFromAddressEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareAFungibleTokenTransferFromAddressEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/PrepareAFungibleTokenTransferFromAddressEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/utils/{blockchain}/{network}/decode-x-address/{xAddress}": { "get": { "tags": [ "Utils", "Tools XRP" ], "operationId": "Decode X-Address", "summary": "Decode X-Address", "description": "Through this endpoint, customers can decode an encoded XRP address with tag, by providing the specific x-address. The response includes the decoded classic address and the tag.", "x-cost": 10, "x-charge-count": 1, "x-is-list": false, "x-blockchain-specific-cost": { "XRP": 10 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "xrp", "default": "xrp", "enum": [ "xrp" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "xrp" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while network like \"testnet\" is a test network.", "example": "testnet" }, { "in": "path", "name": "xAddress", "required": true, "schema": { "type": "string", "description": "Represents the encoded classic address with its destination tag.", "example": "TVTMSyg6nRscAm2JtRd8hnpF9nD21CgZx6ibb9iy3EWHotV" }, "description": "Represents the encoded classic address with its destination tag.", "example": "TVTMSyg6nRscAm2JtRd8hnpF9nD21CgZx6ibb9iy3EWHotV" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecodeX-AddressR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DecodeX-AddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DecodeX-AddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DecodeX-AddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/utxo/{blockchain}/{network}/{address}/unconfirmed-transactions": { "get": { "tags": [ "Address latest UTXOs" ], "operationId": "List Unconfirmed Transactions by Address UTXOs", "summary": "List Unconfirmed Transactions by Address UTXOs", "description": "Through this endpoint customers can list transactions by `address` that are **unconfirmed**.", "x-cost": 110, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Bitcoin": 110, "Bitcoin Cash": 132, "Dash": 121, "Dogecoin": 121, "Litecoin": 121, "Zcash": 143 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "zcash" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "2NDt6eztswLiVgVYaGUhkTPmugUGovVypAe" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "2NDt6eztswLiVgVYaGUhkTPmugUGovVypAe" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int64", "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0, "default": 0 }, "description": "The starting index of the response items, i.e. where the response should start listing the returned items.", "example": 0 } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUnconfirmedTransactionsByAddressUTXOsR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListUnconfirmedTransactionsByAddressUTXOsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListUnconfirmedTransactionsByAddressUTXOsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListUnconfirmedTransactionsByAddressUTXOsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/addresses-latest/evm/{blockchain}/{network}/{address}/transactions": { "get": { "tags": [ "Address latest EVM" ], "operationId": "List Confirmed Transactions By Address EVM", "summary": "List Confirmed Transactions By Address EVM", "description": "This endpoint will list transactions by an attribute `address`. The transactions listed will detail additional information such as hash, height, time of creation in Unix timestamp, etc.\r\n\r\n{note}Please note that retrieving data will provide the most recent 14 days (1,209,600 seconds) of transactions from the current moment. To access the full historical data, please refer to the Address History APIs.{/note}", "x-cost": 120, "x-charge-count": 1, "x-is-list": true, "x-blockchain-specific-cost": { "Ethereum": 120, "Ethereum Classic": 156, "Binance Smart Chain": 300, "Polygon": 240, "Arbitrum": 192, "Аvalanche": 216, "Base": 144, "Optimism": 168, "Tron": 180 }, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum", "enum": [ "ethereum-classic", "ethereum", "binance-smart-chain", "arbitrum", "polygon", "avalanche", "base", "optimism", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia", "enum": [ "mordor", "mainnet", "testnet", "sepolia", "amoy", "fuji", "nile" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "sepolia" }, { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0xc8c960a01ac67c5e1424f7d5afb08a625aff9076" }, "description": "Represents the public address, which is a compressed and shortened form of a public key.", "example": "0xc8c960a01ac67c5e1424f7d5afb08a625aff9076" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 10, "default": 10, "max": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 10 }, { "in": "query", "name": "sortingOrder", "required": false, "schema": { "type": "string", "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, "description": "Defines the sorting order of the results. DESCENDING or ASCENDING by timestamp", "example": "descending" }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressEVMR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressEVME400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressEVME401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListConfirmedTransactionsByAddressEVME403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2024-12-12" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } } }, "x-tagGroups": [ { "name": "General Information", "tags": [ "Overview", "Getting Started", "Authentication", "What we support", "Errors and API status", "Data Flow Limiting", "Standards and Conventions", "Callbacks", "API Versioning" ] }, { "name": "Address latest", "tags": [ "Address latest UTXOs", "Address latest EVM", "Address latest Solana", "Address latest XRP", "Address latest Kaspa" ] }, { "name": "Address History", "tags": [ "Manage addresses", "Address history UTXOs", "Address history EVM" ] }, { "name": "Block Data", "tags": [ "Blocks UTXOs", "Blocks EVM", "Blocks Solana", "Blocks XRP" ] }, { "name": "Contracts", "tags": [ "Contracts EVM", "Contracts Solana" ] }, { "name": "Utils", "tags": [ "Tools UTXOs", "Tools EVM", "Tools XRP" ] }, { "name": "Market Data", "tags": [ "Metadata", "Exchange Rates", "Assets" ] }, { "name": "Broadcast transaction", "tags": [ "Broadcast Locally Sign Transactions" ] }, { "name": "HD wallet", "tags": [ "Manage HD wallet", "HD Wallet Data UTXO", "HD Wallet Data EVM", "HD Wallet Data XRP" ] }, { "name": "Blockchain Fees", "tags": [ "Blockchain Fees UTXOs", "Blockchain Fees EVM", "Blockchain Fees XRP" ] }, { "name": "Prepare Transactions", "tags": [ "Prepare Transactions EVMs" ] }, { "name": "Transactions Data", "tags": [ "Transactions Data UTXOs", "Transactions Data EVM", "Transactions Data Solana", "Transactions Data XRP", "Transactions Data Kaspa" ] }, { "name": "Blockchain Events", "tags": [ "Manage Subscriptions", "Create Subscriptions for" ] }, { "name": "Simulate Transactions", "tags": [ "Simulate Transactions EVM", "Simulate Transactions UTXOs", "Simulate Transactions Solana" ] }, { "name": "AI Compatibility", "tags": [ "MCP Servers", "n8n MCP Client" ] }, { "name": "n8n Worfklows", "tags": [ "n8n Community Node" ] } ], "x-tagLabels": { "Address latest UTXOs": "UTXOs (such as Bitcoin)", "Address latest EVM": "EVM (such as Ethereum)", "Address latest Solana": "Solana", "Address latest XRP": "XRP", "Address latest Kaspa": "Kaspa", "Address history UTXOs": "UTXOs (such as Bitcoin)", "Address history EVM": "EVM (such as Ethereum)", "Blocks UTXOs": "UTXOs (such as Bitcoin)", "Blocks EVM": "EVM (such as Ethereum)", "Blocks XRP": "XRP", "Contracts EVM": "EVM (such as Ethereum)", "Contracts Solana": "Solana", "Blockchain Fees UTXOs": "UTXOs (such as Bitcoin)", "Blockchain Fees EVM": "EVM (such as Ethereum)", "Prepare Transactions EVMs": "EVM (such as Ethereum)", "Transactions Data UTXOs": "UTXOs (such as Bitcoin)", "Transactions Data EVM": "EVM (such as Ethereum)", "Transactions Data Solana": "Solana", "Transactions Data XRP": "XRP", "Transactions Data Kaspa": "Kaspa", "Simulate Transactions EVM": "EVM (such as Ethereum)", "HD Wallet Data UTXO": "UTXOs (such as Bitcoin)", "HD Wallet Data EVM": "EVM (such as Ethereum)", "HD Wallet Data XRP": "XRP" }, "x-endpointLabels": { "Get Address Balance UTXOs": "Get Address Balance", "Get Address Balance EVM": "Get Address Balance", "Get Address Balance XRP": "Get Address Balance", "Get Address Balance SOLANA": "Get Address Balance", "Get Address Balance Kaspa": "Get Address Balance", "Get Address Statistics UTXOs": "Get Address Statistics", "Get Address Statistics EVM": "Get Address Statistics", "List Confirmed Transactions By Address UTXOs": "List Confirmed Transactions By Address", "List Confirmed Transactions By Address Kaspa": "List Confirmed Transactions By Address", "List Unconfirmed Transactions by Address UTXOs": "List Unconfirmed Transactions by Address", "List Unspent Transaction Outputs By Address UTXOs": "List Unspent Transaction Outputs By Address", "List Confirmed Transactions By Address EVM": "List Confirmed Transactions By Address", "List Internal Transactions By Address EVM": "List Internal Transactions By Address", "Get Next Available Nonce EVM": "Get Next Available Nonce", "List Confirmed Tokens Transfers By Address EVM": "List Confirmed Tokens Transfers By Address", "List Transactions By Address Solana": "List Transactions By Address", "List Transactions by Address XRP": "List Transactions by Address", "List Confirmed Transactions By Address UTXO Historical": "List Confirmed Transactions By Address", "List Confirmed Transactions By Address By Timestamp UTXO Historical": "List Confirmed Transactions By Address By Timestamp", "List Confirmed Transactions By Address EVM history": "List Confirmed Transactions By Address", "List Confirmed Transactions By Address From Timestamp EVM history": "List Confirmed Transactions By Address From Timestamp", "List Synced Address Tokens Transfer EVM": "List Synced Address Tokens Transfers", "List Synced Address Internal Transactions EVM": "List Synced Address Internal Transactions", "List Tokens By Address Synced EVM": "List Tokens By Address Synced", "Get Block Details By Block Hash UTXOs": "Get Block Details By Block Hash", "List Transactions by Block Hash UTXOs": "List Transactions by Block Hash", "List Transactions by Block Height UTXOs": "List Transactions by Block Height", "Get Block Details By Block Height UTXOs": "Get Block Details By Block Height", "Get Last Mined Block UTXOs": "Get Last Mined Block", "List Latest Mined Blocks UTXOs": "List Latest Mined Blocks", "List Latest Mined Blocks EVM": "List Latest Mined Blocks", "List Transactions by Block Hash EVM": "List Transactions by Block Hash", "List Transactions by Block Height EVM": "List Transactions by Block Height", "Get Block Details By Block Height EVM": "Get Block Details By Block Height", "Get Block Details By Block Hash EVM": "Get Block Details By Block Hash", "Get Last Mined Block EVM": "Get Last Mined Block", "List Transactions By Block Hash XRP": "List Transactions By Block Hash", "List Transactions By Block Height XRP": "List Transactions By Block Height", "Get Block Details By Block Height XRP": "Get Block Details By Block Height", "Get Block Details By Block Hash XRP": "Get Block Details By Block Hash", "Get Latest Mined Block XRP": "Get Latest Mined Block", "List Latest Mined Blocks XRP": "List Latest Mined Blocks", "Get Token Details by Contract Address EVM": "Get Token Details by Contract Address", "Get Token Details by Contract Address Solana": "Get Token Details by Contract Address", "Get Fee Recommendations UTXOs": "Get Fee Recommendations", "Estimate Transaction Smart Fee UTXOs": "Estimate Transaction Smart Fee", "Get Fee Recommendations EVM": "Get Fee Recommendations", "Get EIP 1559 Fee Recommendations EVM": "Get EIP 1559 Fee Recommendations", "Estimate Native Coin Transfer Gas Limit EVM": "Estimate Native Coin Transfer Gas Limit", "Estimate Token Transfer Gas Limit EVM": "Estimate Token Transfer Gas Limit", "Estimate Contract Interaction Gas Limit EVM": "Estimate Contract Interaction Gas Limit", "Prepare Transaction From Address EVM": "Prepare Transaction From Address", "Prepare A Non Fungible Token Transfer From Address EVM": "Prepare A Non Fungible Token Transfer From Address", "Prepare A Fungible Token Transfer From Address EVM": "Prepare A Fungible Token Transfer From Address", "Get Transaction Details By Transaction Hash UTXOs": "Get Transaction Details By Transaction Hash", "Get Transaction Details By Transaction Id Kaspa": "Get Transaction Details By Transaction Id", "Get Raw Transaction Data UTXOs": "Get Raw Transaction Data", "Get Transaction Details By Transaction Hash EVM": "Get Transaction Details By Transaction Hash", "List Internal Transaction Details by Transaction Hash EVM": "List Internal Transaction Details by Transaction Hash", "List Tokens Transfers By Transaction Hash EVM": "List Tokens Transfers By Transaction Hash", "List Logs By Transaction Hash EVM": "List Logs By Transaction Hash", "Get Transaction Details By Transaction Hash Solana": "Get Transaction Details By Transaction Hash", "Get Transaction Details By Transaction Hash XRP": "Get Transaction Details By Transaction Hash", "Simulate Ethereum Transactions": "Simulate Transactions", "Derive And Sync New Receiving Addresses UTXO": "Derive And Sync New Receiving Addresses", "Derive And Sync New Receiving Addresses EVM": "Derive And Sync New Receiving Addresses", "Derive And Sync New Receiving Addresses XRP": "Derive And Sync New Receiving Addresses", "Derive And Sync New Change Addresses UTXO": "Derive And Sync New Change Addresses", "Derive And Sync New Change Addresses EVM": "Derive And Sync New Change Addresses", "Derive And Sync New Change Addresses XRP": "Derive And Sync New Change Addresses", "List Synced Addresses UTXO": "List Synced Addresses", "List Synced Addresses EVM": "List Synced Addresses", "List Synced Addresses XRP": "List Synced Addresses", "Prepare A UTXO-Based Transaction From HD Wallet (xPub, yPub, zPub) UTXO": "Prepare A UTXO-Based Transaction From HD Wallet (xPub, yPub, zPub)", "Prepare A Transaction From an Address in HD Wallet (xPub, yPub, zPub) EVM": "Prepare A Transaction From an Address in HD Wallet (xPub, yPub, zPub)", "Prepare A Transaction From an Address in HD Wallet (xPub, yPub, zPub) XRP": "Prepare A Transaction From an Address in HD Wallet (xPub, yPub, zPub)", "Get HD Wallet (xPub, yPub, zPub) Assets UTXO": "Get HD Wallet (xPub, yPub, zPub) Assets", "Get HD Wallet (xPub, yPub, zPub) Assets EVM": "Get HD Wallet (xPub, yPub, zPub) Assets", "Get HD Wallet (xPub, yPub, zPub) Assets XRP": "Get HD Wallet (xPub, yPub, zPub) Assets", "Get HD Wallet (xPub, yPub, zPub) Details UTXO": "Get HD Wallet (xPub, yPub, zPub) Details", "Get HD Wallet (xPub, yPub, zPub) Details EVM": "Get HD Wallet (xPub, yPub, zPub) Details", "Get HD Wallet (xPub, yPub, zPub) Details XRP": "Get HD Wallet (xPub, yPub, zPub) Details", "List HD Wallet (xPub, yPub, zPub) Transactions UTXO": "List HD Wallet (xPub, yPub, zPub) Transactions", "List HD Wallet (xPub, yPub, zPub) Transactions EVM": "List HD Wallet (xPub, yPub, zPub) Transactions", "List HD Wallet (xPub, yPub, zPub) Transactions XRP": "List HD Wallet (xPub, yPub, zPub) Transactions", "Decode Raw Transaction Hex UTXO": "Decode Raw Transaction Hex", "Decode Raw Transaction Hex EVM": "Decode Raw Transaction Hex", "Decode Raw Transaction Hex XRP": "Decode Raw Transaction Hex", "Validate Address UTXO": "Validate Address", "Validate Address EVM": "Validate Address", "Validate Address XRP": "Validate Address" } }