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.
輸入參數plan必填
get_spot_price
Get Spot Price
Return the latest 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. Free and keyless callers get the price 15 minutes late; bid/ask are null when no quote is available. `is_stale` is true when aggregator detected source divergence or stale FX.
輸入參數symbol必填
list_commodities
List Commodities
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.
無需輸入參數。
Return provenance metadata for a symbol: the serving source, unit, methodology URL, staleness rules. Use for attribution and to document data lineage in downstream reports.
輸入參數symbol必填
get_carat
Get Karat-Gram Gold Prices
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 plus EGP, NPR, PKR and VND). Jewelry-grade pricing computed from XAU spot and exchangerate.dev 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).
輸入參數currency
get_historical
Get Historical Prices
Return OHLCV bar history for a symbol at 1m, 5m, 15m, 30m, 1h, 2h, 4h, or 1d (default). Plus includes 1h and 4h bars for the last 30 days; Pro includes 1m to 4h bars. 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; Basic sees the last year; Plus and Pro unlock 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).
輸入參數limitsymbol必填to_date必填intervalfrom_date必填
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.
輸入參數limitquery必填
get_forward_view
Get Forward View
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.
輸入參數asset必填
get_physical_price
Get Physical Dealer Gold Prices
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, MY, AE, JP). Uncovered countries return unknown_country on every plan. Requires Basic or higher; static sample responses for evaluation are in the docs at https://goldprice.dev/docs/physical.
輸入參數country必填