goldprice.dev

Open a direct billing URL for an explicitly selected eligible plan: a one-hour Stripe Checkout URL for Free accounts or the existing customer's Stripe billing portal. This always asks the human to confirm the same plan first; a cancellation creates nothing.

{
  "type": "object",
  "properties": {
    "plan": {
      "enum": [
        "physical",
        "pro",
        "realtime"
      ],
      "type": "string"
    }
  },
  "required": [
    "plan"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": {
    "type": "string"
  }
}

Return the latest aggregated spot (or GC futures) price for one symbol. Price is a Decimal-formatted string. Latest USD spot price/bid/ask use nearest half-up rounding: XAU 2 decimal places, XAG 3, HG 4. `is_stale` is true when aggregator detected source divergence or stale FX.

{
  "type": "object",
  "properties": {
    "symbol": {
      "type": "string"
    }
  },
  "required": [
    "symbol"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Return the full list of symbols served by this API. Use before get_spot_price / get_historical / get_metadata when you don't know which symbols are supported.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Return provenance metadata for a symbol: aggregated sources, unit, methodology URL, staleness rules. Use for attribution and to document data lineage in downstream reports.

{
  "type": "object",
  "properties": {
    "symbol": {
      "type": "string"
    }
  },
  "required": [
    "symbol"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Return per-gram gold (XAU) prices by karat purity — 24k, 22k, 21k, 20k, 18k, 16k, 14k, 10k — in a requested currency (default USD; the same 31 currencies get_spot_price serves). Jewelry-grade pricing computed from live XAU spot + ECB FX. FREE on every tier — no plan gate. Values are Decimal-formatted strings, quantized to the currency's ISO 4217 minor unit (JPY → whole numbers, USD → 2dp).

{
  "type": "object",
  "properties": {
    "currency": {
      "default": "USD",
      "type": "string"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Return OHLCV bar history for a symbol at 1m, 5m, 15m, 30m, 1h, 2h, 4h, or 1d (default). Intraday intervals require Pro. History depth is set automatically by your API key's plan — do NOT pass a tier argument (there is none): Free sees the last 30 days; Physical sees the last year; Pro unlocks full history back to 1996 (XAU/USD). Dates must be ISO 8601 (YYYY-MM-DD). Returns bars in date-descending order. volume is null for spot instruments (XAU/USD, XAG/USD, XCU/USD); real for futures (GC, SI, HG) and ETFs (GLD).

{
  "type": "object",
  "properties": {
    "symbol": {
      "type": "string"
    },
    "from_date": {
      "type": "string"
    },
    "to_date": {
      "type": "string"
    },
    "limit": {
      "default": 100,
      "type": "integer"
    },
    "interval": {
      "default": "1d",
      "enum": [
        "1m",
        "5m",
        "15m",
        "30m",
        "1h",
        "2h",
        "4h",
        "1d"
      ],
      "type": "string"
    }
  },
  "required": [
    "symbol",
    "from_date",
    "to_date"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Search the goldprice.dev FAQ corpus via BM25. Returns top-K matching questions + answers with relevance scores. Use before answering how-to / billing / auth questions so you cite the canonical text instead of guessing from training data.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string"
    },
    "limit": {
      "default": 5,
      "type": "integer"
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Returns the multi-horizon futures settlement curve for a commodity (XAU, XAG, HG). Every populated horizon up to one year forward. Useful for bot builders and traders seeing the futures-implied path. See https://goldprice.dev/methodology#forward-view-layers for per-layer math.

{
  "type": "object",
  "properties": {
    "asset": {
      "type": "string"
    }
  },
  "required": [
    "asset"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}

Return the latest per-country physical dealer/retail gold prices — real quotes from dealers, mints, and bullion benchmarks, NOT spot-derived arithmetic — with nullable premium_over_spot_bps per quote (null when live reference inputs are unavailable). `country` is an ISO 3166-1 alpha-2 code (e.g. ID, IN, AE, JP). Requires the Physical tier or higher; static sample responses for evaluation are in the docs at https://goldprice.dev/docs/physical.

{
  "type": "object",
  "properties": {
    "country": {
      "type": "string"
    }
  },
  "required": [
    "country"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "additionalProperties": true
}