Changelog
Changes that affect requests, responses, limits or the docs site, newest first.
2026-11-03 — v2 release
v2 is the current version of the Unofficial Star Citizen API. v1 keeps running as a deprecated compatibility layer on top of it.
Migration Guide → · v1 → v2 Mapping → · v2 API Reference →
Highlights
Claude, Cursor, VS Code and any MCP client can query citizens, organizations, ships, the roadmap and the starmap directly.
One endpoint, /v2/mcp, read-only tools, same API key and quota as the REST API. Setup takes one command or one config block.
- Multiple API keys per account. Up to 10 named keys, with optional expiry. See Added.
- Cached requests are always free. Quota only applies to
?refresh=true. See Rate Limits & Quota. - Longer cache lifetimes. Data stays fresh for hours to days depending on the resource. See Refresh Intervals.
- New documentation site. Live requests, real OpenAPI reference, account management. See Docs.
Breaking changes
These also apply to v1 paths, which now run on the v2 services.
| Change | Action |
|---|---|
Errors use real HTTP status codes instead of 200 + success: 0 | Branch on the HTTP status. See Error Codes |
| Daily quota: 500 daily requests per account, shared by all its keys | Use ?refresh=true only when live data is required. See Rate Limits & Quota |
Per-minute rate limits on every request, reported in X-RateLimit-* headers | Back off on 429. See Per-Minute Rate Limits |
json_path removed | Filter responses client-side |
/gamedata/... returns 410 Gone | Stop calling these routes |
Deprecated
- v1 (
/{apikey}/v1/{mode}/...). v1 is no longer maintained: it receives no new features, no bug fixes and no support.
Removal is planned in a future release.
Replacement: the matching /v2/... route in the endpoint mapping.
Changed
| Topic | v1 | v2 |
|---|---|---|
| Authentication | Key in the URL | x-api-key header |
| Fetch mode | live / eager / cache / auto path segment | ?refresh=true, or nothing for cached data |
| Quota cost | Every live / eager request | Only ?refresh=true; cached and expired-cache requests are free |
| Cache lifetime | Short | Per resource, up to 7 days |
| Response format | success: 1, source | success: true, updatedAt, expiresAt |
Per-endpoint changes (paths, renamed parameters, payload shapes) are listed in the mapping reference: Users · Organizations · Funding goals · Ships · Versions · Roadmap · Progress tracker · Telemetry · Starmap
Added
API
- MCP server at
/v2/mcpfor AI assistants. - Organization search with
GET /v2/organizations/search, and free-textsearchon organization members. - Ship search and direct lookups (
/v2/ships/search,/{id},/by-name,/by-type,/by-manufacturer,/by-chassis,/manufacturers). Refreshing a single ship costs 1 daily request instead of 50 for the whole catalog. - Starmap routes (
GET /v2/starmap/routes) and lookups by id, name and code for every starmap resource. - Progress tracker deliverables and lookups by slug.
- Account endpoints:
GET /v2/mefor quota and keys,DELETE /v2/meto delete the account. - HTTP caching headers (
ETag,Last-Modified,Expires) and304 Not Modified. See HTTP Caching.
Full list: v2-only endpoints.
API keys
Up to 10 named keys per account, each with an optional expiry, managed from the profile page.
| Use case | Benefit |
|---|---|
| One key per environment (production, staging, CI) | Revoking one key leaves the others running |
| Leaked key | Rotate or delete that key only; nothing else breaks |
| Demo, contractor, CI job | An expiring key stops working on its own |
| Audit | GET /v2/me shows each key's lastUsedAt to spot unused keys |
All keys share the account's quota: extra keys do not add requests. See Managing Your Keys.
Docs
A completely new documentation site, rebuilt around v2:
- Live requests. Examples insert the signed-in reader's own key and run in one click.
- Real OpenAPI reference. Interactive API Reference for v1 and v2, generated from the API itself, with downloadable specs.
- Account management. Sign in with Discord or Google, create and manage keys from the profile page.
- New guides. Quickstart, concepts, common patterns, AI assistants and a step-by-step migration guide.