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

# Quickstart

> Subscribe on RapidAPI and make your first Fexmetrics request.

Fexmetrics is available through RapidAPI. You need an active subscription and your `X-RapidAPI-Key`.

<Steps>
  <Step title="Subscribe on RapidAPI">
    [Choose a plan](https://rapidapi.com/datafex-datafex-default/api/fexmetrics-fivem-redm-server-analytics-api3/pricing). BASIC is free.
  </Step>

  <Step title="Get your key">
    Open the [RapidAPI Developer Dashboard](https://rapidapi.com/developer/dashboard), go to **Security**, and copy your `X-RapidAPI-Key`.
  </Step>

  <Step title="Make a request">
    List public servers with one request:

    ```bash theme={null}
    curl --request GET \
      --url 'https://fexmetrics-fivem-redm-server-analytics-api3.p.rapidapi.com/rapid/v1/servers?limit=5' \
      --header 'X-RapidAPI-Key: YOUR_API_KEY'
    ```
  </Step>

  <Step title="Read the response">
    A successful response contains a `data` array and a `pagination` object. Each server includes identifiers, metadata, and current player counts.

    ```json theme={null}
    {
      "data": [
        {
          "id": "public-fivem",
          "game": "fivem",
          "cfxId": "cfx-public",
          "hostname": "Alpha RP",
          "region": "US",
          "players": { "current": 80, "max": 128 }
        }
      ],
      "pagination": { "page": 1, "limit": 5, "total": 1, "pages": 1 }
    }
    ```

    Use `id` for server-specific endpoints. Pass `by=cfxId` only when using the `cfxId` value.
  </Step>
</Steps>

Continue with an endpoint in the API Reference tab.