New Block
Through this endpoint customers can create callback subscriptions for a specific event. In this case the event is when a new block is mined in the specific blockchain. 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.
A new block is mined when it is added to the chain once a consensus is reached by the majority of the miners, which is when the block gets validated and added to the blockchain.
Path Parameters
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
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
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
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.
Specifies a flag that permits or denies the creation of duplicate addresses.
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.
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
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
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.
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.
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.
Defines the specific time/date when the subscription was created in Unix Timestamp.
Defines whether the subscription is active or not. Set as boolean.
Represents a unique ID used to reference the specific callback subscription.
Callback parameters
Specifies the version of the API that incorporates this endpoint.
Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.
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.
Specifies all data, as attributes, included into the callback notification, which depends on the event.
Represents the Crypto APIs 2.0 product which sends the callback.
Defines the specific event, for which a callback subscription is set.
Defines an item as one result.
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
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.
Defines the number of blocks in the blockchain preceding this specific block.
Represents the hash of the block's header, i.e. an output that has a fixed length.
Defines the exact date/time when this block was mined in seconds since Unix Epoch time.
Credits Cost : 400 Credits for 1 Results
API Key
{
"context": "yourExampleString",
"data": {
"item": {
"allowDuplicates": false,
"callbackSecretKey": "yourSecretKey",
"callbackUrl": "https://example.com"
}
}
}
{
"apiVersion": "2023-04-25",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"data": {
"item": {
"callbackSecretKey": "yourSecretKey",
"callbackUrl": "https://yourURL.com",
"createdTimestamp": 1611238648,
"isActive": true,
"referenceId": "4c530a43-5602-41d9-bc69-156a0372f9aa"
}
}
}{
"apiVersion": "2021-03-20",
"referenceId": "6038d09050653d1f0e40584c",
"idempotencyKey": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c",
"data": {
"product": "BLOCKCHAIN_EVENTS",
"event": "BLOCK_MINED",
"item": {
"blockchain": "bitcoin",
"network": "testnet",
"height": 570008,
"hash": "00000000000000000006ddb5e854505f8b792122b0ac9469c07eb26db414f6fb",
"timestamp": 1610365615
}
}
}