Rewards

Query accrued $VRTX token rewards per epoch for a subaccount.

See our trading rewards page for more info.

Rate limits

• 240 requests/min or 40 requests/10secs per IP address. (weight = 10)

See more details in API Rate limits

Request

Rewards

POST [ARCHIVE_ENDPOINT]

Body

{
  "rewards": {
    "address": "0xf8d240d9514c9a4715d66268d7af3b53d6196425"
  }
}

Request Parameters

Parameter	Type	Required	Description
address	string	Yes	A wallet address sent as a hex string.

Response

{
  "rewards": [
    {
      "epoch": 6,
      "start_time": "1694610000",
      "period": "2419200",
      "address_rewards": [
        {
          "product_id": 1,
          "q_score": "0",
          "sum_q_min": "0",
          "uptime": 0,
          "maker_volume": "0",
          "taker_volume": "0",
          "maker_fee": "0",
          "taker_fee": "0",
          "maker_tokens": "0",
          "taker_tokens": "0",
          "rebates": "0"
        },
        {
          "product_id": 2,
          "q_score": "0",
          "sum_q_min": "0",
          "uptime": 0,
          "maker_volume": "0",
          "taker_volume": "0",
          "maker_fee": "0",
          "taker_fee": "0",
          "maker_tokens": "0",
          "taker_tokens": "0",
          "rebates": "0"
        }
      ],
      "global_rewards": [
        {
          "product_id": 1,
          "reward_coefficient": "0",
          "q_scores": "0",
          "maker_volumes": "0",
          "taker_volumes": "0",
          "maker_fees": "0",
          "taker_fees": "0",
          "maker_tokens": "0",
          "taker_tokens": "0",
          "uptimes": 0
        },
        {
          "product_id": 2,
          "reward_coefficient": "0",
          "q_scores": "0",
          "maker_volumes": "0",
          "taker_volumes": "0",
          "maker_fees": "0",
          "taker_fees": "0",
          "maker_tokens": "0",
          "taker_tokens": "0",
          "uptimes": 0
        }
      ],
      "num_eligible_addresses": 0
    },
    ...
    {
      "epoch": 2,
      "start_time": "1684933200",
      "period": "2419200",
      "address_rewards": [
        {
          "product_id": 1,
          "q_score": "37767803328173777000000000000",
          "sum_q_min": "15183828332461.346",
          "uptime": 16311,
          "maker_volume": "406414865.604",
          "taker_volume": "30243186.22",
          "maker_fee": "121940.82961903868",
          "taker_fee": "9073.98456253261",
          "maker_tokens": "2034872.7032979282",
          "taker_tokens": "140041.7857941628",
          "taker_referral_fee": "0",
          "taker_referral_tokens": "0",
          "rebates": "30485.20740475967"
        },
        {
          "product_id": 2,
          "q_score": "0",
          "sum_q_min": "0",
          "uptime": 0,
          "maker_volume": "0",
          "taker_volume": "0",
          "maker_fee": "0",
          "taker_fee": "0",
          "maker_tokens": "0",
          "taker_tokens": "0",
          "taker_referral_fee": "0",
          "taker_referral_tokens": "0",
          "rebates": "0"
        }
      ],
      "global_rewards": [
        {
          "product_id": 1,
          "reward_coefficient": "1.4534809874648702",
          "q_scores": "37767815933440308000000000000",
          "maker_volumes": "439361298.873",
          "taker_volumes": "439426304.803",
          "maker_fees": "131826.55223490787",
          "taker_fees": "131849.28737060472",
          "maker_tokens": "2034873.3824508183",
          "taker_tokens": "2034873.3824508183",
          "uptimes": 16468
        },
        {
          "product_id": 2,
          "reward_coefficient": "0.92151901253513",
          "q_scores": "28633774205909980000000000000",
          "maker_volumes": "417882690.476",
          "taker_volumes": "417920882.996",
          "maker_fees": "83583.8915119906",
          "taker_fees": "83593.54277701337",
          "maker_tokens": "1290126.6175491821",
          "taker_tokens": "1290126.6175491821",
          "uptimes": 16468
        }
      ],
      "num_eligible_addresses": 35
    }
  ],
  "update_time": "1688581269",
  "total_referrals": "0"
}

Response Fields

Field name	Description
rewards.epoch	Number of the corresponding epoch for the associated rewards.
rewards.start_time	Unix epoch start time (in seconds).
rewards.duration	Epoch duration in seconds.
rewards.address_rewards	Rewards per product of the corresponding address in the corresponding epoch.
rewards.global_rewards	Total rewards per product for this epoch.
update_time	Unix epoch time (in seconds) of when the rewards were last updated.
total_referrals	Total accounts this user has referred.