API Reference

Build powerful integrations with our REST API

Base URL

.../api

Rate Limit

60/min • 120/min with key

List Nodes

Retrieve a paginated list of all discovered nodes with optional filtering and sorting.

Parameters

Name	Type	Required	Description
page	integer	optional	Page number for pagination(default: 1)
limit	integer	optional	Number of results per page (max 100)(default: 50)
online	string	optional	Filter by online status: "true" for online nodes only
tier	string	optional	Filter by tier: diamond, gold, silver, bronze, standard
country	string	optional	Filter by country code (ISO 3166-1 alpha-2)
version	string	optional	Filter by client version
verified	string	optional	Filter by verification status: "true" for verified only
sort	string	optional	Sort field: pix_score, uptime, latency, last_seen(default: pix_score)
order	string	optional	Sort order: asc, desc(default: desc)

Example Request

const response = await fetch('/api/nodes', {
  method: 'GET',
});

const data = await response.json();
console.log(data);

Example Response

200 OK

{
  "nodes": [
    {
      "id": "uuid",
      "ip": "192.168.1.1",
      "port": 33117,
      "status": "online",
      "tier": "gold",
      "pix_score": 925,
      "uptime": 99.5,
      "latency_ms": 45,
      "version": "1.16.0",
      "country_code": "US",
      "country_name": "United States",
      "city": "New York",
      "is_verified": true,
      "last_seen": "2024-01-15T12:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 1234,
    "pages": 25
  }
}