Activate Blockchain Event Subscription

Through this endpoint customers can reactivate an event subscription (callback) which has been deactivated by the system. Deactivations could happen due to various reasons, most often "maximum retry attempts reached".

Single Result - This endpoint returns only one single result. POST /blockchain-events/subscriptions/{referenceId}/activate

Path Parameters

Required
referenceId string

Represents a unique ID used to reference the specific callback subscription.

Example : bc243c86-0902-4386-b30d-e6b30fa1f2aa

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

Response schema

201 400 401 402 403 404 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
  address string
  
  Represents the address of the transaction, per which the result is returned.
  
  Example : 0x7495fede000c8a3b77eeae09cf70fa94cd2d53f5
  
  Required
  blockchain string
  
  Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
  
  Example : bitcoin
  
  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
  confirmationsCount integer
  
  Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.
  
  Example : 2
  
  Required
  createdTimestamp integer
  
  Defines the specific time/date when the subscription was created in Unix Timestamp.
  
  Example : 1611238648
  
  Required
  eventType string
  
  Defines the type of the specific event available for the customer to subscribe to for callback notification.
  
  Example : ADDRESS_TOKENS_TRANSACTION_CONFIRMED
  
  Required
  isActive boolean
  
  Defines whether the subscription is active or not. Set as boolean.
  
  Example : True
  
  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", "goerli" are test networks.
  
  Example : testnet
  
  Required
  referenceId string
  
  Represents a unique ID used to reference the specific callback subscription.
  
  Example : bc243c86-0902-4386-b30d-e6b30fa1f2aa
  
  Required
  transactionId string
  
  Represents the unique identification string that defines the transaction.
  
  Example : 0xbe38781783b1b9d480219255ff98e20335a39e13979a66112efa33f05fde0a33

Credits Cost : 500 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/subscriptions/bc243c86-0902-4386-b30d-e6b30fa1f2aa/activate?context=yourExampleString

Headers

Content-Type: application/json

X-API-Key: my-api-key

Request Body

{
    "context": "yourExampleString",
    "data": {
        "item": {}
    }
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {}
    }
}");
Request request = new Request.Builder()
  .url("https://rest.cryptoapis.io/blockchain-events/subscriptions/bc243c86-0902-4386-b30d-e6b30fa1f2aa/activate?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/subscriptions/bc243c86-0902-4386-b30d-e6b30fa1f2aa/activate?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\": {}
    }
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

$request = new HttpRequest();
$request->setUrl('https://rest.cryptoapis.io/blockchain-events/subscriptions/bc243c86-0902-4386-b30d-e6b30fa1f2aa/activate?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\": {}
    }
}');

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\": {}
    }
}"
    querystring = {"context":"yourExampleString"}
headers = {
  'Content-Type': "application/json",
  'X-API-Key': "my-api-key"
}

conn.request("POST", "blockchain-events,subscriptions,bc243c86-0902-4386-b30d-e6b30fa1f2aa,activate",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/subscriptions/bc243c86-0902-4386-b30d-e6b30fa1f2aa/activate?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\": {}
    }
}"

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

var https = require("https");

var options = {
  "method": "POST",
  "hostname": "rest.cryptoapis.io",
  "path": "/v2/blockchain-events/subscriptions/bc243c86-0902-4386-b30d-e6b30fa1f2aa/activate",
  "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": {}
    }
}));

req.end();

package main

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

func main() {

  url := "https://rest.cryptoapis.io/blockchain-events/subscriptions/bc243c86-0902-4386-b30d-e6b30fa1f2aa/activate?context=yourExampleString"

  payload := strings.NewReader("{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {}
    }
}")

  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 404 409 415 422 429 500

Response Example

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "address": "0x7495fede000c8a3b77eeae09cf70fa94cd2d53f5",
            "blockchain": "bitcoin",
            "callbackSecretKey": "yourSecretKey",
            "callbackUrl": "https://example.com",
            "confirmationsCount": 2,
            "createdTimestamp": 1611238648,
            "eventType": "ADDRESS_TOKENS_TRANSACTION_CONFIRMED",
            "isActive": true,
            "network": "testnet",
            "referenceId": "bc243c86-0902-4386-b30d-e6b30fa1f2aa",
            "transactionId": "0xbe38781783b1b9d480219255ff98e20335a39e13979a66112efa33f05fde0a33"
        }
    }
}

{
    "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": "resource_not_found",
        "message": "Resource not found",
        "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": "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"
            }
        ]
    }
}

Activate Blockchain Event Subscription

Path Parameters

Query parameters

Request body schema application/json

Response schema

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Credits Cost : 500 Credits For 1 Result(s)

Request Example

Response Example

Try It Out API Endpoint