--- title: "Game Starmap Locations Overview" method: GET path: "/api/locations" tags: ["In-Game", "Starmap"] --- # Game Starmap Locations Overview `GET /api/locations` Returns paginated versioned starmap locations with optional filters. Each location includes amenities, hierarchy entity tags, parent and star relations, child count, mission count, and resource availability. ## Query parameters - `page` integer - `page[number]` integer - `page[size]` integer - `version` string - `sort` string - `filter[name]` string - `filter[query]` string - `filter[type_name]` string - `filter[type_classification]` string - `filter[respawn_location_type]` string - `filter[jurisdiction_name]` string - `filter[affiliation_name]` string - `filter[is_scannable]` boolean - `filter[block_travel]` boolean - `filter[amenity]` string - `filter[tag]` string - `filter[parent_name]` string - `filter[parent_uuid]` string, uuid - `filter[system]` string - `filter[has_resources]` boolean - `filter[resource]` string - `filter[hide_minor_locations]` boolean ## Response `200` List of starmap locations - GameStarmapLocation[] - `uuid` string, uuid — Unique identifier for this starmap location. - `slug` string, nullable — URL-friendly slug for this location. - `name` string — Display name of the starmap location. - `description` string, nullable — In-universe description of the location. - `size` number, nullable — Relative size of the location. - `respawn_location_type` string, nullable — Type of respawn facility available (e.g. Hospital, MedicalRoom). - `child_count` integer — Number of direct child locations. - `has_resources` boolean, nullable — Whether this location has harvestable resource deposits. - `mission_count` integer — Number of available missions at this location. - `is_scannable` boolean — Whether this location can be detected by ship scanners. - `hide_in_starmap` boolean — Whether this location is hidden from the in-game starmap. - `hide_in_world` boolean — Whether this location is hidden in the game world. - `block_travel` boolean — Whether quantum travel to this location is blocked. - `quantum_travel` GameStarmapLocationQuantumTravel — Quantum travel parameters defining how ships interact with this location during quantum travel. - `ObstructionRadius` number — Radius around the location that obstructs quantum travel. - `ArrivalRadius` number — Radius at which a ship exits quantum travel near this location. - `ArrivalPointDetectionOffset` number — Positional offset for detecting the quantum travel arrival point. - `AdoptionRadius` number — Radius within which child locations are adopted into the quantum travel zone. - `SubPointRadiusMultiplier` number — Multiplier applied to the sub-point radius for quantum travel calculations. - `asteroid_ring` GameStarmapLocationAsteroidRing — Asteroid ring configuration for locations that have an asteroid belt, defining density, size, and dimensional parameters. - `DensityScale` number — Scale factor controlling asteroid density within the ring. - `SizeScale` number — Scale factor controlling individual asteroid size. - `InnerRadius` number — Inner boundary radius of the asteroid ring. - `OuterRadius` number — Outer boundary radius of the asteroid ring. - `Depth` number — Vertical depth or thickness of the asteroid ring. - `system` string, nullable — Name of the star system this location belongs to (e.g. Stanton System). - `parent` GameStarmapLocationLinkedSummary — A lightweight summary of a linked starmap location, used for parent, star, and related location references. - `uuid` string, uuid — Unique identifier of the linked location. - `name` string — Display name of the linked location. - `type_name` string — Type name of the linked location (e.g. Planet, Moon, Outpost). - `slug` string, nullable — URL-friendly slug for the linked location. - `star` GameStarmapLocationLinkedSummary — A lightweight summary of a linked starmap location, used for parent, star, and related location references. - `uuid` string, uuid — Unique identifier of the linked location. - `name` string — Display name of the linked location. - `type_name` string — Type name of the linked location (e.g. Planet, Moon, Outpost). - `slug` string, nullable — URL-friendly slug for the linked location. - `children` GameStarmapLocationChildSummary[], nullable — Direct child locations. Only included when requested via `include=children`. - `uuid` string, uuid — Unique identifier of the child location. - `name` string — Display name of the child location. - `designation` string, nullable — Official designation code for the child location. - `web_url` string, uri — Web frontend URL for the child location. - `type_name` string — Location type name (e.g. Outpost, Asteroid). - `type_classification` string, nullable — Sub-classification of the location type. - `respawn_location_type` string, nullable — Type of respawn facility available, if any. - `amenities` GameStarmapLocationAmenity[] — Amenities available at this child location. - `uuid` string, uuid — Unique identifier of the amenity. - `name` string — Internal name of the amenity. - `display_name` string, nullable — Human-readable display name of the amenity, may differ from internal name. - `amenity_labels` string[] — Simplified list of amenity display names or internal names. - `has_resources` boolean — Whether this child location has harvestable resource deposits. - `type` GameStarmapLocationType — Classification and quantum travel properties of a starmap location type. - `uuid` string, uuid, nullable — UUID of the location type. - `name` string — Type name (e.g. Planet, Moon, Outpost, Asteroid). - `classification` string, nullable — Sub-classification of the location type (e.g. Outpost, LandingZone). - `spawn_nav_points` boolean, nullable — Whether this location type spawns navigation points. - `valid_quantum_travel_destination` boolean, nullable — Whether this location type is a valid quantum travel destination. - `jurisdiction` GameStarmapLocationJurisdiction — Legal jurisdiction governing a starmap location, including fines and prison status. - `uuid` string, uuid, nullable — UUID of the jurisdiction. - `name` string, nullable — Name of the governing jurisdiction (e.g. UEE). - `base_fine` integer, nullable — Base fine amount for crimes committed in this jurisdiction. - `max_stolen_goods_possession_scu` integer, nullable — Maximum stolen goods possession allowed in SCU before penalties apply. - `is_prison` boolean, nullable — Whether this location is a prison facility. - `affiliation` GameStarmapLocationAffiliation — Faction or organization affiliation of a starmap location. - `uuid` string, uuid, nullable — UUID of the affiliated faction or organization. - `name` string, nullable — Display name of the affiliated faction or organization (e.g. UEE, Private Security). - `amenities` GameStarmapLocationAmenity[] — Available amenities at this location. - `uuid` string, uuid — Unique identifier of the amenity. - `name` string — Internal name of the amenity. - `display_name` string, nullable — Human-readable display name of the amenity, may differ from internal name. - `tag` GameStarmapLocationTag — A hierarchy entity tag used for grouping and filtering locations (e.g. orbital markers like HUR_L1). - `uuid` string, uuid — Unique identifier of the hierarchy entity tag. - `name` string — Tag name, typically an orbital or navigational marker code (e.g. HUR_L1, ARC_L2). - `designation` string, nullable — Official designation code for this location. - `radar_contact_type` GameStarmapLocationRadarContactType — Radar contact classification for a starmap location, used for navigation and object-of-interest detection. - `uuid` string, uuid, nullable — UUID of the radar contact type. - `name` string, nullable — Internal name of the radar contact type. - `display_name` string, nullable — Human-readable display name of the radar contact type. - `tag_uuid` string, uuid, nullable — UUID of the associated hierarchy entity tag. - `tag_name` string, nullable — Name of the associated hierarchy entity tag. - `is_object_of_interest` boolean, nullable — Whether this location is marked as an object of interest. - `link` string, uri — API URL for this location's detail endpoint. - `web_url` string, uri — Web frontend URL for this location. - `updated_at` string, date-time, nullable — Timestamp of the last data update. - `version` string, nullable — Game data version code. - `area_boosts` AreaBoost[], nullable — Areas with boosted deposit spawn rates. Only included when requested via `include=resources`. - `name` string, nullable — Name of the boosted area. - `global_modifier` number, nullable — Global probability multiplier for this area (values above 1 indicate a boost). - `resources` StarmapLocationMiningTypeGroup[] — Harvestable resource deposits grouped by extraction method. Only included when requested via `include=resources`. - `group_name` string — Original group name from game data identifying the deposit group. - `mining_type` string — Extraction method label (e.g. Mining, Hand Mining, Salvage). - `mining_type_sort_order` integer — Sort order for mining type display ordering. - `resource_kind` string, nullable — Kind of resource (Mineable or Harvestable). - `group_probability_min` number, nullable — Lowest raw probability among deposits in this group (0–1). - `group_probability_max` number, nullable — Highest raw probability among deposits in this group (0–1). - `group_probability_min_percent` number, nullable — Lowest probability in this group as a percentage (0–100). - `group_probability_max_percent` number, nullable — Highest probability in this group as a percentage (0–100). - `resources` StarmapLocationResource[] — Individual resource deposits within this group. - `key` string — Unique deposit key identifier. - `label` string — Human-readable deposit name derived from the key. - `signature` integer, nullable — Electromagnetic signature strength of the deposit. - `area_exceptions` AreaException[], nullable — Area-specific probability modifiers that override the default for this deposit. - `name` string, nullable — Name of the area where the exception applies. - `modifier` number — Probability multiplier applied within this area (e.g. 2.0 = double chance). - `clustering` Clustering — Defines how deposits are grouped into clusters, including size, proximity, and probability parameters. - `key` string, nullable — Internal clustering configuration key. - `min_size` number, nullable — Minimum number of deposits in a cluster. - `max_size` number, nullable — Maximum number of deposits in a cluster. - `min_proximity` number, nullable — Minimum distance between clustered deposits. - `max_proximity` number, nullable — Maximum distance between clustered deposits. - `probability` number, nullable — Raw probability of clustering occurring (0–1). - `probability_percent` number, nullable — Clustering probability expressed as a percentage (0–100). - `params` ClusteringParam[] — List of clustering variations with individual probability weights. - `min_size` number, nullable — Minimum cluster size. - `max_size` number, nullable — Maximum cluster size. - `min_proximity` number, nullable — Minimum distance between deposit instances in the cluster. - `max_proximity` number, nullable — Maximum distance between deposit instances in the cluster. - `relative_probability` number, nullable — Relative probability weight for this clustering variation. - `harvestable_setup` HarvestableSetup — Respawn and despawn timing configuration for harvestable deposit instances. - `respawn_seconds` integer, nullable — Time in seconds before a harvested instance respawns. - `respawn_formatted` string, nullable — Human-readable respawn duration (e.g. "5m 30s"). - `despawn_seconds` integer, nullable — Time in seconds before an uncollected instance despawns. - `despawn_formatted` string, nullable — Human-readable despawn duration (e.g. "10m"). - `relative_probability` number, nullable — Raw relative spawn probability for this harvestable (0–1). - `relative_probability_percent` number, nullable — Relative spawn probability expressed as a percentage (0–100). - `respawn_multiplier` number, nullable — Multiplier applied to the base respawn time. - `additional_wait_seconds` integer, nullable — Extra wait time in seconds added when nearby players are present. - `additional_wait_formatted` string, nullable — Human-readable additional wait duration (e.g. "2m"). - `provider_names` string[] — List of unique provider names that generate this deposit. - `materials` MaterialEntry[] — List of materials (commodities) found in this deposit with their quality and probability data. - `key` string, nullable — Unique material key identifier. - `name` string, nullable — Display name of the material. - `uuid` string, uuid, nullable — UUID of the commodity this material represents. - `is_current` boolean — Whether this material is the primary commodity being viewed. - `quality_min` integer, nullable — Minimum quality value of this material in the deposit. - `quality_max` integer, nullable — Maximum quality value of this material in the deposit. - `quality_mean` integer, nullable — Average quality value of this material. - `quality_stddev` integer, nullable — Standard deviation of the quality distribution. - `min_percentage` number — Minimum composition percentage of this material (0–100). - `max_percentage` number — Maximum composition percentage of this material (0–100). - `instability` number, nullable — Instability rating of this material, affecting mining difficulty. - `resistance` number, nullable — Resistance rating of this material, affecting mining difficulty. - `group_probability` number — Raw probability of this material occurring in the deposit group (0–1). - `group_probability_percent` number — Group probability expressed as a percentage (0–100). - `relative_probability` number — Raw relative probability compared to other materials in the deposit (0–1). - `relative_probability_percent` number — Relative probability expressed as a percentage (0–100). - `quality_min` integer, nullable — Minimum quality across all instances of this deposit. - `quality_max` integer, nullable — Maximum quality across all instances of this deposit. - `relative_probability_min` number, nullable — Lowest relative probability among deposit instances (0–1). - `relative_probability_max` number, nullable — Highest relative probability among deposit instances (0–1). - `relative_probability_min_percent` number, nullable — Lowest relative probability as a percentage (0–100). - `relative_probability_max_percent` number, nullable — Highest relative probability as a percentage (0–100). - `name` string — Commodity name of the resource deposit. - `uuid` string, uuid, nullable — UUID of the commodity, null for non-commodity deposits. - `tier` string, nullable — Rarity tier of the commodity. - `link` string, uri, nullable — API URL for the commodity detail endpoint. - `web_url` string, uri, nullable — Web frontend URL for the commodity detail page. - `missions` GameStarmapLocationMissionGroup[], nullable — Available missions grouped by purpose. Only included when requested via `include=missions`. - `purpose` string, nullable — Mission purpose category (e.g. Mission, Patrol, Investigation). - `missions` MissionSummary[] — List of mission summaries in this group. - `uuid` string, uuid - `title` string, nullable - `mission_type` string, nullable - `illegal` boolean - `has_combat` boolean, nullable - `faction` object, nullable - `name` string, nullable - `uuid` string, uuid, nullable - `link` string, uri, nullable - `link` string, uri - `web_url` string, uri ## Changes - **2026-04-24** `5922fb7266e2` — 1 info - added the new optional `query` request parameter `filter[query]` - **2026-04-24** `c096aa819d11` — 5 breaking, 2 info - added `#/components/schemas/game_starmap_location_asteroid_ring` to the `items/asteroid_ring` response property `oneOf` list for the response status `200` - added `#/components/schemas/game_starmap_location_quantum_travel` to the `items/quantum_travel` response property `oneOf` list for the response status `200` - the `items/asteroid_ring` response's property type changed from `object` to no type for status `200` - the `items/quantum_travel` response's property type changed from `object` to no type for status `200` - …3 more - **2026-04-23** `e9881fad3038` — 3 info - added the optional property `items/parent/oneOf[subschema #1: Game Starmap Location Linked Summary]/slug` to the response with the `200` status - added the optional property `items/slug` to the response with the `200` status - added the optional property `items/star/oneOf[subschema #1: Game Starmap Location Linked Summary]/slug` to the response with the `200` status - **2026-04-19** `4efeaa4b4785` — 2 info - added the optional property `items/mission_count` to the response with the `200` status - added the optional property `items/missions` to the response with the `200` status - …earlier changes not shown [Full history](https://skmtc.dev/starcitizenwiki/apis/star-citizen-wiki-api/changes/api/locations/get.md) --- [API](https://skmtc.dev/starcitizenwiki/apis/star-citizen-wiki-api.md) · [All operations](https://skmtc.dev/starcitizenwiki/apis/star-citizen-wiki-api/llms.txt) · [OpenAPI document](https://skmtc.dev/starcitizenwiki/apis/star-citizen-wiki-api/revisions/5cd81baa02cb?raw)