> ## Documentation Index > Fetch the complete documentation index at: https://www.worldmonitor.app/docs/llms.txt > Use this file to discover all available pages before exploring further. # GetMineralProduction > GetMineralProduction returns per-commodity mine and refinery country shares and HHI from the annual USGS MCS / BGS seed. ## OpenAPI ````yaml /api/SupplyChainService.openapi.yaml get /api/supply-chain/v1/get-mineral-production openapi: 3.1.0 info: title: SupplyChainService API version: 1.0.0 servers: - url: https://api.worldmonitor.app security: - WorldMonitorKey: [] - ApiKeyHeader: [] paths: /api/supply-chain/v1/get-mineral-production: get: tags: - SupplyChainService summary: GetMineralProduction description: >- GetMineralProduction returns per-commodity mine and refinery country shares and HHI from the annual USGS MCS / BGS seed. operationId: GetMineralProduction parameters: - name: commodity in: query description: >- USGS commodity id or label (e.g. "cobalt"). Empty returns every commodity. required: false example: example schema: type: string - name: iso2 in: query description: >- ISO 3166-1 alpha-2. When set, countries[] is scoped to this producer and the countries portfolio is populated. required: false example: US schema: type: string - name: stage in: query description: '"mine" or "refinery". Empty returns both stages when present.' required: false example: example schema: type: string - name: jmespath in: query description: >- Optional JMESPath expression applied server-side to project or reduce the JSON response before it is returned (mirrors the MCP jmespath argument). Invalid expressions, expressions larger than 1024 UTF-8 bytes, or projections that exceed the 256 KB output cap return HTTP 400 with a {_jmespath_error, original_keys} envelope. Grammar and worked examples: https://www.worldmonitor.app/docs/mcp-jmespath. required: false example: keys(@) schema: type: string responses: '200': description: Successful response content: application/json: example: commodities: - commodity: example commodityId: example-id mine: countries: - country: US estimated: true iso2: US output: 1.5 residual: true hhi: 1.5 unit: example withheldCount: 1 worldTotal: 1 refinery: countries: - country: US estimated: true iso2: US output: 1.5 residual: true hhi: 1.5 unit: example withheldCount: 1 worldTotal: 1 sources: - example countries: - holdings: - commodity: example commodityId: example-id output: 1.5 share: 1.5 stage: example iso2: US dataYear: 1 fetchedAt: '2026-01-15T12:00:00Z' upstreamUnavailable: false schema: $ref: '#/components/schemas/GetMineralProductionResponse' '400': description: Validation error content: application/json: schema: oneOf: - $ref: '#/components/schemas/ValidationError' - $ref: '#/components/schemas/JmespathProjectionError' '401': description: Missing or invalid API key. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: >- API access requires an active subscription (the API key's subscription is inactive or expired). headers: X-Billing-Verification: description: >- Present when the 403 is a billing-provider-confirmed subscription lapse (value subscription_lapsed, matching the body `code`). schema: type: string content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '429': description: Rate limit exceeded. headers: X-RateLimit-Limit: description: Maximum requests allowed in the active rate-limit window. schema: type: string X-RateLimit-Remaining: description: Requests remaining in the active rate-limit window. schema: type: string X-RateLimit-Reset: description: >- Unix epoch milliseconds when the active rate-limit window resets. schema: type: string Retry-After: description: Seconds to wait before retrying the request. schema: type: string content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/RateLimitError' '503': description: >- Service unavailable. Billing-verification responses include code and X-Billing-Verification; other gateway infrastructure failures use the generic GatewayError shape. headers: Retry-After: description: Seconds to wait before retrying (1-60). schema: type: string X-Billing-Verification: description: >- Billing-verification state that produced this response (matches the body `code`). schema: type: string X-Validation-Mode: description: >- Present with value degraded when user API-key validation is temporarily unavailable. schema: type: string X-RateLimit-Mode: description: >- Present with value degraded when a fail-closed rate-limit dependency is unavailable. schema: type: string content: application/json: schema: oneOf: - $ref: '#/components/schemas/BillingVerificationError' - $ref: '#/components/schemas/GatewayError' default: description: Gateway or handler error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/GatewayError' components: schemas: GetMineralProductionResponse: type: object properties: commodities: type: array items: $ref: '#/components/schemas/MineralProductionRecord' countries: type: array items: $ref: '#/components/schemas/MineralCountryPortfolio' fetchedAt: type: string upstreamUnavailable: type: boolean dataYear: type: integer format: int32 ValidationError: type: object properties: violations: type: array items: $ref: '#/components/schemas/FieldViolation' description: List of validation violations required: - violations description: >- ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong. JmespathProjectionError: description: >- Returned when a REST jmespath projection is invalid or exceeds the expression/output byte limits. properties: _jmespath_error: description: Projection error discriminator and details. type: string original_keys: description: Top-level keys or shape of the unprojected response. items: type: string type: array required: - _jmespath_error - original_keys type: object UnauthorizedError: type: object properties: error: type: string description: Human-readable error message. required: - error description: >- Returned when the API key is missing, malformed, or lacks current API access. ForbiddenError: type: object properties: error: type: string description: Human-readable entitlement failure reason. code: type: string enum: - subscription_lapsed description: >- Machine-readable denial code, present when the 403 is a billing-provider-confirmed subscription lapse (mirrored in the X-Billing-Verification response header). requiredTier: type: integer format: int32 description: Minimum entitlement tier required for this endpoint. currentTier: type: integer format: int32 description: Caller entitlement tier when known. planKey: type: string description: Caller plan key when known. required: - error description: >- Returned when a PRO-gated endpoint denies access because the caller has no resolved authenticated user, entitlements cannot be verified, or the caller lacks the required entitlement tier. Error: type: object properties: message: type: string description: Error message (e.g., 'user not found', 'database connection failed') description: >- Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize. RateLimitError: type: object description: Returned when a gateway or handler rate limit rejects the request. properties: error: type: string description: Human-readable rate-limit failure reason. required: - error BillingVerificationError: type: object description: >- Returned with HTTP 503 when paid access cannot be confirmed right now: the billing provider is re-verifying a recently expired subscription, or the entitlement backend is unreachable. Retryable — honor Retry-After. properties: error: type: string description: Human-readable billing-verification failure reason. code: type: string enum: - renewal_verification_pending - renewal_verification_failed - entitlement_verification_unavailable description: >- Machine-readable billing-verification state, mirrored in the X-Billing-Verification response header. requiredTier: type: integer format: int32 description: >- Minimum entitlement tier required for this endpoint, when the denial came from a tier gate. required: - error - code GatewayError: type: object description: >- Returned by gateway infrastructure errors before an RPC handler runs, such as origin, routing, method, authentication, or quota checks. properties: error: oneOf: - type: string - type: object additionalProperties: true description: Gateway error reason or structured gateway failure details. required: - error MineralProductionRecord: type: object properties: commodityId: type: string commodity: type: string year: type: integer format: int32 unit: type: string mine: $ref: '#/components/schemas/MineralStageSnapshot' refinery: $ref: '#/components/schemas/MineralStageSnapshot' sources: type: array items: type: string MineralCountryPortfolio: type: object properties: iso2: type: string holdings: type: array items: $ref: '#/components/schemas/MineralCountryHolding' FieldViolation: type: object properties: field: type: string description: >- The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key') description: type: string description: >- Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing') required: - field - description description: FieldViolation describes a single validation error for a specific field. MineralStageSnapshot: type: object properties: year: type: integer format: int32 unit: type: string countries: type: array items: $ref: '#/components/schemas/MineralCountryShare' hhi: type: number format: double worldTotal: type: number format: double withheldCount: type: integer format: int32 MineralCountryHolding: type: object properties: commodityId: type: string commodity: type: string stage: type: string output: type: number format: double share: type: number format: double withheld: type: boolean MineralCountryShare: type: object properties: iso2: type: string country: type: string output: type: number format: double share: type: number format: double withheld: type: boolean estimated: type: boolean residual: type: boolean securitySchemes: WorldMonitorKey: type: apiKey in: header name: X-WorldMonitor-Key description: User-issued WorldMonitor API key. ApiKeyHeader: type: apiKey in: header name: X-Api-Key description: Alias header for the WorldMonitor API key (X-WorldMonitor-Key). ````