> ## 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. # GetGoldIntelligence > GetGoldIntelligence retrieves gold pricing, cross-currency XAU, ratios, and CFTC positioning. ## OpenAPI ````yaml /api/MarketService.openapi.yaml get /api/market/v1/get-gold-intelligence 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-gold-intelligence: get: tags: - MarketService summary: GetGoldIntelligence description: >- GetGoldIntelligence retrieves gold pricing, cross-currency XAU, ratios, and CFTC positioning. operationId: GetGoldIntelligence parameters: - 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: cbReserves: asOfMonth: example topBuyers12m: - deltaTonnes12m: 1.5 iso3: USA name: WorldMonitor Analyst topHolders: - iso3: USA name: WorldMonitor Analyst pctOfReserves: 1.5 tonnes: 1.5 topSellers12m: - deltaTonnes12m: 1.5 iso3: USA name: WorldMonitor Analyst totalTonnes: 1 cot: managedMoney: longPositions: '1717200000000' netPct: 1.5 oiSharePct: 1.5 shortPositions: '1717200000000' wowNetDelta: '1717200000000' nextReleaseDate: '2026-01-15' openInterest: '1717200000000' producerSwap: longPositions: '1717200000000' netPct: 1.5 oiSharePct: 1.5 shortPositions: '1717200000000' wowNetDelta: '1717200000000' reportDate: '2026-01-15' crossCurrencyPrices: - currency: USD flag: example price: 75.25 drivers: - changePct: 1.5 correlation30d: 1.5 label: example symbol: AAPL value: 1.5 etfFlows: asOfDate: '2026-01-15' aumUsd: 1.5 changeM1Pct: 1.5 changeM1Tonnes: 1.5 changeW1Pct: 1.5 schema: $ref: '#/components/schemas/GetGoldIntelligenceResponse' '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). 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' default: description: Gateway or handler error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/GatewayError' components: schemas: GetGoldIntelligenceResponse: type: object properties: goldPrice: type: number format: double goldChangePct: type: number format: double goldSparkline: type: array items: type: number format: double silverPrice: type: number format: double platinumPrice: type: number format: double palladiumPrice: type: number format: double goldSilverRatio: type: number format: double goldPlatinumPremiumPct: type: number format: double crossCurrencyPrices: type: array items: $ref: '#/components/schemas/GoldCrossCurrencyPrice' cot: $ref: '#/components/schemas/GoldCotPositioning' updatedAt: type: string unavailable: type: boolean description: >- True when the upstream or seed-backed variant is unavailable; empty payload fields are graceful degradation, not confirmed zero data. session: $ref: '#/components/schemas/GoldSessionRange' returns: $ref: '#/components/schemas/GoldReturns' range52w: $ref: '#/components/schemas/GoldRange52w' drivers: type: array items: $ref: '#/components/schemas/GoldDriver' etfFlows: $ref: '#/components/schemas/GoldEtfFlows' cbReserves: $ref: '#/components/schemas/GoldCbReserves' 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. 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 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 GoldCrossCurrencyPrice: type: object properties: currency: type: string flag: type: string price: type: number format: double GoldCotPositioning: type: object properties: reportDate: type: string nextReleaseDate: type: string openInterest: type: string format: int64 managedMoney: $ref: '#/components/schemas/GoldCotCategory' producerSwap: $ref: '#/components/schemas/GoldCotCategory' GoldSessionRange: type: object properties: dayHigh: type: number format: double dayLow: type: number format: double prevClose: type: number format: double GoldReturns: type: object properties: w1: type: number format: double m1: type: number format: double ytd: type: number format: double y1: type: number format: double GoldRange52w: type: object properties: hi: type: number format: double lo: type: number format: double positionPct: type: number format: double GoldDriver: type: object properties: symbol: type: string label: type: string value: type: number format: double changePct: type: number format: double correlation30d: type: number format: double GoldEtfFlows: type: object properties: asOfDate: type: string tonnes: type: number format: double aumUsd: type: number format: double nav: type: number format: double changeW1Tonnes: type: number format: double changeM1Tonnes: type: number format: double changeY1Tonnes: type: number format: double changeW1Pct: type: number format: double changeM1Pct: type: number format: double changeY1Pct: type: number format: double sparkline90d: type: array items: type: number format: double GoldCbReserves: type: object properties: asOfMonth: type: string totalTonnes: type: number format: double topHolders: type: array items: $ref: '#/components/schemas/GoldCbHolder' topBuyers12m: type: array items: $ref: '#/components/schemas/GoldCbMover' topSellers12m: type: array items: $ref: '#/components/schemas/GoldCbMover' 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. GoldCotCategory: type: object properties: longPositions: type: string format: int64 shortPositions: type: string format: int64 netPct: type: number format: double oiSharePct: type: number format: double wowNetDelta: type: string format: int64 GoldCbHolder: type: object properties: iso3: type: string name: type: string tonnes: type: number format: double pctOfReserves: type: number format: double GoldCbMover: type: object properties: iso3: type: string name: type: string deltaTonnes12m: type: number format: double 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). ````