Get Total Delegator Rewards - P2P.ORG

GET

/

api

/

v1

/

{network}

/

data

/

delegator

/

total-rewards

Get Total Delegator Rewards

curl --request GET \
  --url https://api.p2p.org/api/api/v1/{network}/data/delegator/total-rewards \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.p2p.org/api/api/v1/{network}/data/delegator/total-rewards"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.p2p.org/api/api/v1/{network}/data/delegator/total-rewards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.p2p.org/api/api/v1/{network}/data/delegator/total-rewards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.p2p.org/api/api/v1/{network}/data/delegator/total-rewards"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.p2p.org/api/api/v1/{network}/data/delegator/total-rewards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "error": null,
  "result": {
    "limit": 50,
    "offset": 0,
    "startAt": "2023-11-07T05:31:56Z",
    "finishAt": "2023-11-07T05:31:56Z",
    "list": [
      {
        "stakingPeriod": "<string>",
        "rewards": [
          {
            "type": "staking",
            "amount": 123,
            "netAmount": 123,
            "fee": 123,
            "currency": "ETH",
            "recipient": "<string>",
            "validator": "<string>"
          }
        ],
        "stakingPeriodStart": "<string>",
        "stakingPeriodEnd": "<string>",
        "validator": "<string>",
        "notFinalized": true
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

network

enum<string>

required

Network name.

Available options:

ethereum

Query Parameters

startAt

string<date-time>

Timestamp of the report data period start in the ISO 8601 format. If not specified, the default value is the one month ago.

Example:

"2024-01-01T00:00:00.000Z"

finishAt

string<date-time>

Timestamp of the report data period finish in the ISO 8601 format. If not specified, the default value is the current date.

Example:

"2024-01-01T00:00:00.000Z"

startNumber

integer<int64>

Start number of the staking period.

finishNumber

integer<int64>

Finish number of the staking period.

limit

integer<int32>

Number of resources that a single response page contains.

Required range: 1 <= x <= 1000

Example:

50

offset

integer<int32>

Number of resources to exclude from a response.

Required range: 0 <= x <= 10000000

Example:

0

address

string

required

Delegator address in the required network.

Response

OK

Standard API success response envelope wrapping the result payload.

error

object | null

required

Error object. Always null on successful responses.

result

object

required

Response payload containing the requested data.

Show child attributes

Get Total Delegator Rewards

curl --request GET \
  --url https://api.p2p.org/api/api/v1/{network}/data/delegator/total-rewards \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.p2p.org/api/api/v1/{network}/data/delegator/total-rewards"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.p2p.org/api/api/v1/{network}/data/delegator/total-rewards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.p2p.org/api/api/v1/{network}/data/delegator/total-rewards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.p2p.org/api/api/v1/{network}/data/delegator/total-rewards"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.p2p.org/api/api/v1/{network}/data/delegator/total-rewards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "error": null,
  "result": {
    "limit": 50,
    "offset": 0,
    "startAt": "2023-11-07T05:31:56Z",
    "finishAt": "2023-11-07T05:31:56Z",
    "list": [
      {
        "stakingPeriod": "<string>",
        "rewards": [
          {
            "type": "staking",
            "amount": 123,
            "netAmount": 123,
            "fee": 123,
            "currency": "ETH",
            "recipient": "<string>",
            "validator": "<string>"
          }
        ],
        "stakingPeriodStart": "<string>",
        "stakingPeriodEnd": "<string>",
        "validator": "<string>",
        "notFinalized": true
      }
    ]
  }
}