Get Fee Address Details

Through this endpoint customers can obtain details about a fee address. Only one fee address per currency per network for a user's account can be set no matter how many tokens or subscriptions they have or want to automatically forward.

GET /blockchain-automations/{blockchain}/{network}/tokens-forwarding/fee-addresses

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", "rinkeby" are test networks.

    Example : testnet
    Possible Values : mainnet testnet ropsten rinkeby

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.

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
      item object
      • Required
        address string

        Represents the specific fee address, which is always automatically generated. Users must fund it.

        Example : 0xe2b5f5e885a268e4b6faae53f99a663f3bb3e036
      • Required
        balance object

        Specifies the balance of the fee address.

        • Required
          amount string

          Represents the amount of the units in fee address.

          Example : 0.01
        • Required
          unit string

          Represents the unit of the fee spent for the forwarded tokens, e.g. BTC.

          Example : ETH
      • 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
Try it out

Request Example

GET
https://rest.cryptoapis.io/v2/blockchain-automations/bitcoin/testnet/tokens-forwarding/fee-addresses
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": {
        "item": {
            "address": "0xe2b5f5e885a268e4b6faae53f99a663f3bb3e036",
            "balance": {
                "amount": "0.01",
                "unit": "ETH"
            },
            "minimumTransferAmount": "0.0002"
        }
    }
}