network

Estimate network fees

Changed on

Given a HAPI transaction, estimate the network fees in tinycents.

post/api/v1/network/fees

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/network/fees
  • Auth
    none declared

Query parameters

mode'INTRINSIC' | 'STATE'

Estimate solely based on the transaction's inherent properties or use network state.

high_volume_throttleinteger

The high-volume throttle utilization in basis points where 10000 equals 100%. A value of 0, the default, indicates no high-volume pricing.

Request body application/protobuf

string binary required

Response

OK

high_volume_multiplierinteger required

The high-volume pricing multiplier per HIP-1313. A value of 1 indicates no high-volume pricing. A value greater than 1 applies when the transaction's highVolume flag is true and throttle utilization is non-zero.

totalinteger required

The sum of the network, node, and service subtotals in tinycents.

Example response

{
  "high_volume_multiplier": 100,
  "network": {
    "multiplier": 2,
    "subtotal": 1200
  },
  "node": {
    "base": 1000,
    "extras": [
      {
        "charged": 1,
        "count": 2,
        "fee_per_unit": 100,
        "included": 1,
        "name": "Signatures",
        "subtotal": 100
      }
    ]
  },
  "service": {
    "base": 1000,
    "extras": [
      {
        "charged": 1,
        "count": 2,
        "fee_per_unit": 100,
        "included": 1,
        "name": "Signatures",
        "subtotal": 100
      }
    ]
  },
  "total": 1000
}

Changes

  • v1310340b11c48Revision changes
    • info

      added the new optional query request parameter high_volume_throttle

    • info

      added the required property to the response with the status

  • v1901b8589d0f2Revision changes
    • breaking

      the /////// response's property format changed from int32 to int64 for status

    • breaking

      the /////// response's property format changed from int32 to int64 for status

    • breaking

      the /////// response's property format changed from int32 to int64 for status

    • breaking

      the /////// response's property format changed from int32 to int64 for status

    • breaking

      the /////// response's property format changed from int32 to int64 for status

    • breaking

      the /////// response's property format changed from int32 to int64 for status

    • breaking

      removed the required property from the response with the status