--- title: "Show Game Commodity" method: GET path: "/api/commodities/{commodity}" tags: ["Commodities"] --- # Show Game Commodity `GET /api/commodities/{commodity}` Returns full details for a single game commodity including detailed location entries with starmap data, resource composition, areas, clustering data, and raw/refined version info. Results are scoped to the requested or default game version. Optionally include related blueprints and items. ## Path parameters - `commodity` string, required — Commodity UUID or slug ## Query parameters - `version` string - `include` string ## Response `200` Commodity details - object - `data` CommodityShow — Game commodity summary used in list responses. - `uuid` string, uuid — Unique commodity identifier. - `key` string — Internal commodity key (e.g. "Quartz"). - `name` string — Display name of the commodity. - `display_name` string — Name with leaf commodity group in parentheses, e.g. "WiDoW (Vice)". - `slug` string — URL-friendly slug for the commodity. - `description` string, nullable — In-game lore description. - `tier` string, nullable — Refinement tier (e.g. "Raw", "Refined"). - `refined_version` object, nullable — The refined counterpart of this raw commodity, if applicable. - `name` string — Name of the refined commodity. - `uuid` string, uuid — UUID of the refined commodity. - `web_url` string, uri — Frontend URL for the refined commodity page. - `link` string, uri — API link to the refined commodity details. - `density_g_per_cc` number, nullable — Density in grams per cubic centimeter. - `instability` number, nullable — Instability rating affecting mining behavior. - `resistance` number, nullable — Resistance rating affecting mining difficulty. - `volatility` number, nullable — Volatility rating for this resource type. - `volatility_health_decay_per_second` number, nullable — Health decay per second associated with this resource type volatility. - `box_sizes_scu` number[] — Standard cargo box sizes in SCU that this commodity fits into. - `validate_default_cargo_box` boolean — Whether the default cargo box validation applies. - `has_default_cargo_containers` boolean — Whether default cargo containers are available for this commodity. - `is_mineable` boolean — Whether this commodity can be obtained through mining or harvesting. - `has_ship_mineables` boolean — Whether ship mining deposits exist for this commodity. - `has_ground_vehicle_mineables` boolean — Whether ground vehicle mining deposits exist for this commodity. - `has_fps_mineables` boolean — Whether FPS mining deposits exist for this commodity. - `has_harvestables` boolean — Whether harvestable deposits exist for this commodity. - `has_salvage` boolean — Whether salvage deposits exist for this commodity. - `signature` integer, nullable — Electromagnetic signature strength, used for scanner detection. - `kind` string, nullable — Resource kind classification (e.g. "Mineable", "Harvestable"). - `commodity_groups` string[], nullable — Ordered commodity groups from root to leaf (e.g. ["ProcessedGoods", "Vice"]). - `methods` string[] — Available extraction methods (e.g. ["Ship", "Ground Vehicle", "FPS"]). - `systems` string[] — Star systems where this commodity can be found. - `locations` object[] — Flat list of all locations with deposit details. - `name` string — Canonical location name. - `display_name` string — Formatted display name combining designation and name. - `system` string, nullable — Star system this location belongs to. - `type` string, nullable — Location type classification (e.g. "Moon", "Planet", "Outpost"). - `parent_name` string, nullable — Name of the parent celestial body or location. - `parent_type` string, nullable — Type of the parent location. - `uuid` string, uuid, nullable — UUID of this starmap location entity. - `link` string, uri, nullable — API link to the full location details. - `entries` CommodityIndexLocationEntry[] — Resource entries grouped by mining method. - `group_name` string — Internal group name identifying the mining method or category (e.g. "SpaceShip_Mineables", "Harvestables"). - `resource_kind` string, nullable — Kind of resource if resolvable from the group (e.g. "Mineable", "Harvestable"). - `quality_min` integer, nullable — Minimum quality value across entries in this group. - `quality_max` integer, nullable — Maximum quality value across entries in this group. - `entry_count` integer — Number of individual resource entries in this group. - `key` string — Internal commodity key (e.g. "Quartz"). - `slug` string — URL-friendly slug for the commodity. - `description` string, nullable — In-game lore description. - `tier` string, nullable — Refinement tier (e.g. "Raw", "Refined"). - `refined_version` object, nullable — The refined counterpart of this raw commodity, if applicable. - `name` string — Name of the refined commodity. - `uuid` string, uuid — UUID of the refined commodity. - `web_url` string, uri — Frontend URL for the refined commodity page. - `link` string, uri — API link to the refined commodity details. - `density_g_per_cc` number, nullable — Density in grams per cubic centimeter. - `instability` number, nullable — Instability rating affecting mining behavior. - `resistance` number, nullable — Resistance rating affecting mining difficulty. - `volatility` number, nullable — Volatility rating for this resource type. - `volatility_health_decay_per_second` number, nullable — Health decay per second associated with this resource type volatility. - `box_sizes_scu` number[] — Standard cargo box sizes in SCU that this commodity fits into. - `validate_default_cargo_box` boolean — Whether the default cargo box validation applies. - `has_default_cargo_containers` boolean — Whether default cargo containers are available for this commodity. - `is_mineable` boolean — Whether this commodity can be obtained through mining or harvesting. - `has_ship_mineables` boolean — Whether ship mining deposits exist for this commodity. - `has_ground_vehicle_mineables` boolean — Whether ground vehicle mining deposits exist for this commodity. - `has_fps_mineables` boolean — Whether FPS mining deposits exist for this commodity. - `has_harvestables` boolean — Whether harvestable deposits exist for this commodity. - `has_salvage` boolean — Whether salvage deposits exist for this commodity. - `signature` integer, nullable — Electromagnetic signature strength, used for scanner detection. - `kind` string, nullable — Resource kind classification (e.g. "Mineable", "Harvestable"). - `commodity_groups` string[], nullable — Ordered commodity groups from root to leaf (e.g. ["ProcessedGoods", "Vice"]). - `methods` string[] — Available extraction methods (e.g. ["Ship", "Ground Vehicle", "FPS"]). - `systems` string[] — Star systems where this commodity can be found. - `locations` CommodityIndexLocation[] — Named locations where this commodity appears. - `name` string — Canonical location name. - `display_name` string — Formatted display name including designation prefix (e.g. "CRU-L1: Green Circle"). - `system` string, nullable — Star system name this location belongs to. - `type` string, nullable — Location type classification (e.g. "Moon", "Planet", "Outpost"). - `parent_name` string, nullable — Name of the parent celestial body or location. - `parent_type` string, nullable — Type of the parent location. - `uuid` string, uuid, nullable — UUID of the starmap location entity. - `link` string, uri, nullable — API link to the full location details. - `entries` CommodityIndexLocationEntry[] — Resource entries grouped by mining method. - `group_name` string — Internal group name identifying the mining method or category (e.g. "SpaceShip_Mineables", "Harvestables"). - `resource_kind` string, nullable — Kind of resource if resolvable from the group (e.g. "Mineable", "Harvestable"). - `quality_min` integer, nullable — Minimum quality value across entries in this group. - `quality_max` integer, nullable — Maximum quality value across entries in this group. - `entry_count` integer — Number of individual resource entries in this group. - `web_url` string, uri — Frontend URL for this commodity's page. - `images` object[] — Images from external sources for this commodity. - `source` string — Image source identifier - `thumbnail_url` string, nullable - `thumbnail_width` integer, nullable - `thumbnail_height` integer, nullable - `original_url` string, nullable - `original_width` integer, nullable - `original_height` integer, nullable - `designation` string, nullable — Location designation code (e.g. "CRU-L1"). - `parent_uuid` string, uuid, nullable — UUID of the parent location entity. - `group_probability` number — Raw probability of this commodity group occurring at this location (0-1). - `group_probability_percent` number — Group probability expressed as a percentage (0-100). - `relative_probability` number — Raw relative probability compared to other commodities at this location (0-1). - `relative_probability_percent` number — Relative probability expressed as a percentage (0-100). - `quality_min` integer, nullable — Minimum quality across all deposit instances at this location. - `quality_max` integer, nullable — Maximum quality across all deposit instances at this location. - `areas` AreaBoost[], nullable — Areas with global modifiers that boost spawn rates at this location. - `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` CommodityDepositGroup[] — Individual deposit groups for this commodity at this location. - `key` string — Internal commodity key (e.g. "Quartz"). - `label` string — Human-readable deposit name derived from the key. - `signature` integer, nullable — Electromagnetic signature strength, used for scanner detection. - `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_quantized_values` integer[], nullable — The discrete set of quantized quality values a player can actually receive, filtered by the material's quality range. Each value corresponds to one reachable quantization band. - `quality_quantization` integer[], nullable — All possible quantized quality values for this material from the source data. Use quality_quantized_values for the filtered set reachable on this specific deposit. - `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). - `resource_uuid` string, uuid, nullable — UUID of the resource (commodity) this deposit yields. - `group_name` string — Internal group name for the mining category (e.g. "SpaceShip_Mineables"). - `resource_kind` string, nullable — Resource extraction kind (e.g. "Mineable", "Harvestable"). - `uuid` string, uuid — Unique commodity identifier. - `name` string — Display name of the commodity. - `display_name` string — Name with leaf commodity group in parentheses, e.g. "WiDoW (Vice)". - `slug` string — URL-friendly slug for the commodity. - `description` string, nullable — In-game lore description. - `tier` string, nullable — Refinement tier (e.g. "Raw", "Refined"). - `refined_version` object, nullable — The refined counterpart of this raw commodity, if applicable. - `name` string — Name of the refined commodity. - `uuid` string, uuid — UUID of the refined commodity. - `web_url` string, uri — Frontend URL for the refined commodity page. - `link` string, uri — API link to the refined commodity details. - `density_g_per_cc` number, nullable — Density in grams per cubic centimeter. - `instability` number, nullable — Instability rating affecting mining behavior. - `resistance` number, nullable — Resistance rating affecting mining difficulty. - `volatility` number, nullable — Volatility rating for this resource type. - `volatility_health_decay_per_second` number, nullable — Health decay per second associated with this resource type volatility. - `box_sizes_scu` number[] — Standard cargo box sizes in SCU that this commodity fits into. - `validate_default_cargo_box` boolean — Whether the default cargo box validation applies. - `has_default_cargo_containers` boolean — Whether default cargo containers are available for this commodity. - `is_mineable` boolean — Whether this commodity can be obtained through mining or harvesting. - `has_ship_mineables` boolean — Whether ship mining deposits exist for this commodity. - `has_ground_vehicle_mineables` boolean — Whether ground vehicle mining deposits exist for this commodity. - `has_fps_mineables` boolean — Whether FPS mining deposits exist for this commodity. - `has_harvestables` boolean — Whether harvestable deposits exist for this commodity. - `has_salvage` boolean — Whether salvage deposits exist for this commodity. - `kind` string, nullable — Resource kind classification (e.g. "Mineable", "Harvestable"). - `commodity_groups` string[], nullable — Ordered commodity groups from root to leaf (e.g. ["ProcessedGoods", "Vice"]). - `methods` string[] — Available extraction methods (e.g. ["Ship", "Ground Vehicle", "FPS"]). - `systems` string[] — Star systems where this commodity can be found. - `locations` CommodityIndexLocation[] — Named locations where this commodity appears. - `name` string — Canonical location name. - `display_name` string — Formatted display name including designation prefix (e.g. "CRU-L1: Green Circle"). - `system` string, nullable — Star system name this location belongs to. - `type` string, nullable — Location type classification (e.g. "Moon", "Planet", "Outpost"). - `parent_name` string, nullable — Name of the parent celestial body or location. - `parent_type` string, nullable — Type of the parent location. - `uuid` string, uuid, nullable — UUID of the starmap location entity. - `link` string, uri, nullable — API link to the full location details. - `entries` CommodityIndexLocationEntry[] — Resource entries grouped by mining method. - `group_name` string — Internal group name identifying the mining method or category (e.g. "SpaceShip_Mineables", "Harvestables"). - `resource_kind` string, nullable — Kind of resource if resolvable from the group (e.g. "Mineable", "Harvestable"). - `quality_min` integer, nullable — Minimum quality value across entries in this group. - `quality_max` integer, nullable — Maximum quality value across entries in this group. - `entry_count` integer — Number of individual resource entries in this group. - `link` string, uri — API link to this commodity's full details. - `web_url` string, uri — Frontend URL for this commodity's page. - `images` object[] — Images from external sources for this commodity. - `source` string — Image source identifier - `thumbnail_url` string, nullable - `thumbnail_width` integer, nullable - `thumbnail_height` integer, nullable - `original_url` string, nullable - `original_width` integer, nullable - `original_height` integer, nullable - `link` string, uri — API link to this commodity's full details. - `web_url` string, uri — Frontend URL for this commodity's page. - `images` object[] — Images from external sources for this commodity. - `source` string — Image source identifier - `thumbnail_url` string, nullable - `thumbnail_width` integer, nullable - `thumbnail_height` integer, nullable - `original_url` string, nullable - `original_width` integer, nullable - `original_height` integer, nullable - `systems_grouped` CommoditySystemGroup[] — Locations organized by star system for hierarchical display. - `uuid` string, uuid — Unique commodity identifier. - `key` string — Internal commodity key (e.g. "Quartz"). - `name` string — Star system name. - `display_name` string — Name with leaf commodity group in parentheses, e.g. "WiDoW (Vice)". - `slug` string — URL-friendly slug for the commodity. - `description` string, nullable — In-game lore description. - `tier` string, nullable — Refinement tier (e.g. "Raw", "Refined"). - `refined_version` object, nullable — The refined counterpart of this raw commodity, if applicable. - `name` string — Name of the refined commodity. - `uuid` string, uuid — UUID of the refined commodity. - `web_url` string, uri — Frontend URL for the refined commodity page. - `link` string, uri — API link to the refined commodity details. - `density_g_per_cc` number, nullable — Density in grams per cubic centimeter. - `instability` number, nullable — Instability rating affecting mining behavior. - `resistance` number, nullable — Resistance rating affecting mining difficulty. - `volatility` number, nullable — Volatility rating for this resource type. - `volatility_health_decay_per_second` number, nullable — Health decay per second associated with this resource type volatility. - `box_sizes_scu` number[] — Standard cargo box sizes in SCU that this commodity fits into. - `validate_default_cargo_box` boolean — Whether the default cargo box validation applies. - `has_default_cargo_containers` boolean — Whether default cargo containers are available for this commodity. - `is_mineable` boolean — Whether this commodity can be obtained through mining or harvesting. - `has_ship_mineables` boolean — Whether ship mining deposits exist for this commodity. - `has_ground_vehicle_mineables` boolean — Whether ground vehicle mining deposits exist for this commodity. - `has_fps_mineables` boolean — Whether FPS mining deposits exist for this commodity. - `has_harvestables` boolean — Whether harvestable deposits exist for this commodity. - `has_salvage` boolean — Whether salvage deposits exist for this commodity. - `signature` integer, nullable — Electromagnetic signature strength, used for scanner detection. - `kind` string, nullable — Resource kind classification (e.g. "Mineable", "Harvestable"). - `commodity_groups` string[], nullable — Ordered commodity groups from root to leaf (e.g. ["ProcessedGoods", "Vice"]). - `methods` string[] — Available extraction methods (e.g. ["Ship", "Ground Vehicle", "FPS"]). - `systems` string[] — Star systems where this commodity can be found. - `locations` object[] — All commodity deposit locations within this system. - `name` string — Canonical location name. - `display_name` string — Formatted display name combining designation and name. - `system` string, nullable — Star system this location belongs to. - `type` string, nullable — Location type classification (e.g. "Moon", "Planet", "Outpost"). - `parent_name` string, nullable — Name of the parent celestial body or location. - `parent_type` string, nullable — Type of the parent location. - `uuid` string, uuid, nullable — UUID of this starmap location entity. - `link` string, uri, nullable — API link to the full location details. - `entries` CommodityIndexLocationEntry[] — Resource entries grouped by mining method. - `group_name` string — Internal group name identifying the mining method or category (e.g. "SpaceShip_Mineables", "Harvestables"). - `resource_kind` string, nullable — Kind of resource if resolvable from the group (e.g. "Mineable", "Harvestable"). - `quality_min` integer, nullable — Minimum quality value across entries in this group. - `quality_max` integer, nullable — Maximum quality value across entries in this group. - `entry_count` integer — Number of individual resource entries in this group. - `key` string — Internal commodity key (e.g. "Quartz"). - `slug` string — URL-friendly slug for the commodity. - `description` string, nullable — In-game lore description. - `tier` string, nullable — Refinement tier (e.g. "Raw", "Refined"). - `refined_version` object, nullable — The refined counterpart of this raw commodity, if applicable. - `name` string — Name of the refined commodity. - `uuid` string, uuid — UUID of the refined commodity. - `web_url` string, uri — Frontend URL for the refined commodity page. - `link` string, uri — API link to the refined commodity details. - `density_g_per_cc` number, nullable — Density in grams per cubic centimeter. - `instability` number, nullable — Instability rating affecting mining behavior. - `resistance` number, nullable — Resistance rating affecting mining difficulty. - `volatility` number, nullable — Volatility rating for this resource type. - `volatility_health_decay_per_second` number, nullable — Health decay per second associated with this resource type volatility. - `box_sizes_scu` number[] — Standard cargo box sizes in SCU that this commodity fits into. - `validate_default_cargo_box` boolean — Whether the default cargo box validation applies. - `has_default_cargo_containers` boolean — Whether default cargo containers are available for this commodity. - `is_mineable` boolean — Whether this commodity can be obtained through mining or harvesting. - `has_ship_mineables` boolean — Whether ship mining deposits exist for this commodity. - `has_ground_vehicle_mineables` boolean — Whether ground vehicle mining deposits exist for this commodity. - `has_fps_mineables` boolean — Whether FPS mining deposits exist for this commodity. - `has_harvestables` boolean — Whether harvestable deposits exist for this commodity. - `has_salvage` boolean — Whether salvage deposits exist for this commodity. - `signature` integer, nullable — Electromagnetic signature strength, used for scanner detection. - `kind` string, nullable — Resource kind classification (e.g. "Mineable", "Harvestable"). - `commodity_groups` string[], nullable — Ordered commodity groups from root to leaf (e.g. ["ProcessedGoods", "Vice"]). - `methods` string[] — Available extraction methods (e.g. ["Ship", "Ground Vehicle", "FPS"]). - `systems` string[] — Star systems where this commodity can be found. - `locations` CommodityIndexLocation[] — Named locations where this commodity appears. - `name` string — Canonical location name. - `display_name` string — Formatted display name including designation prefix (e.g. "CRU-L1: Green Circle"). - `system` string, nullable — Star system name this location belongs to. - `type` string, nullable — Location type classification (e.g. "Moon", "Planet", "Outpost"). - `parent_name` string, nullable — Name of the parent celestial body or location. - `parent_type` string, nullable — Type of the parent location. - `uuid` string, uuid, nullable — UUID of the starmap location entity. - `link` string, uri, nullable — API link to the full location details. - `entries` CommodityIndexLocationEntry[] — Resource entries grouped by mining method. - `group_name` string — Internal group name identifying the mining method or category (e.g. "SpaceShip_Mineables", "Harvestables"). - `resource_kind` string, nullable — Kind of resource if resolvable from the group (e.g. "Mineable", "Harvestable"). - `quality_min` integer, nullable — Minimum quality value across entries in this group. - `quality_max` integer, nullable — Maximum quality value across entries in this group. - `entry_count` integer — Number of individual resource entries in this group. - `web_url` string, uri — Frontend URL for this commodity's page. - `images` object[] — Images from external sources for this commodity. - `source` string — Image source identifier - `thumbnail_url` string, nullable - `thumbnail_width` integer, nullable - `thumbnail_height` integer, nullable - `original_url` string, nullable - `original_width` integer, nullable - `original_height` integer, nullable - `designation` string, nullable — Location designation code (e.g. "CRU-L1"). - `parent_uuid` string, uuid, nullable — UUID of the parent location entity. - `group_probability` number — Raw probability of this commodity group occurring at this location (0-1). - `group_probability_percent` number — Group probability expressed as a percentage (0-100). - `relative_probability` number — Raw relative probability compared to other commodities at this location (0-1). - `relative_probability_percent` number — Relative probability expressed as a percentage (0-100). - `quality_min` integer, nullable — Minimum quality across all deposit instances at this location. - `quality_max` integer, nullable — Maximum quality across all deposit instances at this location. - `areas` AreaBoost[], nullable — Areas with global modifiers that boost spawn rates at this location. - `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` CommodityDepositGroup[] — Individual deposit groups for this commodity at this location. - `key` string — Internal commodity key (e.g. "Quartz"). - `label` string — Human-readable deposit name derived from the key. - `signature` integer, nullable — Electromagnetic signature strength, used for scanner detection. - `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. - … - `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_quantized_values` integer[], nullable — The discrete set of quantized quality values a player can actually receive, filtered by the material's quality range. Each value corresponds to one reachable quantization band. - `quality_quantization` integer[], nullable — All possible quantized quality values for this material from the source data. Use quality_quantized_values for the filtered set reachable on this specific deposit. - `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). - `resource_uuid` string, uuid, nullable — UUID of the resource (commodity) this deposit yields. - `group_name` string — Internal group name for the mining category (e.g. "SpaceShip_Mineables"). - `resource_kind` string, nullable — Resource extraction kind (e.g. "Mineable", "Harvestable"). - `uuid` string, uuid — Unique commodity identifier. - `name` string — Display name of the commodity. - `display_name` string — Name with leaf commodity group in parentheses, e.g. "WiDoW (Vice)". - `slug` string — URL-friendly slug for the commodity. - `description` string, nullable — In-game lore description. - `tier` string, nullable — Refinement tier (e.g. "Raw", "Refined"). - `refined_version` object, nullable — The refined counterpart of this raw commodity, if applicable. - `name` string — Name of the refined commodity. - `uuid` string, uuid — UUID of the refined commodity. - `web_url` string, uri — Frontend URL for the refined commodity page. - `link` string, uri — API link to the refined commodity details. - `density_g_per_cc` number, nullable — Density in grams per cubic centimeter. - `instability` number, nullable — Instability rating affecting mining behavior. - `resistance` number, nullable — Resistance rating affecting mining difficulty. - `volatility` number, nullable — Volatility rating for this resource type. - `volatility_health_decay_per_second` number, nullable — Health decay per second associated with this resource type volatility. - `box_sizes_scu` number[] — Standard cargo box sizes in SCU that this commodity fits into. - `validate_default_cargo_box` boolean — Whether the default cargo box validation applies. - `has_default_cargo_containers` boolean — Whether default cargo containers are available for this commodity. - `is_mineable` boolean — Whether this commodity can be obtained through mining or harvesting. - `has_ship_mineables` boolean — Whether ship mining deposits exist for this commodity. - `has_ground_vehicle_mineables` boolean — Whether ground vehicle mining deposits exist for this commodity. - `has_fps_mineables` boolean — Whether FPS mining deposits exist for this commodity. - `has_harvestables` boolean — Whether harvestable deposits exist for this commodity. - `has_salvage` boolean — Whether salvage deposits exist for this commodity. - `kind` string, nullable — Resource kind classification (e.g. "Mineable", "Harvestable"). - `commodity_groups` string[], nullable — Ordered commodity groups from root to leaf (e.g. ["ProcessedGoods", "Vice"]). - `methods` string[] — Available extraction methods (e.g. ["Ship", "Ground Vehicle", "FPS"]). - `systems` string[] — Star systems where this commodity can be found. - `locations` CommodityIndexLocation[] — Named locations where this commodity appears. - `name` string — Canonical location name. - `display_name` string — Formatted display name including designation prefix (e.g. "CRU-L1: Green Circle"). - `system` string, nullable — Star system name this location belongs to. - `type` string, nullable — Location type classification (e.g. "Moon", "Planet", "Outpost"). - `parent_name` string, nullable — Name of the parent celestial body or location. - `parent_type` string, nullable — Type of the parent location. - `uuid` string, uuid, nullable — UUID of the starmap location entity. - `link` string, uri, nullable — API link to the full location details. - `entries` CommodityIndexLocationEntry[] — Resource entries grouped by mining method. - … - `link` string, uri — API link to this commodity's full details. - `web_url` string, uri — Frontend URL for this commodity's page. - `images` object[] — Images from external sources for this commodity. - `source` string — Image source identifier - `thumbnail_url` string, nullable - `thumbnail_width` integer, nullable - `thumbnail_height` integer, nullable - `original_url` string, nullable - `original_width` integer, nullable - `original_height` integer, nullable - `link` string, uri — API link to this commodity's full details. - `web_url` string, uri — Frontend URL for this commodity's page. - `images` object[] — Images from external sources for this commodity. - `source` string — Image source identifier - `thumbnail_url` string, nullable - `thumbnail_width` integer, nullable - `thumbnail_height` integer, nullable - `original_url` string, nullable - `original_width` integer, nullable - `original_height` integer, nullable - `raw_versions` CommodityVersionEntry[], nullable — Raw (unrefined) versions of this commodity, if this is a refined commodity. - `uuid` string, uuid — UUID of the versioned commodity. - `key` string — Internal commodity key (e.g. "Quartz"). - `name` string — Display name of the versioned commodity. - `display_name` string — Name with leaf commodity group in parentheses, e.g. "WiDoW (Vice)". - `slug` string — URL-friendly slug for the commodity. - `description` string, nullable — In-game lore description. - `tier` string, nullable — Refinement tier (e.g. "Raw", "Refined"). - `refined_version` object, nullable — The refined counterpart of this raw commodity, if applicable. - `name` string — Name of the refined commodity. - `uuid` string, uuid — UUID of the refined commodity. - `web_url` string, uri — Frontend URL for the refined commodity page. - `link` string, uri — API link to the refined commodity details. - `density_g_per_cc` number, nullable — Density in grams per cubic centimeter. - `instability` number, nullable — Instability rating affecting mining behavior. - `resistance` number, nullable — Resistance rating affecting mining difficulty. - `volatility` number, nullable — Volatility rating for this resource type. - `volatility_health_decay_per_second` number, nullable — Health decay per second associated with this resource type volatility. - `box_sizes_scu` number[] — Standard cargo box sizes in SCU that this commodity fits into. - `validate_default_cargo_box` boolean — Whether the default cargo box validation applies. - `has_default_cargo_containers` boolean — Whether default cargo containers are available for this commodity. - `is_mineable` boolean — Whether this commodity can be obtained through mining or harvesting. - `has_ship_mineables` boolean — Whether ship mining deposits exist for this commodity. - `has_ground_vehicle_mineables` boolean — Whether ground vehicle mining deposits exist for this commodity. - `has_fps_mineables` boolean — Whether FPS mining deposits exist for this commodity. - `has_harvestables` boolean — Whether harvestable deposits exist for this commodity. - `has_salvage` boolean — Whether salvage deposits exist for this commodity. - `signature` integer, nullable — Electromagnetic signature strength, used for scanner detection. - `kind` string, nullable — Resource kind classification (e.g. "Mineable", "Harvestable"). - `commodity_groups` string[], nullable — Ordered commodity groups from root to leaf (e.g. ["ProcessedGoods", "Vice"]). - `methods` string[] — Available extraction methods (e.g. ["Ship", "Ground Vehicle", "FPS"]). - `systems` string[] — Star systems where this commodity can be found. - `locations` CommodityIndexLocation[] — Named locations where this commodity appears. - `name` string — Canonical location name. - `display_name` string — Formatted display name including designation prefix (e.g. "CRU-L1: Green Circle"). - `system` string, nullable — Star system name this location belongs to. - `type` string, nullable — Location type classification (e.g. "Moon", "Planet", "Outpost"). - `parent_name` string, nullable — Name of the parent celestial body or location. - `parent_type` string, nullable — Type of the parent location. - `uuid` string, uuid, nullable — UUID of the starmap location entity. - `link` string, uri, nullable — API link to the full location details. - `entries` CommodityIndexLocationEntry[] — Resource entries grouped by mining method. - `group_name` string — Internal group name identifying the mining method or category (e.g. "SpaceShip_Mineables", "Harvestables"). - `resource_kind` string, nullable — Kind of resource if resolvable from the group (e.g. "Mineable", "Harvestable"). - `quality_min` integer, nullable — Minimum quality value across entries in this group. - `quality_max` integer, nullable — Maximum quality value across entries in this group. - `entry_count` integer — Number of individual resource entries in this group. - `link` string, uri — API link to the versioned commodity details. - `web_url` string, uri — Frontend URL for the versioned commodity page. - `images` object[] — Images from external sources for this commodity. - `source` string — Image source identifier - `thumbnail_url` string, nullable - `thumbnail_width` integer, nullable - `thumbnail_height` integer, nullable - `original_url` string, nullable - `original_width` integer, nullable - `original_height` integer, nullable - `blueprints` object[], nullable — Crafting blueprints that use or produce this commodity. - `key` string — Unique blueprint key identifier. - `output_name` string — Name of the item produced by this blueprint. - `output_item_uuid` string, uuid, nullable — UUID of the output item entity. - `craft_time_label` string — Human-readable crafting duration (e.g. "5m 30s"). - `web_url` string, uri — Frontend URL for the blueprint page. - `link` string, uri — API link to the blueprint details. - `items` object[], nullable — Physical items associated with this commodity in the game. - `name` string — Item display name. - `uuid` string, uuid, nullable — UUID of the item entity. - `type` string, nullable — Item type classification. - `type_label` string, nullable — Human-readable label for the item type. - `sub_type` string, nullable — Item sub-type classification. - `sub_type_label` string, nullable — Human-readable label for the item sub-type. - `size` integer, nullable — Item size grade. - `web_url` string, uri, nullable — Frontend URL for the item page. - `link` string, uri, nullable — API link to the item details. - `uex_prices` object, nullable — Commodity prices from UEX Corp API. - `purchase` UexPrice[] — Purchase prices from UEX Corp. - `price_buy` number, nullable - `price_sell` number, nullable - `price_rent` number, nullable - `terminal_id` integer, nullable - `terminal_code` string, nullable - `terminal_name` string, nullable - `starmap_location` StarmapLocationLink — Lightweight reference to a starmap location with navigation links. - `uuid` string, uuid, nullable - `name` string, nullable - `slug` string, nullable - `type_name` string, nullable - `parent_name` string, nullable - `star_system_name` string, nullable - `link` string, nullable — API URL for the starmap location - `web_url` string, nullable — Web URL for the starmap location - `date_updated` string, nullable - `game_version` string, nullable - `uex_link` string, nullable — Link to the UEX terminal page for this item/vehicle price ## Other responses - `404` — Commodity not found. --- [API](https://skmtc.net/starcitizenwiki/apis/star-citizen-wiki-api.md) · [All operations](https://skmtc.net/starcitizenwiki/apis/star-citizen-wiki-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/starcitizenwiki/star-citizen-wiki-api/versions/8b259bb9a44c/schema)