Stats

Stats API helps you to fetch rewards data for the validators managed by the OPUS platform. The below workflow illustrates the OPUS Stats workflow.

Get rewards and aggregated node statistics for validators hosted by Chorus/Opus

POSThttp://localhost:8080/api/v1/stats

Body

application/json

fromstring (date)

A starting day for which need to retrieve rewards. If not sent, the date of registration is used. This date should be always in UTC time zone.

tostring (date)

An ending day for which need to retrieve rewards. By default, assumes it is current day. This date should be always in UTC time zone.

aggregate_daysinteger

Number of daily statistics aggregated in a single entry. The aggregation works as follows:

• for percentage values, shows avg()
• for gwei or count values, shows sum() By default, shows single day aggregations.

walletsarray of string

network*enum

Network for which to perform statistics request

ethereum

Response

200

Reward and performance data have been returned, to this day

Body

application/json

rewards*RewardsAndEffectivenessResponse (array of object)

Array of daily rewards objects

nodes*NodeAggregateResponse (array of object)

Array of account aggregated validator statistics, each representing one day

continue_queryStatsRequest (object)

Request

JavaScriptCurl

const response = await fetch('http://localhost:8080/api/v1/stats', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "network": "ethereum"
    }),
});
const data = await response.json();

Response

{
  "rewards": [
    {
      "network": "ethereum",
      "when": "2019-05-17",
      "aggregate_days": "2019-05-17",
      "delta": "text",
      "apr": 0,
      "rewards": {
        "total": "text",
        "execution_priority": "text",
        "execution_mev": "text",
        "consensus_block": "text",
        "consensus_attestation": "text"
      },
      "penalties": {
        "total": "text",
        "consensus_sync_committee": "text",
        "consensus_attestation_missed": "text",
        "consensus_vote_late_target": "text",
        "consensus_vote_wrong_target": "text",
        "consensus_vote_late_source": "text"
      },
      "effectiveness": {
        "attester_effectiveness": 0,
        "proposer_effectiveness": 0
      }
    }
  ],
  "nodes": [
    {
      "when": "2019-05-17",
      "balance_active": "text",
      "balance_total": "text",
      "requests": [
        {
          "transaction_id": "text",
          "request_id": "9b4ec01f-c4e8-47c0-a2e0-fffc940dcc31",
          "created_at": "text",
          "request_type": "stake",
          "network": "text",
          "validators": [
            {
              "public_signing_key": "text",
              "status": "created"
            }
          ]
        }
      ],
      "deposits": [
        {
          "transaction_id": "text",
          "when": "2019-05-17",
          "progress": {},
          "validators": [
            {
              "public_signing_key": "text",
              "status": "deposited"
            }
          ]
        }
      ]
    }
  ],
  "continue_query": {
    "from": "2019-05-17",
    "to": "2019-05-17",
    "wallets": [
      "text"
    ],
    "network": "ethereum"
  }
}