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.
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
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.
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context
is specified by the user.
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context
is specified by the user.
Represents the address of the transaction, per which the result is returned.
Specifies a flag that permits or denies the creation of duplicate addresses.
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.
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
.
Defines the exact confirmation, on which user can receive a callback.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId
is generated by Crypto APIs and it's unique for every request.
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context
is specified by the user.
Represents the address of the transaction, per which the result is returned.
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.
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
.
Defines the specific time/date when the subscription was created in Unix Timestamp.
Defines the type of the specific event available for the customer to subscribe to for callback notification.
Defines whether the subscription is active or not. Set as boolean.
Represents the exact confirmation, on which the user wants to receive callback.
Represents a unique ID used to reference the specific callback subscription.
Specifies the version of the API that incorporates this endpoint.
Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.
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.
Specifies all data, as attributes, included into the callback notification, which depends on the event
.
Represents the Crypto APIs 2.0 product which sends the callback.
Defines the specific event, for which a callback subscription is set.
Defines an item
as one result.
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
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.
Defines the specific address to which the transaction has been sent.
Refers to the specific block the transaction was mined in.
Defines the number of blocks in the blockchain preceding this specific block.
Represents the hash of the block's header, i.e. an output that has a fixed length.
Defines the exact date/time when this transaction was mined in seconds since Unix Epoch time.
Defines the unique ID of the specific transaction, i.e. its identification number.
Defines the type of token sent with the transaction, e.g. ERC 20.
Specifies the name of the token.
Specifies an identifier of the token, where up to five alphanumeric characters can be used for it.
Defines how many decimals can be used to break the token.
Defines the amount of tokens sent with the confirmed transaction.
Defines the address of the contract.
Defines whether the transaction is "incoming" or "outgoing".
API Key
{
"context": "yourExampleString",
"data": {
"item": {
"address": "0x6890303Cfca4f2571c3A5A5982b44c0Ca82b124A",
"allowDuplicates": false,
"callbackSecretKey": "yourSecretKey",
"callbackUrl": "https://example.com",
"receiveCallbackOn": 3
}
}
}
{
"apiVersion": "2023-04-25",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"data": {
"item": {
"address": "0x7495fede000c8a3b77eeae09cf70fa94cd2d53f5",
"callbackSecretKey": "yourSecretKey",
"callbackUrl": "https://example.com",
"createdTimestamp": 1611238648,
"eventType": "ADDRESS_TOKENS_TRANSACTION_CONFIRMED",
"isActive": true,
"receiveCallbackOn": 3,
"referenceId": "c748624f-1843-4738-a7de-8258ada0f524"
}
}
}
{
"apiVersion": "2021-03-20",
"referenceId": "6038d09050653d1f0e40584c",
"idempotencyKey": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c",
"data": {
"product": "BLOCKCHAIN_EVENTS",
"event": "ADDRESS_TOKENS_TRANSACTION_CONFIRMED",
"item": {
"blockchain": "ethereum",
"network": "goerli",
"address": "0x7495fede000c8a3b77eeae09cf70fa94cd2d53f5",
"minedInBlock": {
"height": 657915,
"hash": "269b0de44db95beddb6aecc520b375ba8f91f3dc5558a24aa4c26979eb00c7e2",
"timestamp": 1586365500
},
"transactionId": "0xbe38781783b1b9d480219255ff98e20335a39e13979a66112efa33f05fde0a33",
"tokenType": "ERC-20",
"token": {
"name": "Tether USD",
"symbol": "USDT",
"decimals": "6",
"amount": "0.00039",
"contractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7"
},
"direction": "incoming"
}
}
}