> ## Documentation Index
> Fetch the complete documentation index at: https://docs.readmin.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Ranking API

> Ranking API allows workspace owners to provide granular group automtions that can be locked to certain ranks, and actions.

The Ranking API lets you automate Roblox group management on your terms. Issue
scoped keys that can only perform the exact actions and rank changes you allow —
rank, exile, shout, and handle join requests — then wire them into your own games
and tools with the [Ranking Module](/api-reference/ranking-module). Keys are
scoped and revocable, so automation never overreaches.

## Requirements to use Ranking API

1. You must have a premium workspace
2. You must configure a Roblox bot
3. You must be the workspace owner

## Setup

Setting up your bot is very easy, simply navigate to your workspace settings, and press "Create Key." Then set your desired settings/restrictions.

<Warning>
  Do not share your ranking key, it gives people the ability to use your ranking API as you.
</Warning>

<img src="https://mintcdn.com/readmin/E3q2oHNta8NF-_mC/images/ranking-api.png?fit=max&auto=format&n=E3q2oHNta8NF-_mC&q=85&s=e8e71c4b7198275293e12166a61fe928" width="3258" height="1220" data-path="images/ranking-api.png" />

## API Routes

The API base route is [https://api.readmin.app/ranking](https://api.readmin.app/ranking)

You must provide your api-key (your ranking key including the DO\_NOT\_SHARE\_....).

[You can view the ranking APIs here](https://docs.readmin.app/api-reference/endpoint/ranking-key/get-information-about-the-ranking-key)