Back to documentation

Public API

The Flitt Public API lets you query your own servers and account data securely. Available on Premium, Pro Edge, and Enterprise plans.

Base URL

https://api.flitt.me/v1/public-api

All endpoints are strictly scoped to your account. You cannot access servers you do not own.

Authentication

Generate an API key from your profile page and send it in the Authorization header for every request.

Authorization header

Authorization: Bearer <API_KEY>

  • Keys are shown once when generated.
  • Rotation has a 5-minute cooldown and invalidates the previous key.
  • Never share your API key publicly.

Plan access

Public API access is enabled for Premium, Pro Edge, and Enterprise plans.

  • Freemium: no API access
  • Premium: API v1 enabled
  • Pro Edge: API v1 enabled (SDK-only plan)
  • Enterprise: API v1 enabled

Data isolation

Every request is scoped to your user ID on the backend. Server IDs must belong to you.

  • Access to other users’ data is blocked.
  • Invalid or foreign IDs return a 404 response.
  • All access is logged for audit and abuse protection.

Rate limits

Rate limits are enforced per plan. Remaining usage is returned in response headers.

X-RateLimit-Limit

Maximum requests allowed per hour for your plan.

X-RateLimit-Remaining

Remaining requests in the current window.

X-RateLimit-Reset

Unix timestamp when the quota resets.

Endpoints

All endpoints return JSON. Use pagination via page and limit for list responses.

GET/usage

Account usage

Returns API usage limits and consumption for the last 30 days.

Premium+

{
  "enabled": true,
  "plan": "PREMIUM",
  "limitPerMonth": 50000,
  "usedLast30d": 1240,
  "remaining": 48760,
  "resetAt": "2026-03-05T12:00:00.000Z"
}
GET/servers

List servers

Returns a paginated list of your servers with live status metadata.

Premium+

page (number)

Page number (default: 1).

limit (number)

Items per page (max: 100).

{
  "data": [
    {
      "id": "srv_123",
      "game": "FIVEM",
      "name": "My Server",
      "ip": "203.0.113.42",
      "port": 30120,
      "domainName": "play.example.com",
      "status": "ONLINE",
      "playersOnline": 32,
      "maxPlayers": 64,
      "rating": 4.7,
      "reviewsCount": 120,
      "verifiedBadge": true,
      "createdAt": "2025-11-01T10:12:00.000Z"
    }
  ],
  "pagination": {"page": 1, "limit": 25, "total": 1, "pages": 1}
}
GET/servers/:id

Get server

Returns full metadata for a server you own or manage.

Premium+

id (string)required

Server ID.

{
  "server": {
    "id": "srv_123",
    "game": "FIVEM",
    "name": "My Server",
    "description": "Main RP server",
    "language": "fr",
    "ip": "203.0.113.42",
    "port": 30120,
    "domainName": "play.example.com",
    "iconUpdatedAt": "2026-02-01T10:00:00.000Z",
    "bannerUpdatedAt": "2026-02-01T10:00:00.000Z",
    "createdAt": "2025-11-01T10:12:00.000Z",
    "bridgeConnectedAt": "2026-02-04T09:10:00.000Z",
    "bridgeLastSeenAt": "2026-02-04T09:12:00.000Z",
    "bridgeLastAddon": "2.4.1",
    "bridgeLastPlayerCount": 32,
    "bridgeLastMaxPlayers": 64,
    "bridgeLastMapName": "Los Santos",
    "bridgeLastGameVersion": "1.0.0",
    "logsEnabled": true,
    "publicEnabled": true,
    "planActive": true,
    "planDisabledReason": null,
    "verifiedBadge": true,
    "rating": 4.7,
    "reviewsCount": 120,
    "status": "ONLINE",
    "accessRole": "OWNER",
    "tags": [
      {
        "id": "tag_1",
        "name": "Roleplay",
        "category": "MODE",
        "reputation": {"score": 92, "usageCount": 150}
      }
    ],
    "links": {
      "youtube": null,
      "twitch": null,
      "x": "https://x.com/server",
      "discord": "https://discord.gg/flitt",
      "website": "https://example.com",
      "instagram": null,
      "tiktok": null,
      "facebook": null
    }
  }
}
GET/servers/:id/players

List server players

Returns the players tracked for the server, with online filtering.

Premium+

id (string)required

Server ID.

page (number)

Page number (default: 1).

limit (number)

Items per page (max: 50).

status (string)

Filter by online status (online, offline, all).

{
  "serverId": "srv_123",
  "players": [
    {
      "playerId": "player_1",
      "externalId": "steam:110000112345678",
      "name": "PlayerOne",
      "isVpn": false,
      "country": "France",
      "countryCode": "FR",
      "isp": "Orange",
      "joinCount": 42,
      "firstJoinedAt": "2025-10-20T10:00:00.000Z",
      "lastJoinedAt": "2026-02-04T08:55:00.000Z",
      "lastSeenAt": "2026-02-04T09:12:00.000Z",
      "lastLeftAt": null,
      "lastSessionSeconds": 3600,
      "totalPlaySeconds": 18000,
      "isOnline": true,
      "sessionStartedAt": "2026-02-04T08:55:00.000Z"
    }
  ],
  "pagination": {"page": 1, "limit": 15, "total": 1, "pages": 1}
}
GET/servers/:id/players/:playerId

Get player

Returns a single player by ID or external identifier.

Premium+

id (string)required

Server ID.

playerId (string)required

Player ID or external ID (e.g. steam identifier).

{
  "serverId": "srv_123",
  "player": {
    "playerId": "player_1",
    "externalId": "steam:110000112345678",
    "name": "PlayerOne",
    "isVpn": false,
    "country": "France",
    "countryCode": "FR",
    "isp": "Orange",
    "joinCount": 42,
    "firstJoinedAt": "2025-10-20T10:00:00.000Z",
    "lastJoinedAt": "2026-02-04T08:55:00.000Z",
    "lastSeenAt": "2026-02-04T09:12:00.000Z",
    "lastLeftAt": null,
    "lastSessionSeconds": 3600,
    "totalPlaySeconds": 18000,
    "isOnline": true,
    "sessionStartedAt": "2026-02-04T08:55:00.000Z"
  }
}

Common errors

401 · UNAUTHORIZED

Missing or invalid API key.

Send a valid Authorization header.

403 · FORBIDDEN

Plan does not allow API access.

Upgrade to Premium or higher.

403 · RESTRICTED

Public API access disabled due to non-compliance with the Terms of Use.

Contact support if you believe this is a mistake.

404 · NOT_FOUND

Resource not found.

The server ID does not belong to you.

429 · RATE_LIMITED

Rate limit exceeded.

Wait for the reset window or upgrade plan.

Examples

List serverscurl
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.flitt.me/v1/servers?page=1&limit=25
List server playerscurl
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.flitt.me/v1/servers/srv_123/players?status=online&page=1&limit=15