> ## 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.

# Quickstart

> Pick the shortest path for the part of Rankly you need.

If you already know your use case, jump directly to the matching guide. If you do not, use this page to choose.

## Pick a path

<CardGroup cols={3}>
  <Card title="Server Owner" icon="server" href="/servers/getting-started">
    List your Discord server, tune your profile, and connect vote webhooks.
  </Card>

  <Card title="Bot Developer" icon="code" href="/bots/api-integration">
    Read Rankly data from your bot and process vote events in real time.
  </Card>

  <Card title="API Consumer" icon="book-open" href="/servers/api-reference">
    Use the public API to fetch server, bot, vote, and review data.
  </Card>
</CardGroup>

## The shortest route

### Server owners

<Steps>
  <Step title="Create or open your dashboard listing">
    Sign in at the dashboard, add your server, and fill in the details that make your listing useful.
  </Step>

  <Step title="Set the webhook URL">
    Add your vote webhook endpoint if you want Rankly to notify your own backend when a vote lands.
  </Step>

  <Step title="Check credits and growth options">
    Review your earned balance, spendable balance, and any growth tools you want to enable.
  </Step>
</Steps>

### Bot developers

<Steps>
  <Step title="Keep your API key server-side">
    Use the public API from your backend or bot process only. Do not ship your key to the browser.
  </Step>

  <Step title="Call the exact endpoint you need">
    Most integrations only need [server details](/servers/api-reference), [bot details](/servers/api-reference), or [vote status](/servers/api-reference).
  </Step>

  <Step title="Handle webhook events if you need push updates">
    For real-time vote handling, use the bot vote webhook guide instead of polling.
  </Step>
</Steps>

### If you only need the reference

Use the [Public API Reference](/servers/api-reference) for exact request and response examples.

## What to read next

<CardGroup cols={2}>
  <Card title="List Your Server" href="/servers/getting-started">
    Start with the basics of a solid server listing.
  </Card>

  <Card title="Public API Reference" href="/servers/api-reference">
    See authentication, response envelopes, and all supported endpoints.
  </Card>

  <Card title="Vote Webhooks" href="/servers/webhooks">
    Receive vote notifications in your own backend.
  </Card>

  <Card title="Bot API Integration" href="/bots/api-integration">
    Fetch Rankly data in your bot or service.
  </Card>
</CardGroup>