← Home

⌕

General ER:LC FiveM API

Developers

Conventions

Public API v1

Public API v1: introduction Keys and scopes Errors Rate limits and pagination Idempotency Webhooks

API v1 reference

API v1: server API v1: characters API v1: vehicles API v1: citations, arrests and records API v1: CAD calls API v1: units API v1: corporations API v1: bank API v1: members and roles API v1: moderation API v1: ER:LC sessions API v1: events API v1: webhooks

Other APIs

Game API (FiveM) Bot API

DOCUMENTATION/API v1 reference

API v1: characters

Reference for /v1/characters: characters with their ID card, licences and inventory.

Characters, licenses and inventory. Every route hangs off https://api.blixye.com/v1 and carries the key in the Authorization header (see Keys and scopes ). This page is generated from the API's OpenAPI specification; if it is not here, the API does not do it.

GET /characters: List characters (characters:read)

GET /characters/{id}: Get a character (characters:read)

GET /characters/{id}/licenses: A character's licenses (characters:read)

GET /characters/{id}/inventory: A character's inventory (characters:read + inventory:read)

List characters

GET /characters. Characters of the server, with their ID card. Scope: characters:read.

Parameters:

limit (query; integer, 1-100, default 25, optional): Page size (1-100).

cursor (query; string, optional): The meta.next_cursor of the previous page.

order (query; string, one of: desc, asc, default desc, optional): desc = newest first.

member_id (query; string, optional): Only the characters of this member (usr_…).

name (query; string, optional): Name contains this text.

dni_number (query; string, optional): Exact ID card number.

curl "https://api.blixye.com/v1/characters?limit=25" \
  -H "Authorization: Bearer bx_live_…"

Response 200: A page of characters.

{
  "data": [
    {
      "id": "chr_3tq0vJ1c9Ydl2Hk7WqPzEw",
      "member_id": "usr_3tq0vJ1c9Ydl2Hk7WqPzEw",
      "name": "John Carter",
      "dni_number": "48213377K",
      "status": "approved",
      "is_dead": false,
      "is_ck": false,
      "is_frozen": false,
      "is_admin": false,
      "driving_points": 12,
      "dni": {
        "first_name": "John",
        "last_name": "Carter",
        "nationality": "American",
        "gender": "male",
        "birthdate": "1990-05-14",
        "blood_type": "O+",
        "photo_url": "https://cdn.example.com/photo.png"
      },
      "created_at": "2026-09-27T18:04:05Z"
    }
  ],
  "meta": {
    "next_cursor": "cur_3tq0vJ1c9Ydl2Hk7WqPzEw"
  }
}

Errors (the format is in Errors ):

400: Malformed request (invalid limit, cursor, JSON, Idempotency-Key, or an API key sent in the URL).

401: Missing, invalid, revoked or expired API key (codes missing_api_key, invalid_api_key, api_key_revoked, api_key_expired).

403: The key lacks a scope (missing_scope), the IP is not allowed (ip_not_allowed), the server's plan has no API (plan_required) or an MDT module is off (module_off).

404: Not found in this server. An id from another server is always a 404.

429: Too many requests for this API key (the limit is per key and per minute, by plan). Too many failed authentications from one IP also give a 429.

Get a character

GET /characters/{id}. One character, with its ID card. Scope: characters:read.

Parameters:

id (path; string, required): Resource id.

curl "https://api.blixye.com/v1/characters/chr_3tq0vJ1c9Ydl2Hk7WqPzEw" \
  -H "Authorization: Bearer bx_live_…"

Response 200: The character.

{
  "data": {
    "id": "chr_3tq0vJ1c9Ydl2Hk7WqPzEw",
    "member_id": "usr_3tq0vJ1c9Ydl2Hk7WqPzEw",
    "name": "John Carter",
    "dni_number": "48213377K",
    "status": "approved",
    "is_dead": false,
    "is_ck": false,
    "is_frozen": false,
    "is_admin": false,
    "driving_points": 12,
    "dni": {
      "first_name": "John",
      "last_name": "Carter",
      "nationality": "American",
      "gender": "male",
      "birthdate": "1990-05-14",
      "blood_type": "O+",
      "photo_url": "https://cdn.example.com/photo.png"
    },
    "created_at": "2026-09-27T18:04:05Z"
  }
}

Errors (the format is in Errors ):

400: Malformed request (invalid limit, cursor, JSON, Idempotency-Key, or an API key sent in the URL).

401: Missing, invalid, revoked or expired API key (codes missing_api_key, invalid_api_key, api_key_revoked, api_key_expired).

403: The key lacks a scope (missing_scope), the IP is not allowed (ip_not_allowed), the server's plan has no API (plan_required) or an MDT module is off (module_off).

404: Not found in this server. An id from another server is always a 404.

429: Too many requests for this API key (the limit is per key and per minute, by plan). Too many failed authentications from one IP also give a 429.

A character's licenses

GET /characters/{id}/licenses. The character's licenses (driving and the server's own). Scope: characters:read.

Parameters:

id (path; string, required): Resource id.

curl "https://api.blixye.com/v1/characters/chr_3tq0vJ1c9Ydl2Hk7WqPzEw/licenses" \
  -H "Authorization: Bearer bx_live_…"

Response 200: Licenses.

{
  "data": [
    {
      "license_id": "lic_3tq0vJ1c9Ydl2Hk7WqPzEw",
      "name": "driving",
      "label": "Driving licence",
      "type": "driving",
      "points_remaining": 12,
      "max_points": 12,
      "is_revoked": false,
      "revoked_at": null,
      "granted_at": "2026-09-27T18:04:05Z"
    }
  ]
}

Errors (the format is in Errors ):

400: Malformed request (invalid limit, cursor, JSON, Idempotency-Key, or an API key sent in the URL).

401: Missing, invalid, revoked or expired API key (codes missing_api_key, invalid_api_key, api_key_revoked, api_key_expired).

403: The key lacks a scope (missing_scope), the IP is not allowed (ip_not_allowed), the server's plan has no API (plan_required) or an MDT module is off (module_off).

404: Not found in this server. An id from another server is always a 404.

429: Too many requests for this API key (the limit is per key and per minute, by plan). Too many failed authentications from one IP also give a 429.

A character's inventory

GET /characters/{id}/inventory. Items the character carries. Needs characters:read AND inventory:read. Scopes (all of them): characters:read and inventory:read.

Parameters:

id (path; string, required): Resource id.

curl "https://api.blixye.com/v1/characters/chr_3tq0vJ1c9Ydl2Hk7WqPzEw/inventory" \
  -H "Authorization: Bearer bx_live_…"

Response 200: Inventory.

{
  "data": [
    {
      "item_id": "itm_3tq0vJ1c9Ydl2Hk7WqPzEw",
      "name": "phone",
      "label": "Phone",
      "quantity": 1,
      "equipped_quantity": 0,
      "uses_remaining": null,
      "image_url": "https://cdn.example.com/item.png"
    }
  ]
}

Errors (the format is in Errors ):

400: Malformed request (invalid limit, cursor, JSON, Idempotency-Key, or an API key sent in the URL).

401: Missing, invalid, revoked or expired API key (codes missing_api_key, invalid_api_key, api_key_revoked, api_key_expired).

403: The key lacks a scope (missing_scope), the IP is not allowed (ip_not_allowed), the server's plan has no API (plan_required) or an MDT module is off (module_off).

404: Not found in this server. An id from another server is always a 404.

429: Too many requests for this API key (the limit is per key and per minute, by plan). Too many failed authentications from one IP also give a 429.

← Previous

API v1: server

API v1: vehicles

38 / 54 Something missing here →

STEP 1 · PLAN ×

Pick your server's plan

After payment you name it and we configure it together. You can change plan whenever you like.

FREE1 OF 1 LEFT Up to 500 characters and basic CAD. To try it. 0 €

PLUSMONTHLY Full CAD, moderation, activity and economy. 5,99 €

PREMIUMER:LC & FIVEM Everything in PLUS, FiveM included and higher limits. 12,99 €

ENTERPRISEPERMANENT All of PREMIUM forever, self-hosted, never a fee. Contact

Continue to payment

Cancel any time · 14-day withdrawal right, unless you ask to start straight away

Confirm and pay

ER:LC PREMIUM

Monthly · one licence

12,99 €

CARD

Back

In development — unavailable

Blixye is in development: services can’t be purchased yet.

Name your server

This is the name your players see in the launcher and on Discovery. You can change it whenever.

SERVER NAME

It gets a short code, like SKY-T2Q, to link the launcher.

NEXT Once created we open the setup guide: launcher, Discord and modules in three steps.

Back

Create the server

Type at least 3 characters.

STEP 1 OF 3 · GUIDE ×

1. Send your people the launcher

It is the only thing they install, and only once. They sign in with Discord, we verify their Roblox account and the overlay shows over the session.

Go to the download

2. Create your departments

Police, sheriff, fire or whatever you run. Each with its ranks and permissions: that decides who can punish, clock in or read records.

3. Open the server

With the first duty shift the calls, activity and economy start filling up. From there you just tune it.

Back

⌕ ESC

In-game overlay Radio, sheet and dispatch over the session, no alt-tab. ER:LC CAD and departments Queued calls, units with status and rosters with ranks. ER:LC Moderation and appeals Punishments with context, logs and appeals that do not get lost. ER:LC Staff activity Quotas per rank, shifts and an automatic weekly report. ER:LC Economy and businesses Accounts, payroll, player businesses and inventory. ER:LC Blixye Framework The core: characters, permissions, database and QBCore and ESX bridge. FiveM Inventory Weight, containers and safe player trades. FiveM Police MDT Records, fines, warrants and plate lookups. FiveM Banking Accounts, transfers, payroll and business accounts. FiveM Jobs Shifts, payroll and per-company hierarchy. FiveM Garages Vehicle ownership, persistent damage and impound. FiveM Housing Buying, renting, furniture and personal storage. FiveM Phone Messages, calls, apps and in-world socials. FiveM EMS Per-limb injuries, treatment and a hospital with beds. FiveM All the scripts All eight scripts unlimited, as a permanent purchase or a subscription. FiveM Install Blixye on ER:LC From an empty server to the first duty shift, without touching a game file. Docs Install the FiveM framework The zip, the SQL and your current base bridge, in the right order. Docs Your first week What to set up each day so you do not end up with twenty half-done things. Docs CAD and dispatch Calls, units and priorities inside the overlay. Docs Moderation and appeals Punishments with evidence, appeals and the log that covers you. Docs Activity and shifts Hours, quotas and who is really patrolling. Docs Scripts and free version What each script free version limits and what the full one opens. Docs QBCore and ESX bridge Living with your current base without duplicating players or money. Docs Performance Where to look when the server stutters. Docs

↵ open CTRL K search 37 results

ROTATE THE KEY ×

! The current key stops working the moment you confirm. This cannot be undone.

current key → new key on confirm

Paste the new key into the script config.

Restart the resource: refresh and ensure.

Until you do, the script will not load.

Yes, rotate the key Cancel

What each plan includes ×

FREE

DISCORD

PLUS

PREMIUM

ENTERPRISE

Price

Free

2,99 €/mo

5,99 €/mo

12,99 €/mo

Contact

GENERAL

Characters stored

500

—

5000

∞

Custom invite code

—

✓

CAD

Max corporations

—

∞

Max subdivisions

—

∞

MDT data wipe

1 month

—

1 year

Never

MDT access

Complete

—

Complete

Logs history

7 days

—

90 days

∞

Data export

—

✓

Investigations

—

✓

Evidence storage

—

Unmetered

Custom laws

—

150

∞

Real-time map

—

✓

Bodycam

—

✓

Realtime map location

—

✓

Advanced search

—

✓

Radio channels (Discord VC)

—

100

∞

Roles per corporation

—

∞

BANK

Bank accounts

1 per char

—

3 per char

6 per char

12 per char

Transfers

✓

—

✓

Transaction history

✓

—

✓

Cards per account

—

Timed cards

Fixed durations

—

✓

Usage-based cards

—

Max 5 per char

✓

Role rewards

✓

—

✓

Allow negative balance

—

✓

Scheduled transfers

—

✓

Player debts

—

✓

Per-operation limits

—

✓

Shared accounts

Max 2 members

—

Max 5 members

∞

ADMIN

Player heatmap

—

✓

✓ more precise

Max forms

∞

Your server on the phone

—

✓

Max admin roles

owner +2

owner +5

owner +10

∞

Priority support

—

✓

Staff audit log history

7 days

30 days

90 days

∞

Beta features

—

✓

Create server

Character and storage addons stack on any plan.

Cookies ESSENTIAL ONLY

We only use the essential ones: your session, sign-in security and your language. There is no analytics and no advertising, so there is nothing to accept or reject.

Got it

Cookie policy