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

# List Servers

> Returns paginated public FiveM and RedM servers. Filter by game, region, name, or online state.



## OpenAPI

````yaml /rapidapi-v1.yaml get /rapid/v1/servers
openapi: 3.0.2
info:
  title: Fexmetrics RapidAPI
  version: 1.0.0
  description: |
    Customer-facing RapidAPI v1 contract.

    Raw history returns recorded time-series observations and is restricted by
    plan depth. Stats, growth, peak-hours, integrity, and compare return derived
    calculations; access to a derived range does not grant raw observations for
    that range.

    `by=id` is the default wherever `by` is available. Use `by=cfxId` when the
    identifier is a CFX network ID.

    RapidAPI handles authentication, request limits, quotas, and billing.
  contact:
    name: Fexmetrics
servers:
  - url: https://fexmetrics-fivem-redm-server-analytics-api3.p.rapidapi.com
    description: RapidAPI gateway
security:
  - RapidApiKey: []
tags:
  - name: Servers
    description: Public server discovery and current state.
  - name: Raw History
    description: Recorded observations with plan-specific download depth.
  - name: Analytics
    description: Derived summaries calculated from bounded observation windows.
  - name: Integrity
    description: Explainable heuristic analysis; never proof or a calibrated probability.
  - name: Comparison
    description: Set-based comparison of two to five public servers.
paths:
  /rapid/v1/servers:
    get:
      tags:
        - Servers
      summary: List Servers
      description: >-
        Returns paginated public FiveM and RedM servers. Filter by game, region,
        name, or online state.
      operationId: listRapidServers
      parameters:
        - name: q
          in: query
          description: Case-insensitive server search.
          schema:
            type: string
            minLength: 1
            maxLength: 100
        - name: game
          in: query
          schema:
            type: string
            enum:
              - fivem
              - redm
        - name: region
          in: query
          description: Two-letter region code; normalized to uppercase.
          schema:
            type: string
            pattern: ^[A-Za-z]{2}$
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 1000000
            default: 1
        - name: sort
          in: query
          schema:
            type: string
            enum:
              - players
            default: players
        - name: order
          in: query
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
        - name: offline
          in: query
          description: Exact offline-state filter; omit to include both states.
          schema:
            type: boolean
      responses:
        '200':
          description: Public server page.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerListResponse'
              examples:
                success:
                  value:
                    data:
                      - id: public-fivem
                        game: fivem
                        cfxId: cfx-public
                        hostname: Alpha RP
                        projectName: Alpha Roleplay
                        projectDescription: English roleplay community
                        region: US
                        players:
                          current: 80
                          max: 128
                        tags:
                          - roleplay
                          - english
                        flags:
                          - EN
                          - WHITELIST
                        discord: https://discord.example/alpha
                        iconUrl: https://images.example/server-icon.png
                        offline: false
                        firstSeenAt: '2026-01-01T00:00:00.000Z'
                        updatedAt: '2026-08-14T08:00:00.000Z'
                    pagination:
                      page: 1
                      limit: 20
                      total: 1
                      pages: 1
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/FeatureNotAvailable'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    ServerListResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PublicServer'
        pagination:
          $ref: '#/components/schemas/Pagination'
    PublicServer:
      type: object
      additionalProperties: false
      required:
        - id
        - game
        - cfxId
        - hostname
        - projectName
        - projectDescription
        - region
        - players
        - tags
        - flags
        - discord
        - iconUrl
        - offline
        - firstSeenAt
        - updatedAt
      properties:
        id:
          type: string
        game:
          type: string
          enum:
            - fivem
            - redm
        cfxId:
          type: string
        hostname:
          type: string
        projectName:
          type: string
        projectDescription:
          type: string
        region:
          type: string
        players:
          type: object
          additionalProperties: false
          required:
            - current
            - max
          properties:
            current:
              type: integer
            max:
              type: integer
        tags:
          type: array
          items:
            type: string
        flags:
          type: array
          items:
            type: string
        discord:
          type: string
          nullable: true
        iconUrl:
          type: string
          nullable: true
        offline:
          type: boolean
        firstSeenAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Pagination:
      type: object
      additionalProperties: false
      required:
        - page
        - limit
        - total
        - pages
      properties:
        page:
          type: integer
          minimum: 1
        limit:
          type: integer
          minimum: 1
          maximum: 100
        total:
          type: integer
          minimum: 0
        pages:
          type: integer
          minimum: 0
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - INVALID_REQUEST
                - RAPIDAPI_UNAUTHORIZED
                - FEATURE_NOT_AVAILABLE
                - SERVER_NOT_FOUND
                - RATE_LIMITED
                - INTERNAL_ERROR
            message:
              type: string
  responses:
    InvalidRequest:
      description: Query, path, body, range, or duplicate-reference validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalidRequest:
              value:
                error:
                  code: INVALID_REQUEST
                  message: Invalid request
    Unauthorized:
      description: RapidAPI authentication failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              value:
                error:
                  code: RAPIDAPI_UNAUTHORIZED
                  message: Unauthorized
    FeatureNotAvailable:
      description: The authenticated subscription does not include this feature or range.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            featureNotAvailable:
              value:
                error:
                  code: FEATURE_NOT_AVAILABLE
                  message: Feature not available for this subscription
    InternalError:
      description: Unexpected service error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              value:
                error:
                  code: INTERNAL_ERROR
                  message: Internal server error
  securitySchemes:
    RapidApiKey:
      type: apiKey
      in: header
      name: X-RapidAPI-Key
      description: Customer key supplied by RapidAPI.
      x-default: YOUR_API_KEY

````