Sign in
metals
plan-premium

Spot price for a single metal, in the currency, unit of mass and purity you ask for.

The instrument actually quoted is chosen from the metal, currency and unit together, and is reported as source_instrument. Where no instrument is quoted directly in the requested currency, the price is crossed via USD and cross_rate is true - this consumes an additional FX product call and widens the bid/ask gap.

get/metals/spot

Query parameters

metalstring

Three-letter metal symbol, e.g. XAU for gold

Example:XAU

Metal symbol, defaults to XAU

currencystring

Three-letter ISO 4217 currency code

Target currency, defaults to USD

unit'gram' | 'kilogram' | 'metric_tonne' | 'grain' | 'pennyweight' | 'oz_t' | 'lb_t' | 'oz_av' | 'lb_av' | 'tael' | 'baht' | 'tola'

Handle for a unit of mass that metal prices can be quoted in

Unit of mass to price in. Defaults to oz_t for precious metals and metric_tonne for base metals.

puritystring

A purity code from /metals/purities (e.g. '750'), or any custom fineness in parts per thousand between 1 and 1000. A custom value is echoed back with a purity_name of 'custom'.

Example:750

Purity to price at, for precious metals only - ignored for base metals. Either a code from /metals/purities, or any custom fineness between 0 and 1000 exclusive of zero. Omit for the quoted (pure) price.

verbosestring

Truthy values are true, 1, yes and y. Anything else is treated as false.

Example:true

Include the display-name fields in the response

Response

Success

bidstring required

A price, as a string to preserve the significant figures of the source quote. Parse as a decimal rather than a float where precision matters.

askstring

A price, as a string to preserve the significant figures of the source quote. Parse as a decimal rather than a float where precision matters.

midstring

A price, as a string to preserve the significant figures of the source quote. Parse as a decimal rather than a float where precision matters.

spreadstring

A price, as a string to preserve the significant figures of the source quote. Parse as a decimal rather than a float where precision matters.

metalstring required

Three-letter metal symbol, e.g. XAU for gold

metal_namestring

Metal name. Verbose only.

currencystring required

Three-letter ISO 4217 currency code

currency_namestring

Currency name. Verbose only.

unit'gram' | 'kilogram' | 'metric_tonne' | 'grain' | 'pennyweight' | 'oz_t' | 'lb_t' | 'oz_av' | 'lb_av' | 'tael' | 'baht' | 'tola' required

Handle for a unit of mass that metal prices can be quoted in

unit_namestring

Display name for the unit. Verbose only.

tspnumber required

Milliseconds since Jan 1 1970 (unix timestamp with millisecond precision)

dtmstring required

Quote time, formatted per the account's datetime format

cross_rateboolean required

True when the price was crossed via USD rather than quoted directly in the requested currency

sourcestring required

Origin of the price data

source_instrumentstring required

The instrument actually quoted to build this price

gradestring

Deliverable contract grade. Base metals only.

grade_namestring

Display name for the contract grade. Base metals only, verbose only.

grade_min_purity_pctnumber float

Minimum purity of the contract grade, as a percentage. Base metals only, verbose only.

puritystring

Purity code the price is quoted at. Precious metals only.

purity_namestring

Display name for the purity, or 'custom' for a caller-supplied fineness. Precious metals only.

msnumber

Server response time in milliseconds

Example response

{
  "bid": "2500.50",
  "ask": "2500.50",
  "mid": "2500.50",
  "spread": "2500.50",
  "metal": "XAU",
  "tsp": 1739305030072
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.