TradingDataService_GetReferralSetStats

TradingDataService_GetReferralSetStats

Path Parameters

referralSetId string required

Unique ID of the set.

Query Parameters

atEpoch uint64

Epoch at which the set's statistics were updated. If omitted, the last received statistics are returned.

referee string

Referee's party ID to filter statistics for. If omitted the statistics for all referees will be returned.

Responses

• 200
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

stats object

atEpoch uint64

Epoch at which the set's statistics are updated.

refereesStats object[]

Referees' statistics for that epoch.

Array [

discountFactor string

Discount factor applied to the party.

epochNotionalTakerVolume Current referee notional taker volume

partyId string

Unique ID of the party.

rewardFactor string

Reward factor applied to the party.

]

referralSetRunningNotionalTakerVolume string

Running volume for the set based on the window length of the current referral program.

setId string

Unique ID of the set.

{
  "stats": {
    "atEpoch": "string",
    "refereesStats": [
      {
        "discountFactor": "string",
        "epochNotionalTakerVolume": "string",
        "partyId": "string",
        "rewardFactor": "string"
      }
    ],
    "referralSetRunningNotionalTakerVolume": "string",
    "setId": "string"
  }
}

An internal server error

application/json

Schema

Example (from 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

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

An unexpected error response.

application/json

Schema

Example (from 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

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

Loading...