Fees

Get earned broker fees.

Returns the broker fees you have earned so far, per asset, in human-readable and native units. The BaaS operating fee is already deducted, so these are the amounts that are yours.

get/fees

Request

  • Base URL: https://chainflip-broker.io
  • URL: https://chainflip-broker.io/fees
  • Auth: one of:
    • API key in query parameter apiKey
    • API key in header X-API-Key

Query parameters

apiKeystring

Your partner API key. A key is required through this parameter OR the X-API-Key header; when both are present, this query parameter wins, even when it is empty, which fails validation rather than falling back to the header.

Response

The earned broker fees.

earnedFeesobject

Earned broker fees per asset.

earnedFeesNativeobject

Earned broker fees per asset in native units.

byProviderobject nullable

The same fees per provider, keyed by provider (e.g. chainflip).

Example response

{
  "earnedFees": {
    "eth.eth": 0.0173436384794928,
    "flip.eth": 10.15173226648041,
    "usdc.eth": 87.707768,
    "dot.dot": 0.696349455,
    "btc.btc": 0.00044002
  },
  "earnedFeesNative": {
    "eth.eth": "17343638479492800",
    "flip.eth": "10151732266480410979",
    "usdc.eth": "87707768",
    "dot.dot": "6963494550",
    "btc.btc": "44002"
  },
  "byProvider": {
    "chainflip": {
      "earnedFees": {
        "btc.btc": 0.00044002
      },
      "earnedFeesNative": {
        "btc.btc": "44002"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.