Get Network Overview
curl --request GET \
--url https://api.rated.network/v1/polygon/network/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.rated.network/v1/polygon/network/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.rated.network/v1/polygon/network/overview', 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.rated.network/v1/polygon/network/overview",
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.rated.network/v1/polygon/network/overview"
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))
}HttpResponse<String> response = Unirest.get("https://api.rated.network/v1/polygon/network/overview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rated.network/v1/polygon/network/overview")
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[
{
"activeDelegatorCount": 999,
"activeDelegatorDiff": 999,
"activeValidatorCount": 999,
"activeValidatorDiff": -10,
"avgDelegatedStake": 999,
"avgValidatorDelegates": 999,
"blendedCommissionRate": 0.99,
"borProposalApr": 0.99,
"borProposalRewardsRatio": 0.99,
"delegatorApr": 0.999,
"heimdallCheckpointApr": 0.99,
"heimdallCheckpointRewardsRatio": 0.99,
"netValidatorApr": 0.998,
"networkBorProposalRate": 0.999,
"networkCheckpointProposalRate": 0.999,
"networkCheckpointSigningRate": 0.999,
"networkEffectiveness": 0.999,
"network_bor_proposal_rate_diff": 0.01,
"network_checkpoint_proposal_rate_diff": 0.01,
"network_checkpoint_signing_rate_diff": 0.01,
"network_effectiveness_diff": 0.01,
"rewardsBorMev": 999,
"rewardsBorPriorityFees": 999,
"rewardsCheckpointProposals": 999,
"rewardsCheckpointSignatures": 999,
"timeWindow": "30d",
"totalDelegatedStake": 999,
"totalSelfStake": 999,
"totalStake": 999,
"validatorApr": 0.999
}
]{
"detail": [
{
"msg": "<string>",
"type": "<string>",
"loc": [
"<string>"
]
}
]
}Overview
Get Network Overview
This endpoint returns network-wide overview metrics for Polygon.
GET
/
v1
/
polygon
/
network
/
overview
Get Network Overview
curl --request GET \
--url https://api.rated.network/v1/polygon/network/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.rated.network/v1/polygon/network/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.rated.network/v1/polygon/network/overview', 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.rated.network/v1/polygon/network/overview",
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.rated.network/v1/polygon/network/overview"
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))
}HttpResponse<String> response = Unirest.get("https://api.rated.network/v1/polygon/network/overview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rated.network/v1/polygon/network/overview")
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[
{
"activeDelegatorCount": 999,
"activeDelegatorDiff": 999,
"activeValidatorCount": 999,
"activeValidatorDiff": -10,
"avgDelegatedStake": 999,
"avgValidatorDelegates": 999,
"blendedCommissionRate": 0.99,
"borProposalApr": 0.99,
"borProposalRewardsRatio": 0.99,
"delegatorApr": 0.999,
"heimdallCheckpointApr": 0.99,
"heimdallCheckpointRewardsRatio": 0.99,
"netValidatorApr": 0.998,
"networkBorProposalRate": 0.999,
"networkCheckpointProposalRate": 0.999,
"networkCheckpointSigningRate": 0.999,
"networkEffectiveness": 0.999,
"network_bor_proposal_rate_diff": 0.01,
"network_checkpoint_proposal_rate_diff": 0.01,
"network_checkpoint_signing_rate_diff": 0.01,
"network_effectiveness_diff": 0.01,
"rewardsBorMev": 999,
"rewardsBorPriorityFees": 999,
"rewardsCheckpointProposals": 999,
"rewardsCheckpointSignatures": 999,
"timeWindow": "30d",
"totalDelegatedStake": 999,
"totalSelfStake": 999,
"totalStake": 999,
"validatorApr": 0.999
}
]{
"detail": [
{
"msg": "<string>",
"type": "<string>",
"loc": [
"<string>"
]
}
]
}Polygon on the Rated API is under maintenancePlease check our changelog for the latest updates.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Successful Response
Available options:
1d, 7d, 30d, all Required range:
x >= 0Required range:
x >= 0Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$