Documentation Index
Fetch the complete documentation index at: https://docs.rankly.live/llms.txt
Use this file to discover all available pages before exploring further.
| Term | Meaning |
|---|---|
| API key | A secret key used to authenticate a server or bot against the public API. |
| Credits | Rankly’s internal balance unit used for growth, promotions, and premium flows. |
| Earned credits | Credits gained from activity such as votes. |
| Session credits | Credits tied to session-based activity or usage rewards. |
| Purchased credits | Credits added through top-ups or checkout. |
| Vote webhook | A POST request Rankly sends when a vote is verified. |
| bot_vote | The event name used by bot vote webhooks. |
| creditsAwarded | Boolean in the webhook payload showing whether the vote earned credits. |
| creditDenialReason | Text explaining why a vote did not earn credits. |
| Auto-bump | A scheduled visibility boost that keeps a server higher in the listing. |
| Cooldown | The wait period before the same user can vote again. |
| Webhook secret | The secret you use to verify that a webhook request really came from Rankly. |
| Rate limit | The maximum number of requests Rankly accepts in a given time window. |
| Verification token | A short-lived token used during vote verification. |
| Public API | The read-only Rankly API for server and bot metadata, votes, and reviews. |