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.

Supports Callback Functionality Single Result - This endpoint returns only one single result. POST /blockchain-events/{blockchain}/{network}/subscriptions/block-height-reached

Path Parameters

Required
blockchain string

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

Example : bitcoin

Possible Values : bitcoin bitcoin-cash dash dogecoin zcash litecoin ethereum ethereum-classic binance-smart-chain xrp tron
Required
network 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.

Example : testnet

Possible Values : mainnet testnet mordor nile goerli

Query parameters

Optional
context 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

Request body schema application/json

Optional
context 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
Required
data object
- Required
  item object
  - Optional
    allowDuplicates boolean
    
    Specifies a flag that permits or denies the creation of duplicate addresses.
    
    Default : False
    
    Example : True
  - Required
    blockHeightReached integer
    
    Represents the specified value of block height for which the callback will be received.
    
    Example : 667900
  - Optional
    callbackSecretKey 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
  - Required
    callbackUrl 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

Response schema

201 400 401 402 403 409 415 422 429 500

HTTP Status Code: 201
Content-Type: application/json

The resource has been successfully created.

Object :
Required
apiVersion string

Specifies the version of the API that incorporates this endpoint.

Example : 2023-04-25
Required
requestId string

Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

Example : 601c1710034ed6d407996b30
Optional
context 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
Required
data
object
- Required
  item object
  
  Required
  blockHeightReached integer
  
  Represents the specified value of block height for which the callback will be received.
  
  Example : 667900
  
  Required
  callbackSecretKey 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
  
  Required
  callbackUrl 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
  
  Required
  createdTimestamp integer
  
  Defines the specific time/date when the subscription was created in Unix Timestamp.
  
  Example : 1611238648
  
  Required
  isActive boolean
  
  Defines whether the subscription is active or not. Set as boolean.
  
  Example : True
  
  Required
  referenceId string
  
  Represents a unique ID used to reference the specific callback subscription.
  
  Example : bc243c86-0902-4386-b30d-e6b30fa1f2aa

Callback parameters Method : POST

You can use the optional parameter callbackSecretKey in your request for additional security. It is then used to create a unique hash string in the x-signature response header in the callback request itself. For more information, please see our Documentation.

BLOCK_HEIGHT_REACHED

Content-Type : application/json

Object :
Required
apiVersion string

Specifies the version of the API that incorporates this endpoint.

Example : 2021-03-20
Required
referenceId 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
Required
idempotencyKey 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
Required
data
object

Specifies all data, as attributes, included into the callback notification, which depends on the event.
- Required
  product string
  
  Represents the Crypto APIs 2.0 product which sends the callback.
  
  Example : BLOCKCHAIN_EVENTS
- Required
  event string
  
  Defines the specific event, for which a callback subscription is set.
  
  Example : BLOCK_HEIGHT_REACHED
- Required
  item object
  
  Defines an item as one result.
  
  Required
  blockchain string
  
  Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
  
  Example : bitcoin
  
  Required
  network 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
  
  Required
  height integer
  
  Defines the number of blocks in the blockchain preceding this specific block.
  
  Example : 667900
  
  Required
  hash string
  
  Represents the hash of the block's header, i.e. an output that has a fixed length.
  
  Example : 00000000000000000006ddb5e854505f8b792122b0ac9469c07eb26db414f6fb
  
  Required
  timestamp integer
  
  Defines the exact date/time when this block was mined in seconds since Unix Epoch time.
  
  Example : 1610365615

Credits Cost : 10000 Credits For 1 Result(s)

Try it out

Request Example

Http Java C# PHP Python Ruby Node.js Go

POST

https://rest.cryptoapis.io/blockchain-events/bitcoin/testnet/subscriptions/block-height-reached?context=yourExampleString

Headers

Content-Type: application/json

X-API-Key: my-api-key

Request Body

{
    "context": "yourExampleString",
    "data": {
        "item": {
            "allowDuplicates": true,
            "blockHeightReached": 667900,
            "callbackSecretKey": "yourSecretKey",
            "callbackUrl": "https://example.com"
        }
    }
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"allowDuplicates\": true,
            \"blockHeightReached\": 667900,
            \"callbackSecretKey\": \"yourSecretKey\",
            \"callbackUrl\": \"https:\/\/example.com\"
        }
    }
}");
Request request = new Request.Builder()
  .url("https://rest.cryptoapis.io/blockchain-events/bitcoin/testnet/subscriptions/block-height-reached?context=yourExampleString")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("X-API-Key", "my-api-key")
  .build();

Response response = client.newCall(request).execute();

var client = new RestClient("https://rest.cryptoapis.io/blockchain-events/bitcoin/testnet/subscriptions/block-height-reached?context=yourExampleString");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader(""X-API-Key", "my-api-key");
request.AddParameter("application/json", "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"allowDuplicates\": true,
            \"blockHeightReached\": 667900,
            \"callbackSecretKey\": \"yourSecretKey\",
            \"callbackUrl\": \"https:\/\/example.com\"
        }
    }
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

$request = new HttpRequest();
$request->setUrl('https://rest.cryptoapis.io/blockchain-events/bitcoin/testnet/subscriptions/block-height-reached?context=yourExampleString');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
    'Content-Type' => 'application/json',
    'X-API-Key' => 'my-api-key'
));

$request->setBody('{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"allowDuplicates\": true,
            \"blockHeightReached\": 667900,
            \"callbackSecretKey\": \"yourSecretKey\",
            \"callbackUrl\": \"https:\/\/example.com\"
        }
    }
}');

try {
    $response = $request->send();

    echo $response->getBody();
} catch (HttpException $ex) {
    echo $ex;
}

import http.client

conn = http.client.HTTPConnection("https://rest.cryptoapis.io")

payload = "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"allowDuplicates\": true,
            \"blockHeightReached\": 667900,
            \"callbackSecretKey\": \"yourSecretKey\",
            \"callbackUrl\": \"https:\/\/example.com\"
        }
    }
}"
    querystring = {"context":"yourExampleString"}
headers = {
  'Content-Type': "application/json",
  'X-API-Key': "my-api-key"
}

conn.request("POST", "blockchain-events,bitcoin,testnet,subscriptions,block-height-reached",payload, headers=headers  , params=querystring )

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
}

require 'uri'
require 'net/http'

url = URI("https://rest.cryptoapis.io/blockchain-events/bitcoin/testnet/subscriptions/block-height-reached?context=yourExampleString")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["X-API-Key"] = 'my-api-key'
request.body = "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"allowDuplicates\": true,
            \"blockHeightReached\": 667900,
            \"callbackSecretKey\": \"yourSecretKey\",
            \"callbackUrl\": \"https:\/\/example.com\"
        }
    }
}"

response = http.request(request)
puts response.read_body

var https = require("https");

var options = {
  "method": "POST",
  "hostname": "rest.cryptoapis.io",
  "path": "/v2/blockchain-events/bitcoin/testnet/subscriptions/block-height-reached",
  "qs": {"context":"yourExampleString"},
  "headers": {
    "Content-Type": "application/json",
    "X-API-Key": "my-api-key"
  }
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
    "context": "yourExampleString",
    "data": {
        "item": {
            "allowDuplicates": true,
            "blockHeightReached": 667900,
            "callbackSecretKey": "yourSecretKey",
            "callbackUrl": "https:\/\/example.com"
        }
    }
}));

req.end();

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://rest.cryptoapis.io/blockchain-events/bitcoin/testnet/subscriptions/block-height-reached?context=yourExampleString"

  payload := strings.NewReader("{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"allowDuplicates\": true,
            \"blockHeightReached\": 667900,
            \"callbackSecretKey\": \"yourSecretKey\",
            \"callbackUrl\": \"https:\/\/example.com\"
        }
    }
}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-API-Key", "my-api-key")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

201 400 401 402 403 409 415 422 429 500

Response Example

{
    "apiVersion": "2023-04-25",
    "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": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "uri_not_found",
        "message": "The specified URI has not been found. Check the URI and try again.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "limit_greater_than_allowed",
        "message": "You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_pagination",
        "message": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "missing_api_key",
        "message": "The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_api_key",
        "message": "The provided API key is invalid. Please, generate a new one from your Dashboard.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "insufficient_credits",
        "message": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "banned_ip_address",
        "message": "This IP address has been banned. To check the reason for that, please contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_plan",
        "message": "This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_api_key",
        "message": "This endpoint is not available for your API key.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "feature_mainnets_not_allowed_for_plan",
        "message": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "blockchain_events_callbacks_limit_reached",
        "message": "You have reached the maximum number of active Blockchain Events subscriptions which is {callbacks_limit} now. Please upgrade your plan to be get higher number of active subscriptions.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_data",
        "message": "The data provided seems to be invalid.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "already_exists",
        "message": "The specified resource already exists.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unsupported_media_type",
        "message": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_request_body_structure",
        "message": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "request_limit_reached",
        "message": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unexpected_server_error",
        "message": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

BLOCK_HEIGHT_REACHED

Callback Example

{
    "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
        }
    }
}

Key	Value

Block Height Reached

Path Parameters

Query parameters

Request body schema application/json

Response schema

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Callback parameters Method : POST

Content-Type : application/json

Object :

Credits Cost : 10000 Credits For 1 Result(s)

Request Example

Response Example

Callback Example

Try It Out API Endpoint