Skip to main content

EasyPoll API Documentation

Welcome to the EasyPoll API documentation! This guide provides all the information you need to interact with the EasyPoll API, including endpoints, request and response formats, authentication methods, and more.

info

The EasyPoll API is currently in beta and may undergo changes. Please refer to this documentation for the latest updates.

Base URL​

The base URL for all API requests is:

https://easypoll.bot/api

Authentication​

To authenticate with the EasyPoll API, you need to obtain an API key. You can get your API key by logging into the EasyPoll dashboard and navigating to API Keys.

Include your API key in the Authorization header of each request to authenticate:

Authorization: Bearer <api-key>

Rate Limiting​

The EasyPoll API enforces rate limiting to ensure fair usage. If you exceed this limit, you will receive a 429 Too Many Requests response. You can check your current rate limit status using the following headers in the API response:

  • x-ratelimit-limit: The maximum number of requests allowed in the time window
  • x-ratelimit-remaining: The number of requests remaining in the time window
  • x-ratelimit-reset: The time in seconds until the rate limit resets

Additionally, the API provides hourly and daily rate limit headers, which may be more restrictive on some routes:

  • x-ratelimit-limit-hour: The maximum number of requests allowed per hour
  • x-ratelimit-remaining-hour: The number of requests remaining in the hour
  • x-ratelimit-reset-hour: The time in seconds until the hourly rate limit resets
  • x-ratelimit-limit-day: The maximum number of requests allowed per day
  • x-ratelimit-remaining-day: The number of requests remaining in the day
  • x-ratelimit-reset-day: The time in seconds until the daily rate limit resets

If you hit a rate limit, you should wait until the reset before making additional requests.
The retry-after header in the response indicates the number of seconds to wait before retrying.