Skip to main content
GET
cURL

Authorizations

api_key
string
query
required

Query Parameters

metal
string

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

Pattern: X[A-Z]{2}
Example:

"XAU"

currency
string

Target currency, defaults to USD Three-letter ISO 4217 currency code

Pattern: [A-Z]{3}
unit
enum<string>

Unit of mass to price in. Defaults to oz_t for precious metals and metric_tonne for base metals. Handle for a unit of mass that metal prices can be quoted in

Available options:
gram,
kilogram,
metric_tonne,
grain,
pennyweight,
oz_t,
lb_t,
oz_av,
lb_av,
tael,
baht,
tola
purity
string

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. 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"

verbose
string

Include the display-name fields in the response Truthy values are true, 1, yes and y. Anything else is treated as false.

Example:

"true"

Response

Success

A spot price converted to the requested currency, unit and purity. The *_name fields appear only when verbose is set. grade fields appear for base metals, purity fields for precious metals.

bid
string
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.

Example:

"2500.50"

metal
string
required

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

Pattern: X[A-Z]{2}
Example:

"XAU"

currency
string
required

Three-letter ISO 4217 currency code

Pattern: [A-Z]{3}
unit
enum<string>
required

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

Available options:
gram,
kilogram,
metric_tonne,
grain,
pennyweight,
oz_t,
lb_t,
oz_av,
lb_av,
tael,
baht,
tola
tsp
number<int64>
required

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

Example:

1739305030072

dtm
string
required

Quote time, formatted per the account's datetime format

cross_rate
boolean
required

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

source
string
required

Origin of the price data

source_instrument
string
required

The instrument actually quoted to build this price

ask
string

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.

Example:

"2500.50"

mid
string

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.

Example:

"2500.50"

spread
string

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.

Example:

"2500.50"

metal_name
string

Metal name. Verbose only.

currency_name
string

Currency name. Verbose only.

unit_name
string

Display name for the unit. Verbose only.

grade
string

Deliverable contract grade. Base metals only.

grade_name
string

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

grade_min_purity_pct
number<float>

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

purity
string

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

purity_name
string

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

ms
number<int32>

Server response time in milliseconds