Get Pool Method

Get pool data with all its nominators.

GET /getPool

Get Pool Method

cURL

curl --request GET \
  --url https://toncenter.com/api/smc-index/getPool \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://toncenter.com/api/smc-index/getPool"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://toncenter.com/api/smc-index/getPool', 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://toncenter.com/api/smc-index/getPool",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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://toncenter.com/api/smc-index/getPool"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://toncenter.com/api/smc-index/getPool")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://toncenter.com/api/smc-index/getPool")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

200

{
  "stake_amount_sent": 123,
  "validator_amount": 123,
  "nominators_count": 123,
  "active_nominators": [
    {
      "address": "<string>",
      "balance": 123,
      "pending_balance": 123
    }
  ],
  "inactive_nominators": [
    "<string>"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

APIKeyHeaderAPIKeyQuery

X-API-Key · string · header · required

Query Parameters

pool · string · required

The pool address. Can be sent in hex, base64 or base64url form.

Response

200

application/json

Successful Response

stake_amount_sent · integer · required

validator_amount · integer · required

nominators_count · integer · required

active_nominators · ActiveNominatorModel · object[] · required

Show child attributes

inactive_nominators · string[] · required