Sign in
Starmap

Game Starmap Locations Overview

Returns paginated versioned starmap locations with optional filters. Results are scoped to the requested or default game version. Each location includes amenities, hierarchy entity tags, parent and star relations, child count, mission count, and resource availability.

get/api/locations

Query parameters

pageinteger

Page number for pagination (starts at 1). Prefer using page[number] instead.

page[number]integer

Page number for pagination (starts at 1).

page[size]integer

Number of results per page. Maximum 200.

versionstring

Game version code to scope results to. Omit to use the current default version. Use GET /api/game-versions to list available versions and GET /api/game-versions/default to discover the default.

sortstring
Example:-size,name

Sort field. Prefix with "-" for descending. Supported: name, type_name, size, child_count.

filter[name]string
Example:Aberdeen

Partial match on location name.

filter[query]string
Example:ArcCorp

Search locations by name.

filter[type_name]string
Example:Planet

Exact match on location type name (see GET /api/locations/filters for valid values).

filter[type_classification]string
Example:Outpost

Location type classification from JSON data (see GET /api/locations/filters for valid values).

filter[respawn_location_type]string
Example:Hospital

Respawn location type classification (see GET /api/locations/filters for valid values).

filter[jurisdiction_name]string
Example:UEE

Governing jurisdiction name (see GET /api/locations/filters for valid values).

filter[affiliation_name]string
Example:Private Security

Faction or organization affiliation display name (see GET /api/locations/filters for valid values).

filter[is_scannable]boolean
Example:true

When true, only show scannable locations; when false, only show non-scannable.

filter[block_travel]boolean

When true, only show locations where travel is blocked; when false, only show locations where travel is allowed.

filter[amenity]string
Example:Commodity Trading

Filter by amenity name, display name, or UUID. Accepts comma-separated values (see GET /api/locations/filters for valid values).

filter[tag]string
Example:HUR_L1

Filter by hierarchy entity tag name or UUID. Accepts comma-separated values.

filter[parent_name]string
Example:ArcCorp

Partial match on parent location name.

filter[parent_uuid]string uuid
Example:f8f07f5b-1c0e-47c9-aa50-46963065bf18

Exact match on parent location UUID.

filter[system]string
Example:Stanton System

Partial match on star system name (see GET /api/locations/filters for valid values).

filter[has_resources]boolean
Example:true

When true, only locations with harvestable resources; when false, only locations without.

filter[resource]string
Example:Agricium

Filter by harvestable commodity name or UUID. Accepts comma-separated values (see GET /api/commodities for valid values).

filter[hide_minor_locations]boolean
Example:true

When true, exclude minor locations that are only shown when their parent is selected.

Response

List of starmap locations

Example response

{
  "data": [
    {
      "resources": [
        {
          "resources": [
            {
              "materials": [
                {
                  "quality_quantized_values": [
                    521,
                    664,
                    710,
                    874,
                    907,
                    970,
                    1000
                  ],
                  "quality_quantization": [
                    348,
                    523,
                    686,
                    717,
                    861,
                    916,
                    975,
                    1000
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 30,
    "to": 30,
    "total": 150,
    "path": "https://api.star-citizen.wiki/api/vehicles"
  }
}

Changes

Changed in 12 of the 50 revisions of this API.81642

  • 1750bd01ea8e3See the full diff
    • ○

      added the optional property data/items/quantum_travel/oneOf[subschema #1: Game Starmap Location Quantum Travel]/adoption_radius_formatted to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/quantum_travel/oneOf[subschema #1: Game Starmap Location Quantum Travel]/arrival_radius_formatted to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/quantum_travel/oneOf[subschema #1: Game Starmap Location Quantum Travel]/obstruction_radius_formatted to the response with the 200 status

      response-optional-property-added

  • af03a6ba771d15See the full diff
    • ▲

      the response's body type/format changed from array/ to object/ for status 200

      response-body-type-changed

    • ○

      api operation id a226a3e5745777c39876fb640a9b3e53 removed and replaced with listLocations

      api-operation-id-removed

    • ○

      api tag In-Game removed

      api-tag-removed

    • ○

      added the optional property data to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property links to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property meta to the response with the 200 status

      response-optional-property-added

  • a8d734bda8e72See the full diff
    • ○

      added the optional property items/resources/items/resources/items/allOf[subschema #1: Deposit Base]/materials/items/quality_quantization to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/resources/items/resources/items/allOf[subschema #1: Deposit Base]/materials/items/quality_quantized_values to the response with the 200 status

      response-optional-property-added

  • 38d31059da971011See the full diff
    • ●

      removed the optional property items/asteroid_ring/oneOf[subschema #1: Game Starmap Location Asteroid Ring]/DensityScale from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/asteroid_ring/oneOf[subschema #1: Game Starmap Location Asteroid Ring]/Depth from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/asteroid_ring/oneOf[subschema #1: Game Starmap Location Asteroid Ring]/InnerRadius from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/asteroid_ring/oneOf[subschema #1: Game Starmap Location Asteroid Ring]/OuterRadius from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/asteroid_ring/oneOf[subschema #1: Game Starmap Location Asteroid Ring]/SizeScale from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/quantum_travel/oneOf[subschema #1: Game Starmap Location Quantum Travel]/AdoptionRadius from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/quantum_travel/oneOf[subschema #1: Game Starmap Location Quantum Travel]/ArrivalPointDetectionOffset from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/quantum_travel/oneOf[subschema #1: Game Starmap Location Quantum Travel]/ArrivalRadius from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/quantum_travel/oneOf[subschema #1: Game Starmap Location Quantum Travel]/ObstructionRadius from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/quantum_travel/oneOf[subschema #1: Game Starmap Location Quantum Travel]/SubPointRadiusMultiplier from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property items/asteroid_ring/oneOf[subschema #1: Game Starmap Location Asteroid Ring]/density_scale to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/asteroid_ring/oneOf[subschema #1: Game Starmap Location Asteroid Ring]/depth to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/asteroid_ring/oneOf[subschema #1: Game Starmap Location Asteroid Ring]/inner_radius to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/asteroid_ring/oneOf[subschema #1: Game Starmap Location Asteroid Ring]/outer_radius to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/asteroid_ring/oneOf[subschema #1: Game Starmap Location Asteroid Ring]/size_scale to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/images to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/quantum_travel/oneOf[subschema #1: Game Starmap Location Quantum Travel]/adoption_radius to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/quantum_travel/oneOf[subschema #1: Game Starmap Location Quantum Travel]/arrival_point_detection_offset to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/quantum_travel/oneOf[subschema #1: Game Starmap Location Quantum Travel]/arrival_radius to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/quantum_travel/oneOf[subschema #1: Game Starmap Location Quantum Travel]/obstruction_radius to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/quantum_travel/oneOf[subschema #1: Game Starmap Location Quantum Travel]/sub_point_radius_multiplier to the response with the 200 status

      response-optional-property-added

  • 5922fb7266e21See the full diff
    • ○

      added the new optional query request parameter filter[query]

      new-optional-request-parameter

  • c096aa819d1152See the full diff
    • ▲

      added game_starmap_location_asteroid_ring to the items/asteroid_ring response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added game_starmap_location_quantum_travel to the items/quantum_travel response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      the items/asteroid_ring response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the items/quantum_travel response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the items/resources/items/resources/items/allOf[subschema #1: Deposit Base]/signature response's property type/format changed from / to integer/ for status 200

      response-property-type-changed

    • ○

      added the optional property items/resources/items/resources/items/allOf[subschema #1: Deposit Base]/harvestable_setup to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/resources/items/resources/items/allOf[subschema #1: Deposit Base]/provider_names to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e9881fad30383See the full diff
    • ○

      added the optional property items/parent/oneOf[subschema #1: Game Starmap Location Linked Summary]/slug to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/slug to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/star/oneOf[subschema #1: Game Starmap Location Linked Summary]/slug to the response with the 200 status

      response-optional-property-added

  • 4efeaa4b47852See the full diff
    • ○

      added the optional property items/mission_count to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/missions to the response with the 200 status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f23b7f0f9b18162See the full diff
    • ▲

      the items/resources/items/resources/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ●

      removed the optional property items/resources/items/resources/items/deposits from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/resources/items/resources/items/link from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/resources/items/resources/items/name from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/resources/items/resources/items/tier from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/resources/items/resources/items/uuid from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/resources/items/resources/items/web_url from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional query request parameter filter[hide_minor_locations]

      new-optional-request-parameter

    • ○

      added deposit_base subschema #2 to the items/resources/items/resources/items/ response property allOf list for the response status 200

      response-property-all-of-added

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f578ff9203b810See the full diff
    • ○

      added the new optional query request parameter filter[has_resources]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[resource]

      new-optional-request-parameter

    • ○

      added the optional property items/area_boosts to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/children/items/amenity_labels to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/children/items/designation to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/children/items/has_resources to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/children/items/web_url to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/designation to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/has_resources to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/resources to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog