List Blockchain Events Subscriptions

Through this endpoint the customer can obtain a list of their callback subscriptions for the available Blockchain events.

Currently Crypto APIs 2.0 offers certain Blockchain event endpoints which allow the user to subscribe for one/a few/all and receive callback notifications when the specific event occurs.

To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks here.

List of Results - This endpoint returns multiple objects which means pagination is applicable. GET /blockchain-events/{blockchain}/{network}/subscriptions

Path Parameters

Required
blockchain string

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

Example : bitcoin

Possible Values : bitcoin bitcoin-cash litecoin dogecoin dash ethereum ethereum-classic xrp binance-smart-chain zcash 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
Optional
limit integer

Defines how many items should be returned in the response per page basis.

Default : 50

Example : 50
Optional
offset integer

The starting index of the response items, i.e. where the response should start listing the returned items.

Default : 0

Example : 0

Response schema

200 400 401 402 403 409 415 422 429 500

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

The request has been successful.

Object :
Required
apiVersion string

Specifies the version of the API that incorporates this endpoint.

Example : 2021-03-20
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
  limit integer
  
  Defines how many items should be returned in the response per page basis.
  
  Example : 50
- Required
  offset integer
  
  The starting index of the response items, i.e. where the response should start listing the returned items.
  
  Example : 0
- Required
  total integer
  
  Defines the total number of items returned in the response.
  
  Example : 100
- Required
  items array
  Example : Array ( )
  
  Required
  address string
  
  Represents the address of the transaction.
  
  Example : tb1qtm44m6xmuasy4sc7nl7thvuxcerau2dfvkkgsc
  
  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
  
  Required
  confirmationsCount integer
  
  Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.
  
  Example : 5
  
  Required
  createdTimestamp integer
  
  Defines the specific time/date when the subscription was created in Unix Timestamp.
  
  Example : 1966238648
  
  Optional
  deactivationReasons array
  
  Represents the deactivation reason details, available when a blockchain event subscription has status isActive - false.
  
  Required
  reason string
  
  Defines the deactivation reason as a message.
  
  Example : maximum_retry_attempts_reached
  
  Required
  timestamp integer
  
  Represents the time of the subscription deactivation.
  
  Example : 1642102581
  
  Required
  eventType string
  
  Defines the type of the specific event available for the customer to subscribe to for callback notification.
  
  Example : BLOCK_MINED
  
  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
  
  Optional
  transactionId string
  
  Represents the unique identification string that defines the transaction.
  
  Example : 742b4a8d54a663d372fa16abf74093595ae6fc950f2fa2bb7388c7f4d061d7b8

Credits Cost : 100 Credits For 1 Result(s)

Try it out

Request Example

Http Java C# PHP Python Ruby Node.js Go

GET

https://rest.cryptoapis.io/blockchain-events/bitcoin/testnet/subscriptions?context=yourExampleString&limit=50&offset=0

Headers

Content-Type: application/json

X-API-Key: my-api-key

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://rest.cryptoapis.io/blockchain-events/bitcoin/testnet/subscriptions?context=yourExampleString&limit=50&offset=0")
  .get()
  .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?context=yourExampleString&limit=50&offset=0");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Key", "my-api-key");
IRestResponse response = client.Execute(request);

$request = new HttpRequest();
$request->setUrl('https://rest.cryptoapis.io/blockchain-events/bitcoin/testnet/subscriptions?context=yourExampleString&limit=50&offset=0');
$request->setMethod(HTTP_METH_GET);

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

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

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

import http.client

conn = http.client.HTTPConnection("https://rest.cryptoapis.io")
querystring = {"context":"yourExampleString","limit":50,"offset":0}
headers = {
  'Content-Type': "application/json",
  'X-API-Key': "my-api-key"
}

conn.request("GET", "blockchain-events,bitcoin,testnet,subscriptions", 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?context=yourExampleString&limit=50&offset=0")

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

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request["X-API-Key"] = 'my-api-key'

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

var https = require("https");

var options = {
  "method": "GET",
  "hostname": "rest.cryptoapis.io",
  "path": "/v2/blockchain-events/bitcoin/testnet/subscriptions",
  "qs": {"context":"yourExampleString","limit":50,"offset":0},
  "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.end();

package main

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

func main() {

  url := "https://rest.cryptoapis.io/blockchain-events/bitcoin/testnet/subscriptions?context=yourExampleString&limit=50&offset=0"

  req, _ := http.NewRequest("GET", url, nil)

  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))

}

200 400 401 402 403 409 415 422 429 500

Response Example

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "limit": 50,
        "offset": 0,
        "total": 100,
        "items": [
            {
                "address": "tb1qtm44m6xmuasy4sc7nl7thvuxcerau2dfvkkgsc",
                "callbackSecretKey": "yourSecretKey",
                "callbackUrl": "https://example.com",
                "confirmationsCount": 5,
                "createdTimestamp": 1966238648,
                "deactivationReasons": [
                    {
                        "reason": "maximum_retry_attempts_reached",
                        "timestamp": 1642102581
                    }
                ],
                "eventType": "BLOCK_MINED",
                "isActive": true,
                "referenceId": "bc243c86-0902-4386-b30d-e6b30fa1f2aa",
                "transactionId": "742b4a8d54a663d372fa16abf74093595ae6fc950f2fa2bb7388c7f4d061d7b8"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "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": "2021-03-20",
    "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": "2021-03-20",
    "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": "2021-03-20",
    "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": "2021-03-20",
    "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": "2021-03-20",
    "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": "2021-03-20",
    "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": "2021-03-20",
    "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": "2021-03-20",
    "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": "2021-03-20",
    "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": "2021-03-20",
    "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": "2021-03-20",
    "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": "2021-03-20",
    "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": "2021-03-20",
    "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": "2021-03-20",
    "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"
            }
        ]
    }
}

Key	Value

Key	Value

List Blockchain Events Subscriptions

Path Parameters

Query parameters

Response schema

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Credits Cost : 100 Credits For 1 Result(s)

Request Example

Response Example

Try It Out API Endpoint