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".
Path Parameters
-
Requiredblockchain string
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
-
Requirednetwork 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.
Query parameters
-
Optionalcontext 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. -
Optionallimit integer
Defines how many items should be returned in the response per page basis.
-
Optionaloffset integer
The starting index of the response items, i.e. where the response should start listing the returned items.
Response schema
Content-Type: application/json
The request has been successful.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext 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 -
Requireddata object
-
Requiredlimit integer
Defines how many items should be returned in the response per page basis.
Example : 50 -
Requiredoffset integer
The starting index of the response items, i.e. where the response should start listing the returned items.
Example : 0 -
Requiredtotal integer
Defines the total number of items returned in the response.
Example : 100 -
Requireditems arrayExample : Array ( )
-
RequiredcallbackUrl 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 -
RequiredconfirmationsCountTrigger integer
Represents the total count of the transaction confirmations before triggering the event.
Example : 3 -
RequiredcreatedTimestamp integer
Defines the specific time/date when the automatic forwarding was created in Unix Timestamp.
Example : 1611238648 -
RequiredfeePriority string
Represents the fee priority of the automation, whether it is "SLOW", "STANDARD" OR "FAST".
Example : standard -
RequiredfromAddress string
Represents the hash of the address that forwards the currency.
Example : mzAsK3csTnozLnYVdca4gaoH1btBZBC6QB -
RequiredminimumTransferAmount string
Represents the minimum transfer amount of the currency in the
fromAddress
that can be allowed for an automatic forwarding.Example : 0.0002 -
RequiredreferenceId string
Represents a unique ID used to reference the specific forwarding automation.
Example : 6017dd02a309213863be9e55 -
RequiredtoAddress string
Represents the hash of the address the currency is forwarded to.
Example : tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6
-
-