Get fees statistics

GET 
/api/v2/fees/stats

Get accumulated fees, rewards, and applied discount information. Either a market or an asset must be supplied as filter.

Request

Query Parameters

marketId string

Restrict fee statistics to those related for the given market.

assetId string

Restrict fee statistics to those related for the given asset.

epochSeq uint64

Epoch to get referral fee statistics for. If not set, the last complete epoch is used.

partyId string

Restrict fee statistics to those for the given party.

Responses

200

A successful response.

application/json

Schema

Schema

feesStats object
Fees statistics for the given request.
asset string
Settlement asset of the market.
epochSeq uint64
Epoch for which these stats where valid.
makerFeesGenerated object[]
Maker fees paid by all trade aggressors, and which makers the fees were paid to.
Array [
makerFeesPaid object[]
Amount of maker fees paid by the taker to the maker.
Array [
amount string
Amount received.
party string
Receiving party ID.
quantumAmount string
Amount value in quantum.
]
taker string
Party that paid the fees.
]
market Market the fees were paid in
refereesDiscountApplied object[]
Total referral discounts applied to all referee taker fees.
Array [
amount string
Amount received.
party string
Receiving party ID.
quantumAmount string
Amount value in quantum.
]
referrerRewardsGenerated object[]
Referral rewards generated by all referee taker fees.
Array [
generatedReward object[]
Amount of rewards generated per party.
Array [
amount string
Amount received.
party string
Receiving party ID.
quantumAmount string
Amount value in quantum.
]
referrer string
Referrer party.
]
totalFeesPaidAndReceived object[]
Total trading fees received and paid by the party.
Array [
amount string
Amount received.
party string
Receiving party ID.
quantumAmount string
Amount value in quantum.
]
totalMakerFeesReceived object[]
Total maker fees received by the maker side.
Array [
amount string
Amount received.
party string
Receiving party ID.
quantumAmount string
Amount value in quantum.
]
totalRewardsReceived object[]
Total referral rewards received by the referrer of the referral set.
Array [
amount string
Amount received.
party string
Receiving party ID.
quantumAmount string
Amount value in quantum.
]
volumeDiscountApplied object[]
Total volume discounts applied to all referee taker fees.
Array [
amount string
Amount received.
party string
Receiving party ID.
quantumAmount string
Amount value in quantum.
]

Example (from schema)

{
  "feesStats": {
    "asset": "string",
    "epochSeq": "string",
    "makerFeesGenerated": [
      {
        "makerFeesPaid": [
          {
            "amount": "string",
            "party": "string",
            "quantumAmount": "string"
          }
        ],
        "taker": "string"
      }
    ],
    "market": "string",
    "refereesDiscountApplied": [
      {
        "amount": "string",
        "party": "string",
        "quantumAmount": "string"
      }
    ],
    "referrerRewardsGenerated": [
      {
        "generatedReward": [
          {
            "amount": "string",
            "party": "string",
            "quantumAmount": "string"
          }
        ],
        "referrer": "string"
      }
    ],
    "totalFeesPaidAndReceived": [
      {
        "amount": "string",
        "party": "string",
        "quantumAmount": "string"
      }
    ],
    "totalMakerFeesReceived": [
      {
        "amount": "string",
        "party": "string",
        "quantumAmount": "string"
      }
    ],
    "totalRewardsReceived": [
      {
        "amount": "string",
        "party": "string",
        "quantumAmount": "string"
      }
    ],
    "volumeDiscountApplied": [
      {
        "amount": "string",
        "party": "string",
        "quantumAmount": "string"
      }
    ]
  }
}

500

An internal server error

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

Loading...