STstarcitizenwiki
Starmap

Game Starmap Location Filters

Changed on

Return all available filter facet values for versioned starmap locations. Applies any provided filter parameters to scope the facet counts. Returns facets for: type_name, type_classification, respawn_location_type, jurisdiction_name, affiliation_name, system, parent_name, amenity, and resource.

get/api/locations/filters

Request

  • Base URL
    https://api.star-citizen.wiki
  • URL
    https://api.star-citizen.wiki/api/locations/filters
  • Auth
    none declared

Query parameters

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.

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 response for valid values).

filter[type_classification]string
Example:Outpost

Location type classification from JSON data (see response for valid values).

filter[respawn_location_type]string
Example:Hospital

Respawn location type classification (see response for valid values).

filter[jurisdiction_name]string
Example:UEE

Governing jurisdiction name (see response for valid values).

filter[affiliation_name]string
Example:Private Security

Faction or organization affiliation display name (see response 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 response 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 response 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

Available filters for starmap locations.

Changes

  • 740b044d147fRevision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

  • af03a6ba771dRevision changes
    • info

      api operation id d17a238ab990d199ac57dd8aeeb2b405 removed and replaced with listLocationFilters

    • info

      api tag In-Game removed