List Coins Forwarding Automations

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

Customers can set up automatic forwarding functions for coins 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".

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

GET /blockchain-automations/{blockchain}/{network}/coins-forwarding/automations

Path Parameters

  • 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

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 : 2.0
  • 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 : You can add any text here
  • Required
    data object
    • Required
      offset integer

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

      Example : 0
    • Required
      limit integer

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

      Example : 50
    • 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.

        Example : https://example.com
      • Required
        confirmationsCountTrigger integer

        Represents the total count of the transaction confirmations before triggering the event.

        Example : 3
      • Required
        createdTimestamp integer

        Defines the specific time/date when the automatic forwarding was created in Unix Timestamp.

        Example : 1611238648
      • 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 currency.

        Example : mzAsK3csTnozLnYVdca4gaoH1btBZBC6QB
      • Required
        minimumTransferAmount string

        Represents the minimum transfer amount of the currency in the fromAddress that can be allowed for an automatic forwarding.

        Example : 0.0002
      • Required
        referenceId string

        Represents a unique ID used to reference the specific forwarding automation.

        Example : 6017dd02a309213863be9e55
      • Required
        toAddress string

        Represents the hash of the address the currency is forwarded to.

        Example : tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6
Try it out

Request Example

GET
https://rest.cryptoapis.io/v2/blockchain-automations/bitcoin/testnet/coins-forwarding/automations
Headers
Host: https://rest.cryptoapis.io/v2
Content-Type: application/json
X-API-Key: my-api-key

Response Example

{
    "apiVersion": "2.0",
    "requestId": "601c1710034ed6d407996b30",
    "context": "You can add any text here",
    "data": {
        "offset": 0,
        "limit": 50,
        "total": 100,
        "items": [
            {
                "callbackUrl": "https://example.com",
                "confirmationsCountTrigger": 3,
                "createdTimestamp": 1611238648,
                "feePriority": "STANDARD",
                "fromAddress": "mzAsK3csTnozLnYVdca4gaoH1btBZBC6QB",
                "minimumTransferAmount": "0.0002",
                "referenceId": "6017dd02a309213863be9e55",
                "toAddress": "tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6"
            }
        ]
    }
}