All URIs are relative to https://rest.cryptoapis.io
| Method | HTTP request | Description |
|---|---|---|
| block_height_reached | POST /blockchain-events/{blockchain}/{network}/subscriptions/block-height-reached | Block Height Reached |
| mined_transaction | POST /blockchain-events/{blockchain}/{network}/subscriptions/transaction-mined | Mined Transaction |
| new_block | POST /blockchain-events/{blockchain}/{network}/subscriptions/block-mined | New Block |
| new_confirmed_coins_transactions | POST /blockchain-events/{blockchain}/{network}/subscriptions/address-coins-transactions-confirmed | New confirmed coins transactions |
| new_confirmed_coins_transactions_and_each_confirmation | POST /blockchain-events/{blockchain}/{network}/subscriptions/address-coins-transactions-confirmed-each-confirmation | New confirmed coins transactions and each confirmation |
| new_confirmed_internal_transactions | POST /blockchain-events/{blockchain}/{network}/subscriptions/address-internal-transactions-confirmed | New Confirmed Internal Transactions |
| new_confirmed_internal_transactions_and_each_confirmation | POST /blockchain-events/{blockchain}/{network}/subscriptions/address-internal-transactions-confirmed-each-confirmation | New Confirmed Internal Transactions And Each Confirmation |
| new_confirmed_tokens_transactions | POST /blockchain-events/{blockchain}/{network}/subscriptions/address-tokens-transactions-confirmed | New confirmed tokens transactions |
| new_confirmed_tokens_transactions_and_each_confirmation | POST /blockchain-events/{blockchain}/{network}/subscriptions/address-tokens-transactions-confirmed-each-confirmation | New confirmed tokens transactions and each confirmation |
| new_unconfirmed_coins_transactions | POST /blockchain-events/{blockchain}/{network}/subscriptions/address-coins-transactions-unconfirmed | New Unconfirmed Coins Transactions |
| new_unconfirmed_tokens_transactions | POST /blockchain-events/{blockchain}/{network}/subscriptions/address-tokens-transactions-unconfirmed | New Unconfirmed Tokens Transactions |
BlockHeightReachedR block_height_reached(blockchain, network, context=context, block_height_reached_rb=block_height_reached_rb)
Block Height Reached
Through this endpoint customers can create callback subscriptions for a specific block height that hasn't been reached yet. In this case the event is when the specified block height in the request body is reached in a said blockchain. By creating this subscription the user will be notified by Crypto APIs 2.0 when that event occurs.
- Api Key Authentication (ApiKey):
import time
import os
import cryptoapis
from cryptoapis.models.block_height_reached_r import BlockHeightReachedR
from cryptoapis.models.block_height_reached_rb import BlockHeightReachedRB
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.CreateSubscriptionsForApi(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.
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)
block_height_reached_rb = cryptoapis.BlockHeightReachedRB() # BlockHeightReachedRB | (optional)
try:
# Block Height Reached
api_response = api_instance.block_height_reached(blockchain, network, context=context, block_height_reached_rb=block_height_reached_rb)
print("The response of CreateSubscriptionsForApi->block_height_reached:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CreateSubscriptionsForApi->block_height_reached: %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. | |
| 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] |
| block_height_reached_rb | BlockHeightReachedRB | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | The resource has been successfully created. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | 409 | - |
| 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]
MinedTransactionR mined_transaction(blockchain, network, context=context, mined_transaction_rb=mined_transaction_rb)
Mined Transaction
Through this endpoint customers can create callback subscriptions for a specific event. In this case the event is when a specific transaction is mined. By creating this subscription the user will be notified by Crypto APIs 2.0 when that event occurs. The information is returned per specified transactionId. A transaction is mined when it is included in a new block in the blockchain. {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.{/note} {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}
- Api Key Authentication (ApiKey):
import time
import os
import cryptoapis
from cryptoapis.models.mined_transaction_r import MinedTransactionR
from cryptoapis.models.mined_transaction_rb import MinedTransactionRB
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.CreateSubscriptionsForApi(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.
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)
mined_transaction_rb = cryptoapis.MinedTransactionRB() # MinedTransactionRB | (optional)
try:
# Mined Transaction
api_response = api_instance.mined_transaction(blockchain, network, context=context, mined_transaction_rb=mined_transaction_rb)
print("The response of CreateSubscriptionsForApi->mined_transaction:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CreateSubscriptionsForApi->mined_transaction: %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. | |
| 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] |
| mined_transaction_rb | MinedTransactionRB | [optional] |
- Content-Type: application/json
- 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 | - |
| 409 | 409 | - |
| 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]
NewBlockR new_block(blockchain, network, context=context, new_block_rb=new_block_rb)
New Block
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. A 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. {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.{/note} {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}
- Api Key Authentication (ApiKey):
import time
import os
import cryptoapis
from cryptoapis.models.new_block_r import NewBlockR
from cryptoapis.models.new_block_rb import NewBlockRB
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.CreateSubscriptionsForApi(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.
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)
new_block_rb = cryptoapis.NewBlockRB() # NewBlockRB | (optional)
try:
# New Block
api_response = api_instance.new_block(blockchain, network, context=context, new_block_rb=new_block_rb)
print("The response of CreateSubscriptionsForApi->new_block:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CreateSubscriptionsForApi->new_block: %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. | |
| 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] |
| new_block_rb | NewBlockRB | [optional] |
- Content-Type: application/json
- 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 | - |
| 409 | 409 | - |
| 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]
NewConfirmedCoinsTransactionsR new_confirmed_coins_transactions(blockchain, network, context=context, new_confirmed_coins_transactions_rb=new_confirmed_coins_transactions_rb)
New confirmed coins transactions
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. Being confirmed means that the transactions are verified by miners and added to the next block. {note}For UTXO-based protocols like Bitcoin a transaction could have multiple inputs and outputs which means the address could in as both sender and recipient. Here is how we inform you on that.{/note} {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.{/note} {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}
- Api Key Authentication (ApiKey):
import time
import os
import cryptoapis
from cryptoapis.models.new_confirmed_coins_transactions_r import NewConfirmedCoinsTransactionsR
from cryptoapis.models.new_confirmed_coins_transactions_rb import NewConfirmedCoinsTransactionsRB
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.CreateSubscriptionsForApi(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.
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)
new_confirmed_coins_transactions_rb = cryptoapis.NewConfirmedCoinsTransactionsRB() # NewConfirmedCoinsTransactionsRB | (optional)
try:
# New confirmed coins transactions
api_response = api_instance.new_confirmed_coins_transactions(blockchain, network, context=context, new_confirmed_coins_transactions_rb=new_confirmed_coins_transactions_rb)
print("The response of CreateSubscriptionsForApi->new_confirmed_coins_transactions:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CreateSubscriptionsForApi->new_confirmed_coins_transactions: %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. | |
| 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] |
| new_confirmed_coins_transactions_rb | NewConfirmedCoinsTransactionsRB | [optional] |
NewConfirmedCoinsTransactionsR
- Content-Type: application/json
- 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 | - |
| 409 | 409 | - |
| 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]
NewConfirmedCoinsTransactionsAndEachConfirmationR new_confirmed_coins_transactions_and_each_confirmation(blockchain, network, context=context, new_confirmed_coins_transactions_and_each_confirmation_rb=new_confirmed_coins_transactions_and_each_confirmation_rb)
New confirmed coins transactions and each confirmation
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. Being confirmed means that the transactions are verified by miners and added to the next block. This endpoint refers to coins transactions only, not tokens. {note}For UTXO-based protocols like Bitcoin a transaction could have multiple inputs and outputs which means the address could in as both sender and recipient. Here is how we inform you on that.{/note} {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.{/note} {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}
- Api Key Authentication (ApiKey):
import time
import os
import cryptoapis
from cryptoapis.models.new_confirmed_coins_transactions_and_each_confirmation_r import NewConfirmedCoinsTransactionsAndEachConfirmationR
from cryptoapis.models.new_confirmed_coins_transactions_and_each_confirmation_rb import NewConfirmedCoinsTransactionsAndEachConfirmationRB
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.CreateSubscriptionsForApi(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.
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)
new_confirmed_coins_transactions_and_each_confirmation_rb = cryptoapis.NewConfirmedCoinsTransactionsAndEachConfirmationRB() # NewConfirmedCoinsTransactionsAndEachConfirmationRB | (optional)
try:
# New confirmed coins transactions and each confirmation
api_response = api_instance.new_confirmed_coins_transactions_and_each_confirmation(blockchain, network, context=context, new_confirmed_coins_transactions_and_each_confirmation_rb=new_confirmed_coins_transactions_and_each_confirmation_rb)
print("The response of CreateSubscriptionsForApi->new_confirmed_coins_transactions_and_each_confirmation:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CreateSubscriptionsForApi->new_confirmed_coins_transactions_and_each_confirmation: %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. | |
| 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] |
| new_confirmed_coins_transactions_and_each_confirmation_rb | NewConfirmedCoinsTransactionsAndEachConfirmationRB | [optional] |
NewConfirmedCoinsTransactionsAndEachConfirmationR
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | The resource has been successfully created. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | 409 | - |
| 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]
NewConfirmedInternalTransactionsR new_confirmed_internal_transactions(blockchain, network, context=context, new_confirmed_internal_transactions_rb=new_confirmed_internal_transactions_rb)
New Confirmed Internal Transactions
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. Being confirmed means that the transactions are verified by miners and added to the next block. {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.{/note} {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}
- Api Key Authentication (ApiKey):
import time
import os
import cryptoapis
from cryptoapis.models.new_confirmed_internal_transactions_r import NewConfirmedInternalTransactionsR
from cryptoapis.models.new_confirmed_internal_transactions_rb import NewConfirmedInternalTransactionsRB
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.CreateSubscriptionsForApi(api_client)
blockchain = 'ethereum-classic' # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network = 'mordor' # 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.
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)
new_confirmed_internal_transactions_rb = cryptoapis.NewConfirmedInternalTransactionsRB() # NewConfirmedInternalTransactionsRB | (optional)
try:
# New Confirmed Internal Transactions
api_response = api_instance.new_confirmed_internal_transactions(blockchain, network, context=context, new_confirmed_internal_transactions_rb=new_confirmed_internal_transactions_rb)
print("The response of CreateSubscriptionsForApi->new_confirmed_internal_transactions:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CreateSubscriptionsForApi->new_confirmed_internal_transactions: %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. | |
| 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] |
| new_confirmed_internal_transactions_rb | NewConfirmedInternalTransactionsRB | [optional] |
NewConfirmedInternalTransactionsR
- Content-Type: application/json
- 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 | - |
| 409 | 409 | - |
| 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]
NewConfirmedInternalTransactionsAndEachConfirmationR new_confirmed_internal_transactions_and_each_confirmation(blockchain, network, context=context, new_confirmed_internal_transactions_and_each_confirmation_rb=new_confirmed_internal_transactions_and_each_confirmation_rb)
New Confirmed Internal Transactions And Each Confirmation
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. Being confirmed means that the transactions are verified by miners and added to the next block. {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.{/note} {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}
- Api Key Authentication (ApiKey):
import time
import os
import cryptoapis
from cryptoapis.models.new_confirmed_internal_transactions_and_each_confirmation_r import NewConfirmedInternalTransactionsAndEachConfirmationR
from cryptoapis.models.new_confirmed_internal_transactions_and_each_confirmation_rb import NewConfirmedInternalTransactionsAndEachConfirmationRB
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.CreateSubscriptionsForApi(api_client)
blockchain = 'ethereum-classic' # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network = 'mordor' # 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.
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)
new_confirmed_internal_transactions_and_each_confirmation_rb = cryptoapis.NewConfirmedInternalTransactionsAndEachConfirmationRB() # NewConfirmedInternalTransactionsAndEachConfirmationRB | (optional)
try:
# New Confirmed Internal Transactions And Each Confirmation
api_response = api_instance.new_confirmed_internal_transactions_and_each_confirmation(blockchain, network, context=context, new_confirmed_internal_transactions_and_each_confirmation_rb=new_confirmed_internal_transactions_and_each_confirmation_rb)
print("The response of CreateSubscriptionsForApi->new_confirmed_internal_transactions_and_each_confirmation:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CreateSubscriptionsForApi->new_confirmed_internal_transactions_and_each_confirmation: %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. | |
| 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] |
| new_confirmed_internal_transactions_and_each_confirmation_rb | NewConfirmedInternalTransactionsAndEachConfirmationRB | [optional] |
NewConfirmedInternalTransactionsAndEachConfirmationR
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | The resource has been successfully created. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | 409 | - |
| 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]
NewConfirmedTokensTransactionsR new_confirmed_tokens_transactions(blockchain, network, context=context, new_confirmed_tokens_transactions_rb=new_confirmed_tokens_transactions_rb)
New confirmed tokens transactions
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. Being confirmed means that the transactions are verified by miners and added to the next block. This endpoint refers to tokens transactions only, not coins. {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.{/note} {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}
- Api Key Authentication (ApiKey):
import time
import os
import cryptoapis
from cryptoapis.models.new_confirmed_tokens_transactions_r import NewConfirmedTokensTransactionsR
from cryptoapis.models.new_confirmed_tokens_transactions_rb import NewConfirmedTokensTransactionsRB
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.CreateSubscriptionsForApi(api_client)
blockchain = 'ethereum' # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network = 'ropsten' # 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.
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)
new_confirmed_tokens_transactions_rb = cryptoapis.NewConfirmedTokensTransactionsRB() # NewConfirmedTokensTransactionsRB | (optional)
try:
# New confirmed tokens transactions
api_response = api_instance.new_confirmed_tokens_transactions(blockchain, network, context=context, new_confirmed_tokens_transactions_rb=new_confirmed_tokens_transactions_rb)
print("The response of CreateSubscriptionsForApi->new_confirmed_tokens_transactions:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CreateSubscriptionsForApi->new_confirmed_tokens_transactions: %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. | |
| 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] |
| new_confirmed_tokens_transactions_rb | NewConfirmedTokensTransactionsRB | [optional] |
NewConfirmedTokensTransactionsR
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | The resource has been successfully created. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | 409 | - |
| 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]
NewConfirmedTokensTransactionsAndEachConfirmationR new_confirmed_tokens_transactions_and_each_confirmation(blockchain, network, context=context, new_confirmed_tokens_transactions_and_each_confirmation_rb=new_confirmed_tokens_transactions_and_each_confirmation_rb)
New confirmed tokens transactions and each confirmation
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. Being confirmed means that the transactions are verified by miners and added to the next block. This endpoint refers to tokens transactions only, not coins. {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.{/note} {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}
- Api Key Authentication (ApiKey):
import time
import os
import cryptoapis
from cryptoapis.models.new_confirmed_tokens_transactions_and_each_confirmation_r import NewConfirmedTokensTransactionsAndEachConfirmationR
from cryptoapis.models.new_confirmed_tokens_transactions_and_each_confirmation_rb import NewConfirmedTokensTransactionsAndEachConfirmationRB
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.CreateSubscriptionsForApi(api_client)
blockchain = 'ethereum' # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network = 'ropsten' # 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.
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)
new_confirmed_tokens_transactions_and_each_confirmation_rb = cryptoapis.NewConfirmedTokensTransactionsAndEachConfirmationRB() # NewConfirmedTokensTransactionsAndEachConfirmationRB | (optional)
try:
# New confirmed tokens transactions and each confirmation
api_response = api_instance.new_confirmed_tokens_transactions_and_each_confirmation(blockchain, network, context=context, new_confirmed_tokens_transactions_and_each_confirmation_rb=new_confirmed_tokens_transactions_and_each_confirmation_rb)
print("The response of CreateSubscriptionsForApi->new_confirmed_tokens_transactions_and_each_confirmation:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CreateSubscriptionsForApi->new_confirmed_tokens_transactions_and_each_confirmation: %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. | |
| 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] |
| new_confirmed_tokens_transactions_and_each_confirmation_rb | NewConfirmedTokensTransactionsAndEachConfirmationRB | [optional] |
NewConfirmedTokensTransactionsAndEachConfirmationR
- Content-Type: application/json
- 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 | - |
| 409 | 409 | - |
| 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]
NewUnconfirmedCoinsTransactionsR new_unconfirmed_coins_transactions(blockchain, network, context=context, new_unconfirmed_coins_transactions_rb=new_unconfirmed_coins_transactions_rb)
New Unconfirmed Coins Transactions
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. Unconfirmed 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. {note}For UTXO-based protocols like Bitcoin a transaction could have multiple inputs and outputs which means the address could in as both sender and recipient. Here is how we inform you on that.{/note} {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} {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.{/note} {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} {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}
- Api Key Authentication (ApiKey):
import time
import os
import cryptoapis
from cryptoapis.models.new_unconfirmed_coins_transactions_r import NewUnconfirmedCoinsTransactionsR
from cryptoapis.models.new_unconfirmed_coins_transactions_rb import NewUnconfirmedCoinsTransactionsRB
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.CreateSubscriptionsForApi(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.
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)
new_unconfirmed_coins_transactions_rb = cryptoapis.NewUnconfirmedCoinsTransactionsRB() # NewUnconfirmedCoinsTransactionsRB | (optional)
try:
# New Unconfirmed Coins Transactions
api_response = api_instance.new_unconfirmed_coins_transactions(blockchain, network, context=context, new_unconfirmed_coins_transactions_rb=new_unconfirmed_coins_transactions_rb)
print("The response of CreateSubscriptionsForApi->new_unconfirmed_coins_transactions:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CreateSubscriptionsForApi->new_unconfirmed_coins_transactions: %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. | |
| 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] |
| new_unconfirmed_coins_transactions_rb | NewUnconfirmedCoinsTransactionsRB | [optional] |
NewUnconfirmedCoinsTransactionsR
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | The resource has been successfully created. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | 409 | - |
| 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]
NewUnconfirmedTokensTransactionsR new_unconfirmed_tokens_transactions(blockchain, network, context=context, new_unconfirmed_tokens_transactions_rb=new_unconfirmed_tokens_transactions_rb)
New Unconfirmed Tokens Transactions
Through this endpoint customers can create callback subscriptions for a specific event. In this case the event is when there are new unconfirmed tokens 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. Unconfirmed tokens 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. {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} {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.{/note} {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} {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}
- Api Key Authentication (ApiKey):
import time
import os
import cryptoapis
from cryptoapis.models.new_unconfirmed_tokens_transactions_r import NewUnconfirmedTokensTransactionsR
from cryptoapis.models.new_unconfirmed_tokens_transactions_rb import NewUnconfirmedTokensTransactionsRB
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.CreateSubscriptionsForApi(api_client)
blockchain = 'ethereum' # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network = 'ropsten' # 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.
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)
new_unconfirmed_tokens_transactions_rb = cryptoapis.NewUnconfirmedTokensTransactionsRB() # NewUnconfirmedTokensTransactionsRB | (optional)
try:
# New Unconfirmed Tokens Transactions
api_response = api_instance.new_unconfirmed_tokens_transactions(blockchain, network, context=context, new_unconfirmed_tokens_transactions_rb=new_unconfirmed_tokens_transactions_rb)
print("The response of CreateSubscriptionsForApi->new_unconfirmed_tokens_transactions:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CreateSubscriptionsForApi->new_unconfirmed_tokens_transactions: %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. | |
| 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] |
| new_unconfirmed_tokens_transactions_rb | NewUnconfirmedTokensTransactionsRB | [optional] |
NewUnconfirmedTokensTransactionsR
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | The resource has been successfully created. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | 409 | - |
| 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]