Get fees statistics for a party

GET 
/api/v2/fees/stats/parties/:partyId

Get accumulated fees, rewards, and applied discount information. A party ID must be supplied as filter.

Request

Path Parameters

partyId stringrequired

Restrict fees statistics to those for the given party.

Query Parameters

assetId string

Restrict fees statistics to those related to the given asset.

fromEpoch uint64

Epoch to filter from (included). If omitted, to epoch must not be set. If both omitted, the most recent epoch's data is returned.

toEpoch uint64

Epoch to filter to (included). If omitted, the range goes from from epoch to the most recent epoch.

Responses

200

A successful response.

application/json

Schema

Schema

feesStatsForParty object[]
Fees statistics for the given request.
Array [
assetId string
Settlement asset of the market.
refereesDiscountApplied string
Total referral discounts applied to referee fees.
totalMakerFeesReceived string
Total maker fees received by the maker side.
totalRewardsReceived string
Total referral rewards received by referrer of the referral set.
volumeDiscountApplied string
Total volume discounts applied to referee fees.
]

Example (from schema)

{
  "feesStatsForParty": [
    {
      "assetId": "string",
      "refereesDiscountApplied": "string",
      "totalMakerFeesReceived": "string",
      "totalRewardsReceived": "string",
      "volumeDiscountApplied": "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...