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
-
Requiredblockchain string
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
-
Requirednetwork string
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", "ropsten" are test networks.
Query parameters
-
Optionalcontext string
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
-
Optionalcontext string
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. -
Requireddata object
-
Requireditem object
-
OptionalallowDuplicates boolean
Specifies a flag that permits or denies the creation of duplicate addresses.
-
RequiredblockHeightReached integer
Represents the specified value of block height for which the callback will be received.
-
OptionalcallbackSecretKey string
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.
-
RequiredcallbackUrl string
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
Content-Type: application/json
The resource has been successfully created.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
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.Example : yourExampleString -
Requireddata object
-
Requireditem object
-
RequiredblockHeightReached integer
Represents the specified value of block height for which the callback will be received.
Example : 667900 -
RequiredcallbackSecretKey string
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.
Example : yourSecretKey -
RequiredcallbackUrl string
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.
Example : https://example.com -
RequiredcreatedTimestamp integer
Defines the specific time/date when the subscription was created in Unix Timestamp.
Example : 1611238648 -
RequiredisActive boolean
Defines whether the subscription is active or not. Set as boolean.
Example : True -
RequiredreferenceId string
Represents a unique ID used to reference the specific callback subscription.
Example : bc243c86-0902-4386-b30d-e6b30fa1f2aa
-
-
Callback parameters Method : POST
Content-Type : application/json
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredreferenceId string
Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.
Example : 6038d09050653d1f0e40584c -
RequiredidempotencyKey string
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.
Example : e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c -
Requireddata object
Specifies all data, as attributes, included into the callback notification, which depends on the
event
.-
Requiredproduct string
Represents the Crypto APIs 2.0 product which sends the callback.
Example : BLOCKCHAIN_EVENTS -
Requiredevent string
Defines the specific event, for which a callback subscription is set.
Example : BLOCK_HEIGHT_REACHED -
Requireditem object
Defines an
item
as one result.-
Requiredblockchain string
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
Example : bitcoin -
Requirednetwork string
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", "ropsten", "rinkeby" are test networks.
Example : testnet -
Requiredheight integer
Defines the number of blocks in the blockchain preceding this specific block.
Example : 667900 -
Requiredhash string
Represents the hash of the block's header, i.e. an output that has a fixed length.
Example : 00000000000000000006ddb5e854505f8b792122b0ac9469c07eb26db414f6fb -
Requiredtimestamp integer
Defines the exact date/time when this block was mined in seconds since Unix Epoch time.
Example : 1610365615
-
-