Sign in
In-Game
Starmap

Game Starmap Locations Overview

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.

get/api/locations

Query parameters

pageinteger

Page number for pagination (starts at 1).

page[number]integer

Page number for pagination (starts at 1).

page[size]integer

Number of results to return per page.

versionstring

Game version to get data from, if omitted uses default version.

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

uuidstring uuid

Unique identifier for this starmap location.

slugstring nullable

URL-friendly slug for this location.

namestring

Display name of the starmap location.

descriptionstring nullable

In-universe description of the location.

sizenumber nullable

Relative size of the location.

respawn_location_typestring nullable

Type of respawn facility available (e.g. Hospital, MedicalRoom).

child_countinteger

Number of direct child locations.

has_resourcesboolean nullable

Whether this location has harvestable resource deposits.

mission_countinteger

Number of available missions at this location.

is_scannableboolean

Whether this location can be detected by ship scanners.

hide_in_starmapboolean

Whether this location is hidden from the in-game starmap.

hide_in_worldboolean

Whether this location is hidden in the game world.

block_travelboolean

Whether quantum travel to this location is blocked.

systemstring nullable

Name of the star system this location belongs to (e.g. Stanton System).

designationstring nullable

Official designation code for this location.

linkstring uri

API URL for this location's detail endpoint.

web_urlstring uri

Web frontend URL for this location.

updated_atstring date-time nullable

Timestamp of the last data update.

versionstring nullable

Game data version code.

Changes