> ## 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. # GetPhysicalDivergenceIndex > GetPhysicalDivergenceIndex classifies current physical premiums against their bounded trailing histories and returns an all-metal stress composite. ## OpenAPI ````yaml /api/MarketService.openapi.yaml get /api/market/v1/get-physical-divergence-index openapi: 3.1.0 info: title: MarketService API version: 1.0.0 servers: - url: https://api.worldmonitor.app security: - WorldMonitorKey: [] - ApiKeyHeader: [] paths: /api/market/v1/get-physical-divergence-index: get: tags: - MarketService summary: GetPhysicalDivergenceIndex description: |- GetPhysicalDivergenceIndex classifies current physical premiums against their bounded trailing histories and returns an all-metal stress composite. operationId: GetPhysicalDivergenceIndex parameters: - name: metals in: query description: Accepted values are "gold" and "silver". Empty returns both metals. required: false style: form explode: true example: - gold schema: type: array items: type: string pattern: ^(?:gold|silver)$ maxItems: 2 uniqueItems: true - 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: composite: index: 1.5 methodologyVersion: example reason: example state: PHYSICAL_DIVERGENCE_STATE_OK weights: - metal: example methodologyVersion: example weight: 1.5 evaluatedAt: 1717200000000 methodologyVersion: example readings: - delta20d: 1.5 delta5d: 1.5 historyKey: example historyPoints: 1 historyWindowEnd: example schema: $ref: '#/components/schemas/GetPhysicalDivergenceIndexResponse' '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: GetPhysicalDivergenceIndexResponse: type: object properties: readings: type: array items: $ref: '#/components/schemas/PhysicalDivergenceReading' composite: $ref: '#/components/schemas/PhysicalStressComposite' evaluatedAt: type: integer format: int64 description: >- Evaluation time as Unix epoch milliseconds, or zero when unavailable.. Warning: Values > 2^53 may lose precision in JavaScript methodologyVersion: type: string description: Methodology identifier for the complete response. description: >- GetPhysicalDivergenceIndexResponse returns metal readings and the composite. 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 PhysicalDivergenceReading: type: object properties: metal: type: string description: 'Supported metal name: gold or silver.' state: type: string enum: - PHYSICAL_DIVERGENCE_STATE_UNSPECIFIED - PHYSICAL_DIVERGENCE_STATE_OK - PHYSICAL_DIVERGENCE_STATE_INSUFFICIENT_HISTORY - PHYSICAL_DIVERGENCE_STATE_STALE_INPUT - PHYSICAL_DIVERGENCE_STATE_MISSING_INPUT description: PhysicalDivergenceState is exhaustive for every divergence consumer. reason: type: string description: Machine-readable explanation for the state. regime: type: string enum: - PHYSICAL_PREMIUM_REGIME_UNSPECIFIED - PHYSICAL_PREMIUM_REGIME_NORMAL - PHYSICAL_PREMIUM_REGIME_ELEVATED - PHYSICAL_PREMIUM_REGIME_STRESSED - PHYSICAL_PREMIUM_REGIME_EXTREME description: >- PhysicalPremiumRegime classifies the normalized premium distribution. index: type: number format: double description: Normalized divergence index from 0 to 100. premiumPct: type: number format: double description: Current physical premium as a percentage. premiumUsdPerOz: type: number format: double description: Current physical premium in USD per troy ounce. percentile: type: number format: double description: Current premium's empirical percentile from 0 to 100. robustZ: type: number format: double description: Median-absolute-deviation robust z-score. delta5d: type: number format: double description: Premium change versus five observations earlier. delta20d: type: number format: double description: Premium change versus twenty observations earlier. trend5d: type: string enum: - PHYSICAL_PREMIUM_TREND_UNSPECIFIED - PHYSICAL_PREMIUM_TREND_WIDENING - PHYSICAL_PREMIUM_TREND_STABLE - PHYSICAL_PREMIUM_TREND_NARROWING description: PhysicalPremiumTrend describes a trailing premium direction. trend20d: type: string enum: - PHYSICAL_PREMIUM_TREND_UNSPECIFIED - PHYSICAL_PREMIUM_TREND_WIDENING - PHYSICAL_PREMIUM_TREND_STABLE - PHYSICAL_PREMIUM_TREND_NARROWING description: PhysicalPremiumTrend describes a trailing premium direction. historyPoints: type: integer format: int32 description: Number of valid observations available to the classifier. historyWindowStart: type: string description: >- Oldest observation date in the evaluated window, or empty when unavailable. historyWindowEnd: type: string description: >- Newest observation date in the evaluated window, or empty when unavailable. physicalAsOf: type: string description: >- Physical benchmark trading date in YYYY-MM-DD form, or empty when unavailable. paperAsOf: type: integer format: int64 description: >- Paper snapshot time as Unix epoch milliseconds, or zero when unavailable.. Warning: Values > 2^53 may lose precision in JavaScript historyKey: type: string description: Redis history key used by the calculation. methodologyVersion: type: string description: Methodology identifier used by this reading. provenance: $ref: '#/components/schemas/PhysicalDivergenceProvenance' description: PhysicalDivergenceReading is one metal's normalized divergence result. PhysicalStressComposite: type: object properties: state: type: string enum: - PHYSICAL_DIVERGENCE_STATE_UNSPECIFIED - PHYSICAL_DIVERGENCE_STATE_OK - PHYSICAL_DIVERGENCE_STATE_INSUFFICIENT_HISTORY - PHYSICAL_DIVERGENCE_STATE_STALE_INPUT - PHYSICAL_DIVERGENCE_STATE_MISSING_INPUT description: PhysicalDivergenceState is exhaustive for every divergence consumer. reason: type: string description: Machine-readable explanation for the aggregate state. index: type: number format: double description: Weighted aggregate index from 0 to 100 when state is OK. weights: type: array items: $ref: '#/components/schemas/PhysicalStressWeight' methodologyVersion: type: string description: Methodology identifier used by the composite. description: PhysicalStressComposite combines the supported metals into one index. 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. PhysicalDivergenceProvenance: type: object properties: physicalSource: type: string description: Human-readable physical benchmark provider. physicalSymbol: type: string description: Physical benchmark contract symbol. physicalAsOf: type: string description: >- Physical benchmark trading date in YYYY-MM-DD form, or empty when unavailable. paperSource: type: string description: Human-readable paper benchmark provider, or empty when unavailable. paperSymbol: type: string description: Paper benchmark contract symbol. paperAsOf: type: integer format: int64 description: >- Paper snapshot time as Unix epoch milliseconds, or zero when unavailable.. Warning: Values > 2^53 may lose precision in JavaScript fxSource: type: string description: Human-readable FX provider, or empty when unavailable. fxPair: type: string description: FX conversion pair. fxAsOf: type: integer format: int64 description: >- FX snapshot time as Unix epoch milliseconds, or zero when unavailable.. Warning: Values > 2^53 may lose precision in JavaScript historyKey: type: string description: Redis history key used by the calculation. historyWindowPoints: type: integer format: int32 description: Maximum number of observations retained in history. methodologyVersion: type: string description: Methodology identifier used by this provenance record. description: >- PhysicalDivergenceProvenance preserves the exact inputs used for one reading. PhysicalStressWeight: type: object properties: metal: type: string description: 'Supported metal name: gold or silver.' weight: type: number format: double description: Composite weight from zero to one. methodologyVersion: type: string description: Methodology identifier used by this weight. description: PhysicalStressWeight records one metal's composite contribution. 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). ````