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.
Query parameters
Page number for pagination (starts at 1). Prefer using page[number] instead.
Page number for pagination (starts at 1).
Number of results per page. Maximum 200.
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.
Sort field. Prefix with "-" for descending. Supported: key, name, rarity, density, instability, resistance, signature.
When true, only commodities used by blueprint ingredients in the requested or default game version are returned. Example: true
Star system where the commodity can be found (see GET /api/commodities/filters for valid values). Example: Stanton System
Location type name (see GET /api/commodities/filters for valid values). Example: Planet
Commodity tier/rarity level, lowercase (see GET /api/commodities/filters for valid values). Example: epic
Resource kind (see GET /api/commodities/filters for valid values). Example: mineable
Commodity group name. Comma-separated for multiple. Example: ProcessedGoods,Food
Refined version name (see GET /api/commodities/filters for valid values). Example: Agricium
Partial match on starmap location name. Example: ArcCorp
Search commodities by name or key. Example: Agricium
When true, only show commodities mineable by ships. Example: true
When true, only show commodities mineable by ground vehicles. Example: true
When true, only show commodities mineable on foot (FPS). Example: true
When true, only show commodities collectible from harvestable or plant deposits. Example: true
When true, only show commodities obtainable through salvage. Example: false
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 statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
- ○
added the new optional
queryrequest parameterfilter[group]new-optional-request-parameter
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
- ▲
the response's body type changed from
arraytoobjectfor statusresponse-body-type-changed
- ○
api operation id
82d83a0d96ed204c20bb7e37a6b3a359removed and replaced withlistCommoditiesapi-operation-id-removed
- ○
api tag
In-Gameremovedapi-tag-removed
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ▲
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
- ○
- ○
added the new optional
queryrequest parameterfilter[fps]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterfilter[ground_vehicle]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterfilter[harvestable]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterfilter[kind]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterfilter[location]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterfilter[mineable]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterfilter[query]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterfilter[rarity]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterfilter[refined_version]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterfilter[salvage]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterfilter[ship]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterfilter[system]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterfilter[type]new-optional-request-parameter
- ○
added the new optional
queryrequest parametersortnew-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
4be9500d6805486b23924917cdd6a1fcremoved and replaced with82d83a0d96ed204c20bb7e37a6b3a359api-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
- ▲