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

# Information

> Server name, online count and status. Query parameters add players, staff, queue and logs.



## OpenAPI

````yaml en/openapi/en-api-v3-openapi.yaml GET /erlc/server
openapi: 3.1.0
info:
  title: ER:LC Russia API V3
  description: >-
    ER:LC Russia API for servers, users, CDN, redirects, subscriptions, and
    access keys.
  version: 3.0.0
servers:
  - url: https://api.erlcrussia.com/v3
    description: Production server (com)
  - url: https://api.erlcrussia.xyz/v3
    description: Backup server (xyz)
security: []
tags:
  - name: ER:LC Server
    description: Obtaining status, online, lists of players and staff of the ER:LC server.
  - name: ER:LC Teams
    description: Sending and queuing in-game server commands (:h, :m, :kick, :ban, etc.).
  - name: Economics
    description: >-
      Interaction with the economic system (users, businesses, mafias, stores,
      advertising).
  - name: Statistics API
    description: >-
      High-performance obtaining statistics of discord servers and game servers
      (online, participants, bots).
  - name: Verification API
    description: Search and comparison of Discord ID and Roblox ID accounts.
  - name: CDN Assets
    description: >-
      Load, manage, statistic and clear MinIO/Edge CDN object storage file
      cache.
  - name: CDN Folders
    description: Hierarchical structure and sorting of CDN media library folders.
  - name: Punishment API
    description: Manage the balance and transaction history of players' points.
  - name: Subscriptions API
    description: >-
      Catalog of plans, FunPay orders, accrual of benefits and activation of
      subscriptions.
  - name: Authorization API
    description: >-
      Login via Discord and Roblox OAuth2, manage user sessions and link
      accounts.
  - name: Management API - WebSocket Keys
    description: Managing access keys to the WebSocket gateway and channel subscriptions.
  - name: Management API - Webhooks
    description: Registration, accessibility validation and monitoring of custom webhooks.
  - name: Control API - Panel
    description: >-
      Management of users, subscriptions, tariffs, manual balance and system
      statistics.
  - name: State API
    description: >-
      Monitoring the performance of the service, connections to PostgreSQL and
      Redis.
  - name: AI Audio
  - name: AI Studio
  - name: AI administration
  - name: API Keys
  - name: Admin API - Servers
  - name: Administration of E-Coins
  - name: CDN
  - name: CDN Domains
  - name: CDN V3
  - name: Custom Webhooks
  - name: Management API - Servers
  - name: Management API - Tokens
  - name: Organization redirects V3
  - name: Private files and library
  - name: Рекламные кампании V3
paths:
  /erlc/server:
    get:
      tags:
        - ER:LC Server
      summary: Information
      description: >-
        Server name, online count and status. Query parameters add players,
        staff, queue and logs.
      parameters:
        - name: Players
          in: query
          description: Включить детальный список игроков на сервере.
          schema:
            type: boolean
        - name: Staff
          in: query
          description: Включить список сотрудников и модераторов (Admins, Mods).
          schema:
            type: boolean
        - name: JoinLogs
          in: query
          description: Включить журнал входов и выходов.
          schema:
            type: boolean
        - name: Queue
          in: query
          description: Включить состояние очереди ожидания подключения.
          schema:
            type: boolean
        - name: KillLogs
          in: query
          description: Включить журнал убийств.
          schema:
            type: boolean
        - name: CommandLogs
          in: query
          description: Включить журнал выполненных команд.
          schema:
            type: boolean
        - name: ModCalls
          in: query
          description: Включить активные вызовы модераторов.
          schema:
            type: boolean
        - name: Vehicles
          in: query
          description: Включить список заспавненных транспортных средств.
          schema:
            type: boolean
      responses:
        '200':
          description: Successful response with server data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Name:
                    type: string
                  OwnerId:
                    type: integer
                  CoOwnerIds:
                    type: array
                    items:
                      type: integer
                  CurrentPlayers:
                    type: integer
                  MaxPlayers:
                    type: integer
                  JoinKey:
                    type: string
                  AccVerifiedReq:
                    type: string
                  TeamBalance:
                    type: boolean
                  Players:
                    type: array
                    items:
                      type: object
                      properties:
                        Player:
                          type: string
                        Permission:
                          type: string
                        Callsign:
                          type: string
                        Team:
                          type: string
                  Queue:
                    type: array
                    items:
                      type: integer
              example:
                Name: Moscow RolePlay I RU
                OwnerId: 1234567
                CoOwnerIds:
                  - 7654321
                CurrentPlayers: 32
                MaxPlayers: 40
                JoinKey: MRPRU
                AccVerifiedReq: Disabled
                TeamBalance: true
                Players:
                  - Player: Builderman:156
                    Permission: Server Administrator
                    Callsign: 1-A-12
                    Team: Police
                Queue:
                  - 261
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      security:
        - BearerAuth: []
        - ApiKeyHeader: []
components:
  responses:
    UnauthorizedError:
      description: Unauthorized (401) — the API token is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missing_token:
              summary: Missing Token (5007)
              value:
                code: 5007
                message: Missing Token
            invalid_token:
              summary: Invalid Token (5008)
              value:
                code: 5008
                message: Invalid Token
    ForbiddenError:
      description: >-
        Forbidden (403) - access is prohibited (key, action or server
        restrictions).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            forbidden:
              summary: Forbidden (5009)
              value:
                code: 5009
                message: Forbidden
  schemas:
    ErrorResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          example: 5009
          description: Numeric error code ER:LC Russia API.
        message:
          type: string
          example: Forbidden
          description: System error message in English.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key in the Authorization header in the format `Bearer <token>`.
    ApiKeyHeader:
      type: apiKey
      in: header
      name: erlcrussia-api-key
      description: >-
        Custom API key. Store on the server; do not include client-side
        JavaScript.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.