Jump to
Ctrl
+
/

New confirmed tokens transactions

POST
/blockchain-events/{blockchain}/{network}/subscriptions/address-tokens-transactions-confirmed

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.

To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks here.
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.

Path Parameters

blockchain string Required

Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

network string Required

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.

Query Parameters

context string Optional

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

Request Body Schema application/json

context string Optional

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

data object Required
item object Required
address string Required

Represents the address of the transaction, per which the result is returned.

allowDuplicates boolean Optional

Specifies a flag that permits or denies the creation of duplicate addresses.

Default : false
callbackSecretKey string Optional

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.

callbackUrl string Required

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.

receiveCallbackOn integer Optional

Represents the exact confirmation, on which the user wants to receive callback.

Response Schema

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2021-03-20
requestId string Required

Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

601c1710034ed6d407996b30
context string Optional

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

yourExampleString
data object Required
item object Required
address string Required

Represents the address of the transaction, per which the result is returned.

0x7495fede000c8a3b77eeae09cf70fa94cd2d53f5
callbackSecretKey string Required

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.

yourSecretKey
callbackUrl string Required

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.

https://example.com
createdTimestamp integer Required

Defines the specific time/date when the subscription was created in Unix Timestamp.

1611238648
eventType string Required

Defines the type of the specific event available for the customer to subscribe to for callback notification.

ADDRESS_TOKENS_TRANSACTION_CONFIRMED
isActive boolean Required

Defines whether the subscription is active or not. Set as boolean.

true
receiveCallbackOn integer Required

Represents the exact confirmation, on which the user wants to receive callback.

3
referenceId string Required

Represents a unique ID used to reference the specific callback subscription.

c748624f-1843-4738-a7de-8258ada0f524

Callback parameters

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2021-03-20
referenceId string Required

Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.

6038d09050653d1f0e40584c
idempotencyKey string Required

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.

e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c
data object Required

Specifies all data, as attributes, included into the callback notification, which depends on the event.

product string Required

Represents the Crypto APIs 2.0 product which sends the callback.

BLOCKCHAIN_EVENTS
event string Required

Defines the specific event, for which a callback subscription is set.

ADDRESS_TOKENS_TRANSACTION_CONFIRMED
item object Required

Defines an item as one result.

blockchain string Required

Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

ethereum
network string Required

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.

goerli
address string Required

Defines the specific address to which the transaction has been sent.

0x7495fede000c8a3b77eeae09cf70fa94cd2d53f5
minedInBlock object Required

Refers to the specific block the transaction was mined in.

height integer Required

Defines the number of blocks in the blockchain preceding this specific block.

657915
hash string Required

Represents the hash of the block's header, i.e. an output that has a fixed length.

269b0de44db95beddb6aecc520b375ba8f91f3dc5558a24aa4c26979eb00c7e2
timestamp integer Required

Defines the exact date/time when this transaction was mined in seconds since Unix Epoch time.

1586365500
transactionId string Required

Defines the unique ID of the specific transaction, i.e. its identification number.

0xbe38781783b1b9d480219255ff98e20335a39e13979a66112efa33f05fde0a33
tokenType string Required

Defines the type of token sent with the transaction, e.g. ERC 20.

ERC-20
token object Required
name string Required

Specifies the name of the token.

Tether USD
symbol string Required

Specifies an identifier of the token, where up to five alphanumeric characters can be used for it.

USDT
decimals string Optional

Defines how many decimals can be used to break the token.

6
amount string Required

Defines the amount of tokens sent with the confirmed transaction.

0.00039
contractAddress string Required

Defines the address of the contract.

0xdac17f958d2ee523a2206206994597c13d831ec7
direction string Required

Defines whether the transaction is "incoming" or "outgoing".

incoming

Credits Cost : 1000 Credits for 1 Results

Was this page helpful?
Yes
No
Language
URL

{
    "apiVersion": "2021-03-20",
    "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"
        }
    }
}