Skip to main content
Version: testnet (v0.77)

Get referral set statistics

GET 

/api/v2/referral-sets/stats

Get the total taker volume, and each referee's taker volume and, reward and discount factors for a referral set at the latest or a specific epoch. You can also optionally filter for a specific referee's statistics.

Request

Query Parameters

    referralSetId string

    Restrict referral set statistics to those for the given referral set.

    atEpoch uint64

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

    referee string

    Restrict referral set statistics to those for the given referee.

    pagination.first int32

    Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

    pagination.after string

    If paging forwards, the cursor string for the last row of the previous page.

    pagination.last int32

    Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

    pagination.before string

    If paging forwards, the cursor string for the first row of the previous page.

    pagination.newestFirst boolean

    Whether to order the results with the newest records first. If not set, the default value is true.

Responses

A successful response.

Schema
    stats object

    Referral set statistics for the epoch.

    edges object[]

    Page of volume discount statistics data and their corresponding cursors.

  • Array [
  • cursor string

    Cursor that can be used to fetch further pages.

    node object

    Referral set stats data.

    atEpoch uint64

    Epoch at which the set's statistics were updated.

    discountFactor string

    Discount factor applied to the party.

    epochNotionalTakerVolume string

    Current referee notional taker volume.

    partyId string

    Party ID.

    referralSetRunningNotionalTakerVolume string

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

    referrerTakerVolume Referrer's taker volume
    rewardFactor string

    Reward factor applied to the party.

    rewardsFactorMultiplier string

    Proportion of the referee's taker fees to be rewarded to the referrer.

    rewardsMultiplier string

    Multiplier applied to the referral reward factor when calculating referral rewards due to the referrer.

    wasEligible boolean

    Indicates if the referral set was eligible to be part of the referral program.

  • ]
  • pageInfo object

    Page information that is used for fetching further pages.

    endCursor string

    End cursor.

    hasNextPage boolean

    Indicator if there is a next page.

    hasPreviousPage boolean

    Indicator if there is a previous page.

    startCursor string

    Start cursor.

Loading...