Estimate Fee

GET /wallets/{walletId}/delegation-fees

status: stable

Estimate fee for joining or leaving a stake pool. Note that it is an estimation because a delegation induces a transaction for which coins have to be selected randomly within the wallet. Because of this randomness, fees can only be estimated.

Path parameters

  • walletId string(hex) Required

    Minimum length is 40, maximum length is 40.

Responses

  • 406 application/json

    Not Acceptable

    Hide response attributes Show response attributes object
    • message string Required

      May occur when providing an invalid 'Accept' header.

    • code string Required

      Value is not_acceptable.

  • 404 application/json

    Not Found

    Hide response attributes Show response attributes object
    • message string Required

      May occur when a given walletId does not match with any known wallets (because it has been deleted, or has never existed).

    • code string Required

      Value is no_such_wallet.

    • info object
      Hide info attribute Show info attribute object
      • wallet_id string(hex) Required

        A unique identifier for the wallet

        Minimum length is 40, maximum length is 40.

  • 403 application/json

    Forbidden

    Hide response attributes Show response attributes object
    • message string Required

      May occur when a transaction can't be balanced for fees.

    • code string Required

      Value is cannot_cover_fee.

  • 200 application/json

    Ok

    Hide response attributes Show response attributes object
    • estimated_min object Required

      Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.

      Hide estimated_min attributes Show estimated_min attributes object
      • quantity integer Required

        Minimum value is 0.

      • unit string Required

        Value is lovelace.

    • estimated_max object Required

      Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.

      Hide estimated_max attributes Show estimated_max attributes object
      • quantity integer Required

        Minimum value is 0.

      • unit string Required

        Value is lovelace.

    • minimum_coins array[object] Required

      A list of minimum coin values that each output in a payment must satisfy. The values themselves depends on two things:

      • (a) Some updatable protocol parameters fixed by the network.
      • (b) The nature of the outputs (i.e. the kind of assets it includes).

      The list is a direct 1:1 mapping of the requested outputs. Said differently, it has the same number of items and items are ordered in the same way as requested outputs are ordered. In the case where there's no explicitly requested outputs (e.g. when calculating fee for delegation), this list is empty.

      For example, an output containing only Ada may require to be of at least 1 Ada. An output containing only an hypothetical AppleCoin may require to also carry a minimum of 1.2 Ada. Note that no matter what, a minimum coin value is always given in Lovelace / Ada.

      ℹ️ This mechanism is used by the protocol to protect against flooding of the network with worthless assets. By requiring a minimum coin value to every UTxO, they are given an intrinsic value indexed itself on the value of Ada.

      At least 0 elements.

      Hide minimum_coins attributes Show minimum_coins attributes object
      • quantity integer Required

        Minimum value is 0.

      • unit string Required

        Value is lovelace.

    • deposit object Required

      Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.

      Hide deposit attributes Show deposit attributes object
      • quantity integer Required

        Minimum value is 0.

      • unit string Required

        Value is lovelace.

GET /wallets/{walletId}/delegation-fees
curl \
 --request GET https://localhost:8090/v2/wallets/{walletId}/delegation-fees
Response examples (406)
{
  "message": "string",
  "code": "not_acceptable"
}
Response examples (404)
{
  "message": "string",
  "code": "no_such_wallet",
  "info": {
    "wallet_id": "2512a00e9653fe49a44a5886202e24d77eeb998f"
  }
}
Response examples (403)
{
  "message": "string",
  "code": "cannot_cover_fee"
}
Response examples (200)
{
  "estimated_min": {
    "quantity": 42000000,
    "unit": "lovelace"
  },
  "estimated_max": {
    "quantity": 42000000,
    "unit": "lovelace"
  },
  "minimum_coins": [
    {
      "quantity": 42000000,
      "unit": "lovelace"
    }
  ],
  "deposit": {
    "quantity": 42000000,
    "unit": "lovelace"
  }
}