Commodities

List Game Commodities

Returns paginated game commodities with location data and resource metadata, optionally filtered to only those consumed by blueprints. Results include refined version info and starmap location data scoped to the requested or default game version.

get/api/commodities

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:-rarity

Sort field. Prefix with "-" for descending. Supported: key, name, rarity, density, instability, resistance, signature.

filter[used]boolean

When true, only commodities used by blueprint ingredients in the requested or default game version are returned. Example: true

filter[system]string

Star system where the commodity can be found (see GET /api/commodities/filters for valid values). Example: Stanton System

filter[type]string

Location type name (see GET /api/commodities/filters for valid values). Example: Planet

filter[rarity]string

Commodity tier/rarity level, lowercase (see GET /api/commodities/filters for valid values). Example: epic

filter[kind]string

Resource kind (see GET /api/commodities/filters for valid values). Example: mineable

filter[group]string

Commodity group name. Comma-separated for multiple. Example: ProcessedGoods,Food

filter[refined_version]string

Refined version name (see GET /api/commodities/filters for valid values). Example: Agricium

filter[location]string

Partial match on starmap location name. Example: ArcCorp

filter[query]string

Search commodities by name or key. Example: Agricium

filter[ship]boolean

When true, only show commodities mineable by ships. Example: true

filter[ground_vehicle]boolean

When true, only show commodities mineable by ground vehicles. Example: true

filter[fps]boolean

When true, only show commodities mineable on foot (FPS). Example: true

filter[harvestable]boolean

When true, only show commodities collectible from harvestable or plant deposits. Example: true

filter[salvage]boolean

When true, only show commodities obtainable through salvage. Example: false

filter[mineable]boolean

When true, only show mineable commodities; when false, only show non-mineable. Example: true

Response

List of commodities

Example response

{
  "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 8 of the 53 revisions of this API.227

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the new optional query request parameter filter[group]

      new-optional-request-parameter

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • af03a6ba771d15See the full diff
    • ▲

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

      response-body-type-changed

    • ○

      api operation id 82d83a0d96ed204c20bb7e37a6b3a359 removed and replaced with listCommodities

      api-operation-id-removed

    • ○

      api tag In-Game removed

      api-tag-removed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the new optional query request parameter filter[fps]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[ground_vehicle]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[harvestable]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[kind]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[location]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[mineable]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[query]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[rarity]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[refined_version]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[salvage]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[ship]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[system]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[type]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sort

      new-optional-request-parameter

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

    • ○

      api operation id 4be9500d6805486b23924917cdd6a1fc removed and replaced with 82d83a0d96ed204c20bb7e37a6b3a359

      api-operation-id-removed

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

    • ○

      endpoint added

      endpoint-added

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

    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

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