Developer Quickstart

Star Citizen Wiki API

Browse ships, items, locations, and more via JSON. Powering starcitizen.tools.

1

Find a resource

Search across ships, items, locations, and other resources when you only have a name. The response includes the resource type and identifier to use next.

Open full request
Request
Response

No results yet.

Search returns a resource type and identifier. Use them to request the full Carrack vehicle record.

2

Open one record

Use the resource show route with the identifier from search. Add include to load related data such as ports and components.

Request
curl "https://api.star-citizen.wiki/api/vehicles/carrack?include=ports,components"
Response

For lists, use index routes with filters from the OpenAPI documentation or /filters endpoint.

3

Browse with filters

Index routes return paginated lists. Use the filters endpoint to discover supported filter fields and values before building a query. The same pattern is available across vehicles, items, locations, missions, and commodities.

Available facets
curl "https://api.star-citizen.wiki/api/vehicles/filters"
Filtered index
curl -G "https://api.star-citizen.wiki/api/vehicles" \
  --data-urlencode "filter[manufacturer]=Anvil Aerospace"

Same shape for every game resource:

/api/vehicles /api/items /api/locations

/api/missions /api/commodities

Comm-links and Galactapedia follow the same pattern with field filters like filter[title] and filter[content].

Pin game data to a patch: ?version= using /api/game-versions/default.

Facet response

Once your requests are working, generate types or clients from the OpenAPI specification.

4

Set up your project

Generate client types

Use the OpenAPI specification with client generators or type generation tools.

npx openapi-typescript https://api.star-citizen.wiki/api/openapi -o sc-api.d.ts

Usage

Please credit api.star-citizen.wiki in public projects.

Commercial use is not permitted under the RSI Fandom FAQ.

Search is rate-limited to 60 requests/min/IP. API health: https://api.star-citizen.wiki/up.

Made by the Community

This is an unofficial Star Citizen fan site, not affiliated with the Cloud Imperium group of companies. All content on this site not authored by its host or users are property of their respective owners. Visit the official Star Citizen website.