Jump to
Ctrl
+
/

New Unconfirmed Tokens Transactions

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

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.

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.
To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks here.
It is also important to note that just because pending unconfirmed transactions are in the mempool, doesn't necessarily mean they will get confirmed.
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.

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

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

0x65b895f400dae5541d70cbbec07527210158f6e2
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_UNCONFIRMED
isActive boolean Required

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

true
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_UNCONFIRMED
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.

ropsten
address string Required

Defines the specific address to which the token transaction has been sent and is pending confirmation.

0x65b895f400dae5541d70cbbec07527210158f6e2
transactionId string Required

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

0x76670f3bb45c09e69173fe74834face446edf251c5f02ec30384a0957fce482b
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 transaction that is pending confirmation.

10.5
contractAddress string Required

Defines the address of the contract.

0xdac17f958d2ee523a2206206994597c13d831ec7
direction string Required

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

incoming
firstSeenInMempoolTimestamp integer Required

Defines the exact time the transaction has been first accepted into the mempool to await confirmation as timestamp.

1210363220

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": "0x65b895f400dae5541d70cbbec07527210158f6e2",
            "callbackSecretKey": "yourSecretKey",
            "callbackUrl": "https://example.com",
            "createdTimestamp": 1611238648,
            "eventType": "ADDRESS_TOKENS_TRANSACTION_UNCONFIRMED",
            "isActive": true,
            "referenceId": "c748624f-1843-4738-a7de-8258ada0f524"
        }
    }
}
{
    "apiVersion": "2021-03-20",
    "referenceId": "6038d09050653d1f0e40584c",
    "idempotencyKey": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c",
    "data": {
        "product": "BLOCKCHAIN_EVENTS",
        "event": "ADDRESS_TOKENS_TRANSACTION_UNCONFIRMED",
        "item": {
            "blockchain": "ethereum",
            "network": "ropsten",
            "address": "0x65b895f400dae5541d70cbbec07527210158f6e2",
            "transactionId": "0x76670f3bb45c09e69173fe74834face446edf251c5f02ec30384a0957fce482b",
            "tokenType": "ERC-20",
            "token": {
                "name": "Tether USD",
                "symbol": "USDT",
                "decimals": "6",
                "amount": "10.5",
                "contractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7"
            },
            "direction": "incoming",
            "firstSeenInMempoolTimestamp": 1210363220
        }
    }
}