Get current referral program

GET 
/api/v2/referral-programs/current

Get the current referral program for the network. This program may not be active if it has ended and has not been replaced by another.

Responses

200

A successful response.

application/json

Schema

Schema

currentReferralProgram object

Referral program currently activated on the network.

benefitTiers object[]

Defined tiers in increasing order. First element will give Tier 1, second element will give Tier 2, and so on.

Array [

minimumEpochs string

Required number of epochs a party must have been in a referral set to access this tier.

minimumRunningNotionalTakerVolume string

Required running notional taker volume in quantum units for parties to access this tier.

referralDiscountFactor deprecated (string)

referralDiscountFactors object

Referral discount factors for the various fees.

infrastructureDiscountFactor string

Proportion of the referee's infrastructure fee to be discounted.

liquidityDiscountFactor string

Proportion of the referee's liquidity fee to be discounted.

makerDiscountFactor string

Proportion of the referee's maker fee to be discounted.

referralRewardFactor deprecated (string)

referralRewardFactors object

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

infrastructureRewardFactor string

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

liquidityRewardFactor string

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

makerRewardFactor string

Proportion of the maker fees to be rewarded.

tierNumber uint64

The tier number. It's set by the core, and used in the party fee stats API.

]

endOfProgramTimestamp int64

Timestamp in Unix nanoseconds, after which when the current epoch ends, the program will end and benefits will be disabled.

endedAt int64

Timestamp, in Unix nanoseconds, when the program ended.

id string

Unique ID generated from the proposal that created this program.

stakingTiers object[]

Defined benefit tiers ordered by increasing reward multiplier. Determines the level of benefit a party can expect based on their staking.

Array [

minimumStakedTokens string

Required number of governance tokens ($VEGA) a referrer must have staked to receive the multiplier.

referralRewardMultiplier string

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

]

version uint64

Incremental version of the program. It is incremented after each program update.

windowLength uint64

Number of epochs over which the referral set's running volume is evaluated.

Example (from schema)

{
  "currentReferralProgram": {
    "benefitTiers": [
      {
        "minimumEpochs": "string",
        "minimumRunningNotionalTakerVolume": "string",
        "referralDiscountFactor": "string",
        "referralDiscountFactors": {
          "infrastructureDiscountFactor": "string",
          "liquidityDiscountFactor": "string",
          "makerDiscountFactor": "string"
        },
        "referralRewardFactor": "string",
        "referralRewardFactors": {
          "infrastructureRewardFactor": "string",
          "liquidityRewardFactor": "string",
          "makerRewardFactor": "string"
        },
        "tierNumber": "string"
      }
    ],
    "endOfProgramTimestamp": "string",
    "endedAt": "string",
    "id": "string",
    "stakingTiers": [
      {
        "minimumStakedTokens": "string",
        "referralRewardMultiplier": "string"
      }
    ],
    "version": "string",
    "windowLength": "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...