code Developer Documentation

Developer REST API

Build custom presentation dashboards, stream overlays, and data pipelines using standard HTTPS JSON endpoints.

dns Base Endpoint
https://pollflux.com/api/v1

All API endpoints require HTTPS with TLS 1.2 or 1.3 encryption.

speed Rate Limiting
60 requests / minute

Public endpoints are rate-limited per IP to prevent spam and preserve bandwidth.

data_object Response Format
application/json

Standard UTF-8 encoded JSON with consistent HTTP status codes.

GET /api/v1/polls/{id}
Public Endpoint
Retrieve Poll State & Vote Breakdown

Returns real-time poll metadata, status, cumulative vote tally, and individual option counts.

Path Parameters
  • id UUID — Unique identifier of the target poll.
Example cURL Request
curl -X GET "https://pollflux.com/api/v1/polls/550e8400-e29b-41d4-a716-446655440000" \
  -H "Accept: application/json"
200 OK Response Payload
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Which cloud provider does your team prefer?",
  "isActive": true,
  "createdAt": "2026-10-22T10:00:00Z",
  "totalVotes": 1420,
  "options": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "text": "AWS",
      "voteCount": 810,
      "percentage": 57.0,
      "imageUrl": null
    },
    {
      "id": "2da85f64-5717-4562-b3fc-2c963f66afa7",
      "text": "Azure / GCP",
      "voteCount": 610,
      "percentage": 43.0,
      "imageUrl": null
    }
  ]
}
GET /api/v1/polls/trending
Public Endpoint
Query Trending Public Polls

Returns a curated list of active, publicly accessible polls sorted chronologically with current engagement metrics.

Query Parameters
  • limit integer (Optional, Default: 10, Max: 50) — Count of records to return.
Example JavaScript (Fetch)
const res = await fetch('https://pollflux.com/api/v1/polls/trending?limit=5');
const data = await res.json();
console.log(data.polls);
200 OK Response Payload
{
  "count": 2,
  "polls": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "title": "Favorite Web Framework in 2026?",
      "createdAt": "2026-10-22T08:30:00Z",
      "totalVotes": 3890,
      "optionCount": 4
    },
    {
      "id": "780e8400-e29b-41d4-a716-446655440111",
      "title": "Best Database for High Concurrency?",
      "createdAt": "2026-10-21T15:20:00Z",
      "totalVotes": 1280,
      "optionCount": 3
    }
  ]
}
Need WebSocket Stream Access or Custom Webhooks?

Enterprise users can connect directly to our SignalR Hub clusters for high-volume raw event ingestion.

Explore Enterprise Integrations