code REST Developer API

API Reference

Build custom integrations, pull live stats, and record votes programmatically using our HTTPS endpoints.

GET /api/v1/polls/{id}

Response format: JSON

Retrieve Poll Data

Fetches the full state of a poll in real-time, including aggregate vote counts and complete option breakdowns.

URL Parameters

id string — The unique UUIDv4 string identifier of the poll.

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Favorite Programming Language?",
  "totalVotes": 1240,
  "options": [
    { "id": "opt_1", "text": "C#", "voteCount": 800 },
    { "id": "opt_2", "text": "Python", "voteCount": 440 }
  ]
}

POST /api/v1/polls/{id}/vote

Response format: JSON

Submit a Vote

Programmatically cast a vote for a specific option. Voting is constrained by standard platform rate-limits and fraud rules.

Request Body

optionId string — Required ID of the chosen vote option.

// Request Payload
{
  "optionId": "opt_1"
}

// 200 OK Response
{
  "success": true,
  "message": "Vote recorded successfully."
}