API

Star Citizen Wiki API

The Star Citizen Wiki API serves as an interface between different Star Citizen services and the Star Citizen Wiki itself.

Star Citizen

Endpoints related to Star Citizen

Funding, Fleet and Fan statistics.

All : GET /api/stats
Latest : GET /api/stats/latest

Star Citizen vehicle manufacturers.

All : GET /api/manufacturers
Single : GET /api/manufacturers/NAME
Search : POST /api/manufacturers

Star Citizen ships. Star Citizen vehicles.

Ships

All : GET /api/ships
Single : GET /api/ships/NAME
Search : POST /api/ships/search

Ground Vehicles

All : GET /api/vehicles
Single : GET /api/vehicles/NAME
Search : POST /api/vehicles/search

Starsystems and celestial objects from the RSI Starmap.

Starsystems

All : GET /api/starmap/starsystems
Single : GET /api/starmap/starsystems/CODE

Galactapedia

Galactapedia articles

All : GET /api/galactapedia
Single : GET /api/galactapedia/ID
Search : POST /api/galactapedia/search

Shops

All : GET /api/shops
Single : GET /api/shops/NAME
SHop at Position : GET /api/shops/position/NAME

Items

FPS Weapons

All : GET /api/weapons/personal
Single : GET /api/weapons/personal/NAME

Armor

All : GET /api/char/armor
Single : GET /api/char/armor/NAME

Clothing

All : GET /api/char/clothing
Single : GET /api/char/clothing/NAME

Vehicles

Coolers

All : GET /api/ship-items/coolers
Single : GET /api/ship-items/coolers/NAME

Shields

All : GET /api/ship-items/shields
Single : GET /api/ship-items/shields/NAME

Quantum Drives

All : GET /api/ship-items/quanutm-drives
Single : GET /api/ship-items/quanutm-drives/NAME

Power Plants

All : GET /api/ship-items/power-plants
Single : GET /api/ship-items/power-plants/NAME

Roberts Space Industries

Endpoints related to the RSI Website

Comm-Links

Parsed Comm-Links

All : GET /api/comm-links
Single : GET /api/comm-links/ID

Search

Comm-Link search. Comm-Links by title or reverse search by image.

Search by title : POST /api/comm-links/search
Search by image link : POST /api/comm-links/reverse-image-link-search
Search by image : POST /api/comm-links/reverse-image-search

Global request options

Information about global request options

API Key

An API Key can be obtained by registering on the german Star Citizen Wiki and logging into the API.
The key should be send in the Authorization header, e.g.: Authorization Bearer: KEY.

Pagination

Many responses are paginated. A paginated response contains a pagination-key in the metadata.
Example:

{
  "data": [],
  "meta": {
    "pagination": {
      "total": 2847,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 2847,
      "links": {
        "previous": "PREV_PAGE",
        "next": "NEXT_PAGE"
      }
    }
  }
}

Pagination can be disabled by requesting an endpoint with the limit parameter set to 0.

Relations

Some endpoints contain relations that include additional data.
Available includes are listed under valid_relations in the metadata field.
Example:

{
  "data": [],
  "meta": {
    "valid_relations": [
      "ships",
      "vehicles"
    ]
  }
}

Relations can be included by passing the relation name in the include url parameter.
Example: https://api.star-citizen.wiki/api/manufacturers/RSI?include=ships
Multiple includes are separated by ,.

Child relations in a parent can be included by adding the child relation with a dot.
Example: https://api.star-citizen.wiki/api/starmap/starsystems/SOL?include=celestial_objects.jumppoint
This call would include all celestial objects of the starsystem and the jumppoint associated with a celestial object.

Localization

Some endpoints allow localization of the returned text.
The locale can be set by setting the locale url parameter.
Currently de_DE and en_EN are supported.

This site is open source. Improve this page.

API