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

List referral set referees

GET 

/api/v2/referral-sets/referees

List all referees that belong to a referral set.

Request

Query Parameters

    referralSetId string

    Referral set ID to retrieve information for.

    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.

    referrer string

    Referrer to filter by. If referrer set ID is provided, this field is ignored.

    referee string

    Referee to filter by. If referrer set ID or referrer is provided, this field is ignored.

    aggregationEpochs int64

    Epochs to aggregate party volume and rewards over. If omitted, 30 epochs will be used.

Responses

A successful response.

Schema
    referralSetReferees object

    Page of referral set referee data and corresponding page information.

    edges object[]

    Page of referral set referee data and their corresponding cursors.

  • Array [
  • cursor string

    Cursor that can be used to fetch further pages.

    node object

    Referral set referee data.

    atEpoch uint64

    Epoch at which the party joined the set.

    joinedAt int64

    Timestamp, in Unix nanoseconds, when the party joined the set.

    referee string

    Party that joined the set.

    referralSetId string

    Unique ID of the referral set the referee joined.

    totalRefereeGeneratedRewards string

    Total rewards generated by the referee over the aggregation period.

    totalRefereeNotionalTakerVolume string

    Total notional volume of the referee's aggressive trades over the aggregation period.

  • ]
  • 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...