Jump to
Ctrl
+
/

New Confirmed Internal Transactions And Each Confirmation

POST
/blockchain-events/{blockchain}/{network}/subscriptions/address-internal-transactions-confirmed-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.

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

Defines the specific address of the internal transaction.

allowDuplicates boolean Required

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

Default : false
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.

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.

confirmationsCount integer Required

Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.

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 specific address of the internal transaction.

0xe2b5f5e885a268e4b6faae53f99a663f3bb3e036
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
confirmationsCount integer Required

Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.

3
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_INTERNAL_TRANSACTION_CONFIRMED_EACH_CONFIRMATION
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.

bc243c86-0902-4386-b30d-e6b30fa1f2aa

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_DATA
event string Required

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

ADDRESS_INTERNAL_TRANSACTION_CONFIRMED_EACH_CONFIRMATION
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.

mainnet
address string Required

Defines the specific address of the internal transaction.

0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2
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.

12566992
hash string Required

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

0x936a34ef544e6fc9fc5f68fb086b9e8ea0e5eca52cb45cb67b27d174bccc35a5
timestamp integer Required

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

1622796751
parentTransactionId string Required

Defines the Parent Transaction's unique ID.

0x5fc77216fdfb8c966387030be7bda4bacce0232f7115722ef5b228a223974784
operationId string Required

Defines the specific operation's unique ID.

call_1_0_1_0_3_0
currentConfirmations integer Required

Defines the number of currently received confirmations for the transaction.

2
targetConfirmations integer Required

Defines the number of confirmation transactions requested as callbacks, i.e. the system can notify till the n-th confirmation.

3
amount string Required

Defines the amount of coins sent with the confirmed transaction.

0.05710541741945074
unit string Required

Defines the unit of the transaction, e.g. Gwei.

ETH
direction string Required

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

outgoing

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": "0xe2b5f5e885a268e4b6faae53f99a663f3bb3e036",
            "callbackSecretKey": "yourSecretKey",
            "callbackUrl": "https://example.com",
            "confirmationsCount": 3,
            "createdTimestamp": 1611238648,
            "eventType": "ADDRESS_INTERNAL_TRANSACTION_CONFIRMED_EACH_CONFIRMATION",
            "isActive": true,
            "referenceId": "bc243c86-0902-4386-b30d-e6b30fa1f2aa"
        }
    }
}
{
    "apiVersion": "2021-03-20",
    "referenceId": "6038d09050653d1f0e40584c",
    "idempotencyKey": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c",
    "data": {
        "product": "BLOCKCHAIN_DATA",
        "event": "ADDRESS_INTERNAL_TRANSACTION_CONFIRMED_EACH_CONFIRMATION",
        "item": {
            "blockchain": "ethereum",
            "network": "mainnet",
            "address": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
            "minedInBlock": {
                "height": 12566992,
                "hash": "0x936a34ef544e6fc9fc5f68fb086b9e8ea0e5eca52cb45cb67b27d174bccc35a5",
                "timestamp": 1622796751
            },
            "parentTransactionId": "0x5fc77216fdfb8c966387030be7bda4bacce0232f7115722ef5b228a223974784",
            "operationId": "call_1_0_1_0_3_0",
            "currentConfirmations": 2,
            "targetConfirmations": 3,
            "amount": "0.05710541741945074",
            "unit": "ETH",
            "direction": "outgoing"
        }
    }
}