List Tokens Forwarding Automations

Through this endpoint customers can list all of their tokens forwarding automations (not coins).

Customers can set up automatic forwarding functions for tokens by setting a fromAddress and a toAddress, and specifying the amount that can be transferred between addresses.

A feePriority will be returned which represents the fee priority of the automation whether it is "SLOW", "STANDARD" OR "FAST".

Currently we support fungible tokens (ERC-20) only, NFTs (ERC-721) are not supported.

The subscription will work for all transactions until it is deleted. There is no need to do that for every transaction.

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

Path Parameters

Required
blockchain string

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

Example : bitcoin

Possible Values : bitcoin ethereum
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 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 404 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
  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
  
  Optional
  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 automatic forwarding was created in Unix Timestamp.
  
  Example : 1611238648
  
  Required
  feeAddress string
  
  Represents the specific fee address, which is always automatically generated. Users must fund it.
  
  Example : mojjR51gMXLJ4B3SBPhEXXRFDX7U5UWXNQ
  
  Required
  feePriority string
  
  Represents the fee priority of the automation, whether it is "SLOW", "STANDARD" or "FAST".
  
  Example : standard
  
  Possible Values : slow standard fast
  
  Required
  fromAddress string
  
  Represents the hash of the address that forwards the tokens.
  
  Example : ms4KNsbNpoU8g424pzmEjbkFbfAHae1msB
  
  Required
  minimumTransferAmount string
  
  Represents the minimum transfer amount of the tokens in the fromAddress that can be allowed for an automatic forwarding.
  
  Example : 0.5
  
  Required
  referenceId string
  
  Represents a unique ID used to reference the specific callback subscription.
  
  Example : 6038ad04c22fba4680361105
  
  Required
  toAddress string
  
  Represents the hash of the address the tokens are forwarded to.
  
  Example : tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6
  
  Required
  tokenData object One Of
  
  object
  
  Required
  propertyId integer
  
  Defines the Property ID of the Omni Layer token.
  
  Example : 31
  
  object
  
  Required
  contractAddress string
  
  Defines the token contract address.
  
  Example : 0xdac17f958d2ee523a2206206994597c13d831ec7

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-automations/bitcoin/testnet/tokens-forwarding/automations?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-automations/bitcoin/testnet/tokens-forwarding/automations?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-automations/bitcoin/testnet/tokens-forwarding/automations?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-automations/bitcoin/testnet/tokens-forwarding/automations?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-automations,bitcoin,testnet,tokens-forwarding,automations", 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-automations/bitcoin/testnet/tokens-forwarding/automations?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-automations/bitcoin/testnet/tokens-forwarding/automations",
  "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-automations/bitcoin/testnet/tokens-forwarding/automations?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 404 409 415 422 429 500

Response Example

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "limit": 50,
        "offset": 0,
        "total": 100,
        "items": [
            {
                "callbackUrl": "https://example.com",
                "confirmationsCount": 2,
                "createdTimestamp": 1611238648,
                "feeAddress": "mojjR51gMXLJ4B3SBPhEXXRFDX7U5UWXNQ",
                "feePriority": "standard",
                "fromAddress": "ms4KNsbNpoU8g424pzmEjbkFbfAHae1msB",
                "minimumTransferAmount": "0.5",
                "referenceId": "6038ad04c22fba4680361105",
                "toAddress": "tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6",
                "tokenData": {
                    "propertyId": 31
                }
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "limit": 50,
        "offset": 0,
        "total": 100,
        "items": [
            {
                "callbackUrl": "https://example.com",
                "confirmationsCount": 2,
                "createdTimestamp": 1611238648,
                "feeAddress": "mojjR51gMXLJ4B3SBPhEXXRFDX7U5UWXNQ",
                "feePriority": "standard",
                "fromAddress": "ms4KNsbNpoU8g424pzmEjbkFbfAHae1msB",
                "minimumTransferAmount": "0.5",
                "referenceId": "6038ad04c22fba4680361105",
                "toAddress": "tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6",
                "tokenData": {
                    "contractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7"
                }
            }
        ]
    }
}

{
    "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": "resource_not_found",
        "message": "Resource not found",
        "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 Tokens Forwarding Automations

Path Parameters

Query parameters

Response schema

Object :

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