API Reference

Unofficial Star Citizen API providing access to users, organizations, ships, versions, roadmap, progress tracker, starmap, stats, and telemetry

Every endpoint of the Unofficial Star Citizen API v2, with its parameters and responses. The interactive reference, with live requests, loads in the browser.

Me

GET`/v2/me`

Get current user profile

Retrieves the authenticated user profile and the metadata of their API keys

200 — Current user profile retrieved successfully
401 — Invalid or expired token
403 — Forbidden
429 — Too many requests

DELETE`/v2/me`

Delete account

Permanently deletes the account that owns the API key being used, and all of its keys

200 — Account deleted successfully
401 — Invalid or expired token
403 — Forbidden
429 — Too many requests

DELETE`/v2/me/unregister`

Unregister account

Permanently deletes the account and all of its API keys

200
401 — Invalid or expired token
403 — Forbidden
429 — Too many requests

Users

GET`/v2/users/{handle}`

Get user information and organization

Retrieves information about a Star Citizen user and their organization by handle

Parameter	In	Type	Required	Description
`handle`	path	`string`	Yes	The Star Citizen user handle
`refresh`	query		No

200 — User information retrieved successfully
401 — Invalid API key
404 — User not found
429 — Too many requests

GET`/v2/users/{handle}/profile`

Get user information

Retrieves information about a Star Citizen user by handle

Parameter	In	Type	Required	Description
`handle`	path	`string`	Yes	The Star Citizen user handle
`refresh`	query		No

200 — User information retrieved successfully
401 — Invalid API key
404 — User not found
429 — Too many requests

GET`/v2/users/{handle}/organization`

Get user organization

Retrieves information about a Star Citizen user organization by handle

Parameter	In	Type	Required	Description
`handle`	path	`string`	Yes	The Star Citizen user handle
`refresh`	query		No

200 — User organization retrieved successfully
401 — Invalid API key
404 — User not found
429 — Too many requests

Organizations

GET`/v2/organizations/search`

Search organization

Search for organizations based on various criteria

Parameter	In	Type	Required	Description
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes 1 daily request.
`activity`	query	`1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 11 \| 12 \| 13 \| 14[]`	No	Filter by activity
`commitment`	query	`CA \| RE \| HA[]`	No	Filter by commitment
`languages`	query	\| ab \| aa \| af \| ak \| sq \| am \| ar \| an \| hy \| as \| av \| ae \| ay \| az \| bm \| ba \| eu \| be \| bn \| bh \| bi \| nb \| bs \| br \| bg \| my \| ca \| km \| ch \| ce \| ny \| zh \| cu \| cv \| kw \| co \| cr \| hr \| cs \| da \| nl \| dz \| en \| eo \| et \| ee \| fo \| fj \| fi \| fr \| ff \| gd \| gl \| lg \| ka \| de \| el \| gn \| gu \| ht \| ha \| he \| hz \| hi \| ho \| hu \| is \| io \| ig \| id \| ia \| ie \| iu \| ik \| ga \| it \| ja \| jv \| kl \| kn \| kr \| ks \| kk \| ki \| rw \| ky \| kv \| kg \| ko \| kj \| ku \| lo \| la \| lv \| li \| ln \| lt \| lu \| lb \| mk \| mg \| ms \| ml \| dv \| mt \| gv \| mi \| mr \| mh \| mn \| na \| nv \| nd \| nr \| ng \| ne \| se \| no \| nn \| oc \| oj \| or \| om \| os \| pi \| pa \| fa \| pl \| pt \| ps \| qu \| ro \| rm \| rn \| ru \| sm \| sg \| sa \| sc \| sr \| sn \| ii \| sd \| si \| sk \| sl \| so \| st \| es \| su \| sw \| ss \| sv \| tl \| ty \| tg \| ta \| tt \| te \| th \| bo \| ti \| to \| ts \| tn \| tr \| tk \| tw \| ug \| uk \| ur \| uz \| ve \| vi \| vo \| wa \| cy \| fy \| wo \| xh \| yi \| yo \| za \| zu[]	No	Filter by languages
`model`	query	`generic \| corp \| pmc \| faith \| syndicate \| club[]`	No	Filter by model
`page`	query	`number`	No	Page number
`recruiting`	query	`0 \| 1[]`	No	Filter by recruiting
`roleplay`	query	`0 \| 1[]`	No	Filter by roleplay
`search`	query	`string`	No	Search term
`size`	query	`small \| medium \| large[]`	No	Filter by size
`sort`	query	`size_asc \| size_desc \| name_asc \| name_desc \| created_asc \| created_desc \| active_asc \| active_desc`	No	Sort order

200 — Organization search results retrieved successfully
401 — Invalid API key
404 — Organization not found
429 — Too many requests

GET`/v2/organizations/{sid}`

Get organization information

Retrieves information about a Star Citizen organization by SID

Parameter	In	Type	Required	Description
`sid`	path	`string`	Yes
`refresh`	query		No

200 — Organization information retrieved successfully
401 — Invalid API key
404 — Organization not found
429 — Too many requests

GET`/v2/organizations/{sid}/members`

Search organization members

Search for members of a Star Citizen organization

Parameter	In	Type	Required	Description
`sid`	path	`string`	Yes
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes 1 daily request.
`search`	query	`string`	No	Search term for member handle or display name
`rankIndex`	query	`string`	No	Filter by member rank
`roleIndex`	query	`number`	No	Filter by role index
`isMainOrg`	query	`boolean`	No	Filter by main org membership. When omitted, returns main members and affiliates mixed together. When true, returns only main organization members. When false, returns only affiliate members.
`page`	query	`number`	No	Page number

200 — Organization members retrieved successfully
401 — Invalid API key
404 — Organization not found
429 — Too many requests

Progress Tracker

GET`/v2/progress-tracker/teams`

Get development all teams

Returns development teams and their deliverables

Parameter	In	Type	Required	Description
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes 1 daily request.

200 — Teams retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/progress-tracker/teams/by-slug/{slug}`

Get a development team by slug

Returns a specific development team based on the provided slug

Parameter	In	Type	Required	Description
`slug`	path	`string`	Yes
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes 1 daily request.

200 — Team retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/progress-tracker/deliverables`

Get all deliverables

Returns detailed deliverable information

Parameter	In	Type	Required	Description
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes 1 daily request.

200 — Deliverable info retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/progress-tracker/deliverables/by-slug/{slug}`

Get deliverable info by slug

Returns detailed deliverable information for a specific deliverable slug

Parameter	In	Type	Required	Description
`slug`	path	`string`	Yes
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes 1 daily request.

200 — Deliverable info retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/progress-tracker/deliverables/by-team-slug/{slug}`

Get deliverable info for a team

Returns detailed deliverable information for a specific team slug

Parameter	In	Type	Required	Description
`slug`	path	`string`	Yes
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes 1 daily request.

200 — Deliverable info retrieved successfully
401 — Invalid API key
429 — Too many requests

Roadmap

GET`/v2/roadmap/{board}`

Get roadmap releases

Retrieves roadmap releases for the given board (starcitizen or squadron42)

Parameter	In	Type	Required	Description
`board`	path	`starcitizen \| squadron42`	Yes	Roadmap board identifier
`version`	query	`string`	No	Optional version string to filter releases
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes 1 daily request.

200 — Roadmap releases retrieved successfully
401 — Invalid API key
404 — Unknown board
429 — Too many requests

Ships

GET`/v2/ships`

Get all ships

Returns a list of all ships

Parameter	In	Type	Required	Description
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes the daily requests shown in the Quota badge.

200 — Ships retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/ships/search`

Search ships

Returns the ships matching every given filter, in catalog order

Parameter	In	Type	Required	Description
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes 1 daily request.
`name`	query	`string`	No	Case-insensitive partial match on the ship name
`focus`	query	`string`	No	Case-insensitive partial match on the ship focus
`type`	query	`combat \| transport \| exploration \| industrial \| support \| competition \| ground \| multi[]`	No	Ship classification (comma-separated for several)
`manufacturer`	query	`string[]`	No	Manufacturer code, case-insensitive (comma-separated for several)
`size`	query	`Large \| Medium \| Small \| vehicle[]`	No	Ship size, case-insensitive (comma-separated for several)
`production_status`	query	`flight-ready[]`	No	Production status, case-insensitive (comma-separated for several)
`length_min`	query	`number`	No	Min length in meters
`length_max`	query	`number`	No	Max length in meters
`beam_min`	query	`number`	No	Min beam in meters
`beam_max`	query	`number`	No	Max beam in meters
`height_min`	query	`number`	No	Min height in meters
`height_max`	query	`number`	No	Max height in meters
`mass_min`	query	`number`	No	Min mass in kg (ships without a known mass are excluded)
`mass_max`	query	`number`	No	Max mass in kg (ships without a known mass are excluded)
`crew_min`	query	`number`	No	Min crew, compared against max_crew
`crew_max`	query	`number`	No	Max crew, compared against max_crew
`cargo_min`	query	`number`	No	Min cargo capacity in SCU
`cargo_max`	query	`number`	No	Max cargo capacity in SCU
`price_min`	query	`number`	No	Min price in USD
`price_max`	query	`number`	No	Max price in USD
`scm_speed_min`	query	`number`	No	Min SCM speed in m/s (ships without a known speed are excluded)
`scm_speed_max`	query	`number`	No	Max SCM speed in m/s (ships without a known speed are excluded)

200 — Ships retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/ships/manufacturers`

Get ship manufacturers

Returns the distinct manufacturers present in the cached ship catalog. Manufacturers rarely change, so this route cannot force a scrape and never consumes quota.

200 — Manufacturers retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/ships/by-name/{name}`

Get ship by name

Returns the ship whose name exactly matches the given name (case-insensitive). A refresh only scrapes this ship.

Parameter	In	Type	Required	Description
`name`	path	`string`	Yes
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes the daily requests shown in the Quota badge.

200 — Ship retrieved successfully
401 — Invalid API key
404 — Ship not found
429 — Too many requests

GET`/v2/ships/by-type/{type}`

Get ships by type

Returns the ships matching the given classification

Parameter	In	Type	Required	Description
`type`	path	`combat \| transport \| exploration \| industrial \| support \| competition \| ground \| multi`	Yes
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes the daily requests shown in the Quota badge.

200 — Ships retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/ships/by-manufacturer/{code}`

Get ships by manufacturer

Returns the ships built by the manufacturer with the given code (case-insensitive)

Parameter	In	Type	Required	Description
`code`	path	`string`	Yes
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes the daily requests shown in the Quota badge.

200 — Ships retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/ships/by-chassis/{chassisId}`

Get ships by chassis

Returns every variant built on the given chassis. A refresh only scrapes these ships.

Parameter	In	Type	Required	Description
`chassisId`	path	`integer`	Yes
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes the daily requests shown in the Quota badge.

200 — Ships retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/ships/{id}`

Get ship by ID

Returns the ship matching the given ID. A refresh only scrapes this ship.

Parameter	In	Type	Required	Description
`id`	path	`integer`	Yes
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes the daily requests shown in the Quota badge.

200 — Ship retrieved successfully
401 — Invalid API key
404 — Ship not found
429 — Too many requests

Starmap

GET`/v2/starmap/search`

Search the starmap

Search starmap entities by a query string

Parameter	In	Type	Required	Description
`query`	query	`string`	Yes	Search query string
`refresh`	query		No

200 — Search results retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/systems`

Get star systems

Returns star systems, optionally filtered by name

Parameter	In	Type	Required	Description
`name`	query	`string`	No	Optional system name filter
`refresh`	query		No

200 — Star systems retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/systems/{id}`

Get a star system by ID

Returns the star system identified by ID

Parameter	In	Type	Required	Description
`id`	path	`integer`	Yes	System ID
`refresh`	query		No

200 — Star system retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/systems/by-name/{name}`

Get a star system by name

Returns the star system identified by name

Parameter	In	Type	Required	Description
`name`	path	`string`	Yes	System name
`refresh`	query		No

200 — Star system retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/systems/by-code/{code}`

Get a star system by code

Returns the star system identified by code

Parameter	In	Type	Required	Description
`code`	path	`string`	Yes	System code
`refresh`	query		No

200 — Star system retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/objects/{code}`

Get celestial objects for a star system

Returns all celestial objects in the star system identified by code

Parameter	In	Type	Required	Description
`code`	path	`string`	Yes	Star system code
`refresh`	query		No

200 — Celestial objects retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/objects/{code}/{id}`

Get a celestial object by ID

Returns the celestial object identified by ID within a star system

Parameter	In	Type	Required	Description
`code`	path	`string`	Yes	Star system code
`id`	path	`integer`	Yes	Celestial object ID
`refresh`	query		No

200 — Celestial object retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/objects/{code}/by-name/{name}`

Get a celestial object by name

Returns the celestial object identified by name within a star system

Parameter	In	Type	Required	Description
`code`	path	`string`	Yes	Star system code
`name`	path	`string`	Yes	Celestial object name
`refresh`	query		No

200 — Celestial object retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/objects/{code}/by-code/{objectCode}`

Get a celestial object by code

Returns the celestial object identified by code within a star system

Parameter	In	Type	Required	Description
`code`	path	`string`	Yes	Star system code
`objectCode`	path	`string`	Yes	Celestial object code
`refresh`	query		No

200 — Celestial object retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/affiliations`

Get starmap affiliations

Returns all political/faction affiliations in the starmap

Parameter	In	Type	Required	Description
`refresh`	query		No

200 — Affiliations retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/affiliations/{id}`

Get an affiliation by ID

Returns the affiliation identified by ID

Parameter	In	Type	Required	Description
`id`	path	`integer`	Yes	Affiliation ID
`refresh`	query		No

200 — Affiliation retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/affiliations/by-name/{name}`

Get an affiliation by name

Returns the affiliation identified by name

Parameter	In	Type	Required	Description
`name`	path	`string`	Yes	Affiliation name
`refresh`	query		No

200 — Affiliation retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/affiliations/by-code/{code}`

Get an affiliation by code

Returns the affiliation identified by code

Parameter	In	Type	Required	Description
`code`	path	`string`	Yes	Affiliation code
`refresh`	query		No

200 — Affiliation retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/routes`

Find routes between star systems

Returns routes from one star system to another for a given ship size

Parameter	In	Type	Required	Description
`from`	query	`string`	Yes	Origin star system code
`to`	query	`string`	Yes	Destination star system code
`ship_size`	query	`S \| M \| L`	Yes
`refresh`	query		No

200 — Routes retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/species`

Get starmap species

Returns all known species in the Star Citizen universe

Parameter	In	Type	Required	Description
`refresh`	query		No

200 — Species retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/species/by-name/{name}`

Get starmap species by name

Returns the species in the Star Citizen universe identified by name

Parameter	In	Type	Required	Description
`name`	path	`string`	Yes	Species name
`refresh`	query		No

200 — Species retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/species/by-code/{code}`

Get starmap species by code

Returns the species in the Star Citizen universe identified by code

Parameter	In	Type	Required	Description
`code`	path	`string`	Yes	Species code
`refresh`	query		No

200 — Species retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/species/{id}`

Get starmap species by id

Returns the species in the Star Citizen universe identified by ID

Parameter	In	Type	Required	Description
`id`	path	`integer`	Yes	Species ID
`refresh`	query		No

200 — Species retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/star-systems/{code}`

Get star system details

Returns comprehensive details for the star system identified by code

Parameter	In	Type	Required	Description
`code`	path	`string`	Yes	Star system code
`refresh`	query		No

200 — Star system details retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/tunnels`

Get all starmap tunnels

Returns all jump tunnels in the starmap

Parameter	In	Type	Required	Description
`refresh`	query		No

200 — Tunnels retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/tunnels/{id}`

Get a tunnel by ID

Returns the tunnel identified by ID

Parameter	In	Type	Required	Description
`id`	path	`integer`	Yes	Tunnel ID
`refresh`	query		No

200 — Tunnel retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/tunnels/by-name/{name}`

Get a tunnel by name

Returns the tunnel identified by name

Parameter	In	Type	Required	Description
`name`	path	`string`	Yes	Tunnel name
`refresh`	query		No

200 — Tunnel retrieved successfully
401 — Invalid API key
429 — Too many requests

GET`/v2/starmap/tunnels/by-code/{code}`

Get a tunnel by entry or exit code

Returns the tunnel connected to the entry or exit code

Parameter	In	Type	Required	Description
`code`	path	`string`	Yes	Entry or exit code
`refresh`	query		No

200 — Tunnel retrieved successfully
401 — Invalid API key
429 — Too many requests

Funding Goals

GET`/v2/funding-goals`

Get Star Citizen funding stats

Returns crowdfunding stats, chart time series, and live/PTU/ETF version info for the specified chart interval

Parameter	In	Type	Required	Description
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes 1 daily request.
`chart`	query	`hour \| day \| week \| month`	No	Chart interval for time series data

200 — Stats retrieved successfully
401 — Invalid API key
429 — Too many requests

Telemetry

GET`/v2/telemetry/{version}`

Get community telemetry

Returns Star Citizen telemetry data for a given version and time interval

Parameter	In	Type	Required	Description
`version`	path	`string`	Yes	Star Citizen version string
`refresh`	query	`boolean`	No	Force a fresh scrape. Consumes 1 daily request.
`timetable`	query	`DAY \| WEEK \| MONTH`	Yes	Time interval for telemetry data

200 — Telemetry data retrieved successfully
401 — Invalid API key
429 — Too many requests

Versions

GET`/v2/versions`

Get game versions

Returns Star Citizen game versions.

Parameter	In	Type	Required	Description
`refresh`	query		No

200 — Returns Version data
401 — Invalid API key
429 — Too many requests

API Reference

Me

GET/v2/me

DELETE/v2/me

DELETE/v2/me/unregister

Users

GET/v2/users/{handle}

GET/v2/users/{handle}/profile

GET/v2/users/{handle}/organization

Organizations

GET/v2/organizations/search

GET/v2/organizations/{sid}

GET/v2/organizations/{sid}/members

Progress Tracker

GET/v2/progress-tracker/teams

GET/v2/progress-tracker/teams/by-slug/{slug}

GET/v2/progress-tracker/deliverables

GET/v2/progress-tracker/deliverables/by-slug/{slug}

GET/v2/progress-tracker/deliverables/by-team-slug/{slug}

Roadmap

GET/v2/roadmap/{board}

Ships

GET/v2/ships

GET/v2/ships/search

GET/v2/ships/manufacturers

GET/v2/ships/by-name/{name}

GET/v2/ships/by-type/{type}

GET/v2/ships/by-manufacturer/{code}

GET/v2/ships/by-chassis/{chassisId}

GET/v2/ships/{id}

Starmap

GET/v2/starmap/search

GET/v2/starmap/systems

GET/v2/starmap/systems/{id}

GET/v2/starmap/systems/by-name/{name}

GET/v2/starmap/systems/by-code/{code}

GET/v2/starmap/objects/{code}

GET/v2/starmap/objects/{code}/{id}

GET/v2/starmap/objects/{code}/by-name/{name}

GET/v2/starmap/objects/{code}/by-code/{objectCode}

GET/v2/starmap/affiliations

GET/v2/starmap/affiliations/{id}

GET/v2/starmap/affiliations/by-name/{name}

GET/v2/starmap/affiliations/by-code/{code}

GET/v2/starmap/routes

GET/v2/starmap/species

GET/v2/starmap/species/by-name/{name}

GET/v2/starmap/species/by-code/{code}

GET/v2/starmap/species/{id}

GET/v2/starmap/star-systems/{code}

GET/v2/starmap/tunnels

GET/v2/starmap/tunnels/{id}

GET/v2/starmap/tunnels/by-name/{name}

GET/v2/starmap/tunnels/by-code/{code}