# Getting Started

The EasyRanks API allows developers to use the api to rank users outside of our services. This means developers can make automated process for their group using our API. Some process that some developers may make are the following: Ranking Sticks, Ranking Commands, App Centers, and Rank Centers.\
\
if you do not know what an API is or what an API does, we do not recommend purchasing the API. The API will require you to understand basics of LUA.\
\
`How do I insert the API?`

```lua
local API = require(10005387312)({key = "", beta = false}) 
```

`How do I whitelist my game?`\
In order to whitelist your game, you will need to do the following:\
\
1\). Grab your game's id from the link\
2\). Open your dms with EasyRanks Management Bot\
3\). Type the command `api add`\
4\). Paste the gameid and send the command (`api add gameidhere`)

{% hint style="warning" %}
Make sure you whitelist your game before trying to use the API.
{% endhint %}

{% hint style="danger" %}
You can only use the API in server sided scripts, so make sure you are not trying to import the asset in a LocalPlayer script.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.easyranks.tech/overview/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.