Jump to
Ctrl
+
/

Block Height Reached

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

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
allowDuplicates boolean Optional

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

Default : false
blockHeightReached integer Required

Represents the specified value of block height for which the callback will be received.

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
blockHeightReached integer Required

Represents the specified value of block height for which the callback will be received.

667900
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
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_EVENTS
event string Required

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

BLOCK_HEIGHT_REACHED
item object Required

Defines an item as one result.

blockchain string Required

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

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

testnet
height integer Required

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

667900
hash string Required

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

00000000000000000006ddb5e854505f8b792122b0ac9469c07eb26db414f6fb
timestamp integer Required

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

1610365615

Credits Cost : 10000 Credits for 1 Results

Was this page helpful?
Yes
No
Language
URL

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "blockHeightReached": 667900,
            "callbackSecretKey": "yourSecretKey",
            "callbackUrl": "https://example.com",
            "createdTimestamp": 1611238648,
            "isActive": true,
            "referenceId": "bc243c86-0902-4386-b30d-e6b30fa1f2aa"
        }
    }
}
{
    "apiVersion": "2021-03-20",
    "referenceId": "6038d09050653d1f0e40584c",
    "idempotencyKey": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c",
    "data": {
        "product": "BLOCKCHAIN_EVENTS",
        "event": "BLOCK_HEIGHT_REACHED",
        "item": {
            "blockchain": "bitcoin",
            "network": "testnet",
            "height": 667900,
            "hash": "00000000000000000006ddb5e854505f8b792122b0ac9469c07eb26db414f6fb",
            "timestamp": 1610365615
        }
    }
}