The public API lets your own tools read characters with their ID card, licences and inventory, vehicles, citations, arrests and records, CAD calls and units, corporations with their ranks and members, bank movements, server members and roles, sanctions and bans, and ER:LC sessions. It can write citations, CAD calls and sanctions. And it tells you what happens through webhooks or polling.
The public API lets your own tools read characters with their ID card, licences and inventory, vehicles, citations, arrests and records, CAD calls and units, corporations with their ranks and members, bank movements, server members and roles, sanctions and bans, and ER:LC sessions. It can write citations, CAD calls and sanctions. And it tells you what happens through webhooks or polling.
The public API lets your own tools read characters with their ID card, licences and inventory, vehicles, citations, arrests and records, CAD calls and units, corporations with their ranks and members, bank movements, server members and roles, sanctions and bans, and ER:LC sessions. It can write citations, CAD calls and sanctions. And it tells you what happens through webhooks or polling.
NOTE
The public API lets your own tools read characters with their ID card, licences and inventory, vehicles, citations, arrests and records, CAD calls and units, corporations with their ranks and members, bank movements, server members and roles, sanctions and bans, and ER:LC sessions. It can write citations, CAD calls and sanctions. And it tells you what happens through webhooks or polling.
It does not move money or items, nor apply character kills: that is not in v1.
It does not move money or items, nor apply character kills: that is not in v1.
NOTE
It does not move money or items, nor apply character kills: that is not in v1.
The server needs a Plus, Premium or Business plan. Without one, every request answers 403 plan_required.
The server needs a Plus, Premium or Business plan. Without one, every request answers 403 plan_required.
NOTE
The server needs a Plus, Premium or Business plan. Without one, every request answers 403 plan_required.
Your first request
Your first request
NOTE
Your first request
curl "https://api.blixye.com/v1/server" \
-H "Authorization: Bearer bx_live_…"
curl "https://api.blixye.com/v1/server" \
-H "Authorization: Bearer bx_live_…"
NOTE
curl "https://api.blixye.com/v1/server" \
-H "Authorization: Bearer bx_live_…"
NOTE
The base is https://api.blixye.com/v1.
The key goes ONLY in the Authorization: Bearer header. How to get one and which scopes it carries: Keys and scopes.
The server comes from the key: no route asks for the server id, and an id from another server is always a 404.
A success is {"data": …} and, in lists, also {"meta": {"next_cursor": …}}. An error is {"error": {"code", "message", "request_id"}} with the real HTTP status (Errors).
Where to go next
Where to go next
NOTE
Where to go next
NOTE
Rate limits and pagination: how many requests per minute and how to walk through lists.
Idempotency: retry a POST without creating anything twice.
Webhooks: receive events at your URL, signed.
The reference, resource by resource, starts at API v1: server.