All URIs are relative to https://rest.cryptoapis.io
| Method | HTTP request | Description |
|---|---|---|
| get_address_details_from_callback | GET /blockchain-events/{blockchain}/{network}/addresses/{address} | Get Address Details From Callback |
| get_block_details_by_block_hash_from_callback | GET /blockchain-events/{blockchain}/{network}/blocks/hash/{blockHash} | Get Block Details By Block Hash From Callback |
| get_block_details_by_block_height_from_callback | GET /blockchain-events/{blockchain}/{network}/blocks/height/{blockHeight} | Get Block Details By Block Height From Callback |
| get_transaction_details_by_transaction_id_from_callback | GET /blockchain-events/{blockchain}/{network}/transactions/{transactionId} | Get Transaction Details By Transaction ID From Callback |
GetAddressDetailsFromCallbackR get_address_details_from_callback(blockchain, network, address)
Get Address Details From Callback
This endpoint creates a shortcut to obtain information from Blockchain data by going through Blockchain Events and a specific Event Subscription. It provides data for a specific address from the Event it takes part in only if the address already exists in the blockchain events subscriptions. It applies only for Events related to that customer.
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import callback_data_api
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.convert_bitcoin_cash_address422_response import ConvertBitcoinCashAddress422Response
from cryptoapis.model.get_address_details_from_callback400_response import GetAddressDetailsFromCallback400Response
from cryptoapis.model.get_address_details_from_callback_r import GetAddressDetailsFromCallbackR
from cryptoapis.model.get_address_details_from_callback404_response import GetAddressDetailsFromCallback404Response
from cryptoapis.model.get_address_details_from_callback403_response import GetAddressDetailsFromCallback403Response
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.convert_bitcoin_cash_address409_response import ConvertBitcoinCashAddress409Response
from cryptoapis.model.get_address_details_from_callback401_response import GetAddressDetailsFromCallback401Response
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = callback_data_api.CallbackDataApi(api_client)
blockchain = "bitcoin" # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network = "testnet" # str | 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.
address = "mzYijhgmzZrmuB7wBDazRKirnChKyow4M3" # str | Represents the public address, which is a compressed and shortened form of a public key.
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
# example passing only required values which don't have defaults set
try:
# Get Address Details From Callback
api_response = api_instance.get_address_details_from_callback(blockchain, network, address)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling CallbackDataApi->get_address_details_from_callback: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get Address Details From Callback
api_response = api_instance.get_address_details_from_callback(blockchain, network, address, context=context)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling CallbackDataApi->get_address_details_from_callback: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| blockchain | str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | |
| network | str | 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. | |
| address | str | Represents the public address, which is a compressed and shortened form of a public key. | |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
GetAddressDetailsFromCallbackR
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The request has been successful. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 404 | The provided address has no subscriptions. | - |
| 409 | The data provided seems to be invalid. | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | Your request body for POST requests must have a structure of { data: { item: [...properties] } } | - |
| 429 | 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. | - |
| 500 | 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. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetBlockDetailsByBlockHashFromCallbackR get_block_details_by_block_hash_from_callback(blockchain, network, block_hash)
Get Block Details By Block Hash From Callback
This endpoint creates a shortcut to obtain information from Blockchain data by going through Blockchain Events and a specific Event Subscription. It provides data for a specific block by providing the blockHash attribute from the Event it takes part in and after making check that the customer in question does have a subscription for this block. It applies only for Events related to that user.
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import callback_data_api
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.convert_bitcoin_cash_address422_response import ConvertBitcoinCashAddress422Response
from cryptoapis.model.get_block_details_by_block_hash_from_callback401_response import GetBlockDetailsByBlockHashFromCallback401Response
from cryptoapis.model.get_block_details_by_block_hash_from_callback400_response import GetBlockDetailsByBlockHashFromCallback400Response
from cryptoapis.model.get_block_details_by_block_hash_from_callback403_response import GetBlockDetailsByBlockHashFromCallback403Response
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.convert_bitcoin_cash_address409_response import ConvertBitcoinCashAddress409Response
from cryptoapis.model.list_transactions_by_block_height404_response import ListTransactionsByBlockHeight404Response
from cryptoapis.model.get_block_details_by_block_hash_from_callback_r import GetBlockDetailsByBlockHashFromCallbackR
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = callback_data_api.CallbackDataApi(api_client)
blockchain = "bitcoin" # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network = "testnet" # str | 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.
block_hash = "000000000000000bdea8ba7df4bfd9f398e428fde8ee47152bcf93834ee48e8a" # str | 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.
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
# example passing only required values which don't have defaults set
try:
# Get Block Details By Block Hash From Callback
api_response = api_instance.get_block_details_by_block_hash_from_callback(blockchain, network, block_hash)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling CallbackDataApi->get_block_details_by_block_hash_from_callback: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get Block Details By Block Hash From Callback
api_response = api_instance.get_block_details_by_block_hash_from_callback(blockchain, network, block_hash, context=context)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling CallbackDataApi->get_block_details_by_block_hash_from_callback: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| blockchain | str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | |
| network | str | 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. | |
| block_hash | str | 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. | |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
GetBlockDetailsByBlockHashFromCallbackR
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The request has been successful. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 404 | The specified block has not been found on the specific blockchain. | - |
| 409 | The data provided seems to be invalid. | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | Your request body for POST requests must have a structure of { data: { item: [...properties] } } | - |
| 429 | 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. | - |
| 500 | 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. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetBlockDetailsByBlockHeightFromCallbackR get_block_details_by_block_height_from_callback(blockchain, network, block_height)
Get Block Details By Block Height From Callback
This endpoint creates a shortcut to obtain information from Blockchain data by going through Blockchain Events and a specific Event Subscription. It provides data for the specific Block by providing the blockHeight attribute from the Event it takes part in. It applies only for Events related to that user.
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import callback_data_api
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.convert_bitcoin_cash_address422_response import ConvertBitcoinCashAddress422Response
from cryptoapis.model.get_block_details_by_block_height_from_callback401_response import GetBlockDetailsByBlockHeightFromCallback401Response
from cryptoapis.model.get_block_details_by_block_height_from_callback400_response import GetBlockDetailsByBlockHeightFromCallback400Response
from cryptoapis.model.get_block_details_by_block_height_from_callback403_response import GetBlockDetailsByBlockHeightFromCallback403Response
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.convert_bitcoin_cash_address409_response import ConvertBitcoinCashAddress409Response
from cryptoapis.model.list_transactions_by_block_height404_response import ListTransactionsByBlockHeight404Response
from cryptoapis.model.get_block_details_by_block_height_from_callback_r import GetBlockDetailsByBlockHeightFromCallbackR
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = callback_data_api.CallbackDataApi(api_client)
blockchain = "bitcoin" # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network = "testnet" # str | 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.
block_height = "673852" # str | 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\".
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
# example passing only required values which don't have defaults set
try:
# Get Block Details By Block Height From Callback
api_response = api_instance.get_block_details_by_block_height_from_callback(blockchain, network, block_height)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling CallbackDataApi->get_block_details_by_block_height_from_callback: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get Block Details By Block Height From Callback
api_response = api_instance.get_block_details_by_block_height_from_callback(blockchain, network, block_height, context=context)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling CallbackDataApi->get_block_details_by_block_height_from_callback: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| blockchain | str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | |
| network | str | 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. | |
| block_height | str | 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". | |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
GetBlockDetailsByBlockHeightFromCallbackR
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The request has been successful. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 404 | The specified block has not been found on the specific blockchain. | - |
| 409 | The data provided seems to be invalid. | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | Your request body for POST requests must have a structure of { data: { item: [...properties] } } | - |
| 429 | 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. | - |
| 500 | 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. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetTransactionDetailsByTransactionIDFromCallbackR get_transaction_details_by_transaction_id_from_callback(blockchain, network, transaction_id)
Get Transaction Details By Transaction ID From Callback
This endpoint creates a shortcut to obtain information from Blockchain data by going through Blockchain Events and a specific Event Subscription. It provides data for a specific transaction from the Event it takes part in by providing the transactionId attribute. It applies only for Events related to that user.
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import callback_data_api
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.convert_bitcoin_cash_address422_response import ConvertBitcoinCashAddress422Response
from cryptoapis.model.get_transaction_details_by_transaction_id_from_callback_r import GetTransactionDetailsByTransactionIDFromCallbackR
from cryptoapis.model.get_transaction_details_by_transaction_id_from_callback401_response import GetTransactionDetailsByTransactionIDFromCallback401Response
from cryptoapis.model.get_xrp_ripple_transaction_details_by_transaction_id404_response import GetXRPRippleTransactionDetailsByTransactionID404Response
from cryptoapis.model.get_transaction_details_by_transaction_id_from_callback403_response import GetTransactionDetailsByTransactionIDFromCallback403Response
from cryptoapis.model.get_transaction_details_by_transaction_id_from_callback400_response import GetTransactionDetailsByTransactionIDFromCallback400Response
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.convert_bitcoin_cash_address409_response import ConvertBitcoinCashAddress409Response
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = callback_data_api.CallbackDataApi(api_client)
blockchain = "bitcoin" # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network = "testnet" # str | 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.
transaction_id = "8888f6c8168ff69aaf6438ab185c690e8c76c63e5f9c472c1c86f08406ea74f2" # str | 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.
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
# example passing only required values which don't have defaults set
try:
# Get Transaction Details By Transaction ID From Callback
api_response = api_instance.get_transaction_details_by_transaction_id_from_callback(blockchain, network, transaction_id)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling CallbackDataApi->get_transaction_details_by_transaction_id_from_callback: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get Transaction Details By Transaction ID From Callback
api_response = api_instance.get_transaction_details_by_transaction_id_from_callback(blockchain, network, transaction_id, context=context)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling CallbackDataApi->get_transaction_details_by_transaction_id_from_callback: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| blockchain | str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | |
| network | str | 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. | |
| transaction_id | str | 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. | |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
GetTransactionDetailsByTransactionIDFromCallbackR
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The request has been successful. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 404 | The specified resource has not been found. | - |
| 409 | The data provided seems to be invalid. | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | Your request body for POST requests must have a structure of { data: { item: [...properties] } } | - |
| 429 | 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. | - |
| 500 | 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. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]