Getting Started

caution

Disclaimer: this is an unofficial Star Citizen fan site, not affiliated with the Cloud Imperium group of companies. All content not authored by its host or users are property of their respective owners (robertsspaceindustries.com).

The Unofficial Star Citizen API provides programmatic access to data from the RSI website — including Citizens, Organizations, Ships, the Roadmap, Funding Stats, Telemetry, Versions, Starmap, and Progress Tracker.

Data Modes

Every request includes a mode path parameter that controls where data is fetched from:

Mode	Description
live	Fetches fresh data directly from the RSI website. Slower, but always up-to-date. Each live result also refreshes the cache. Consumes your daily quota.
cache	Returns data from the internal database. Fast, unrestricted, but may be slightly stale.
auto	Tries cache first; falls back to live if no cached data is available.
eager	Tries live first; falls back to cache if live fails or your quota is exhausted.

tip

Use cache mode wherever freshness is not critical — it is fast, quota-free, and reduces load on the RSI website.

API Key

An API key is required for every request. Pass it in the x-api-key request header:

GET /v1/live/users/dymerz HTTP/1.1
Host: api.starcitizen-api.com
x-api-key: 0d32404d021613ba948ba0aeef324ef5

Quota: each key allows 1,000 requests per day in live mode. cache mode is unrestricted. Quotas reset automatically every 24 hours.

Getting an API Key

Option 1 — Web login (recommended)

Click Discord or Google in the banner just below the navigation bar. After logging in, your API key is displayed and saved in your browser for future visits.

Option 2 — Discord bot

Join the Discord server, navigate to the keys channel, and run /api register. The bot will send your key via private message.

tip

After logging in, click Profile in the top banner to view your remaining quota, renew your key, or delete your account.

Response Format

All endpoints return a consistent JSON envelope:

{
  "message": "ok",
  "source": "live",
  "success": true,
  "data": {}
}

Field	Type	Description
success	true | false	true = success, false = error
message	string	Human-readable status message
source	string	Origin of the data: live, cache, or null
data	any	The actual response payload

warning

Always check success and the HTTP status code to detect errors. Do not rely on the message field for error handling — its content may change without notice.

tip

For a full interactive list of all available endpoints with parameters and response schemas, see the API Reference.

Quick Example

GET /v1/cache/users/dymerz HTTP/1.1
Host: api.starcitizen-api.com
x-api-key: 0d32404d021613ba948ba0aeef324ef5

{
  "message": "ok",
  "success": true,
  "source": "cache",
  "data": {
    "profile": {
      "handle": "Dymerz",
      "display": "[ΩP] Dymerz",
      "enlisted": "2016-08-19T00:00:00.000000",
      "fluency": ["French", "English"]
    },
    "organization": {
      "name": "Protectorat (EU/QC/974/PC)",
      "sid": "PROTECTORA",
      "rank": "Membre"
    }
  }
}

note

success is a boolean (true / false), not an integer.