API 文档
基础 URL:https://metalapi.com/api/v1。所有响应均通过 HTTPS 以 JSON 格式返回。现有 MetalAPI 集成无需修改即可继续使用。
快速开始
创建免费账户,从控制台复制您的 API 密钥,然后请求最新的黄金和白银价格:
curl "https://metalapi.com/api/v1/latest?api_key=YOUR_API_KEY&base=USD¤cies=XAU,XAG,EUR"身份验证
每个请求都需要提供 API 密钥。可通过以下三种方式之一发送(使用请求头方式可避免密钥出现在日志中):
# Header (recommended)
curl -H "Authorization: Bearer YOUR_API_KEY" https://metalapi.com/api/v1/latest
curl -H "X-API-Key: YOUR_API_KEY" https://metalapi.com/api/v1/latest
# Query string
curl "https://metalapi.com/api/v1/latest?api_key=YOUR_API_KEY"密钥格式形如 mk_live_…,仅在创建时显示一次;我们只存储其哈希值。您可以在控制台中创建多个密钥,为其命名、轮换,并将其限制为仅供您网站的域名使用。来自其他域名的浏览器请求将被拒绝并返回错误 107;服务器到服务器的请求始终允许。
响应格式
汇率以双向形式返回。以基础货币 USD 和品种 XAU 为例:
rates.USDXAU— 1 金衡盎司黄金的美元价格(例如 3997.89)。rates.XAU— 1 美元可买到的黄金盎司数(1 / 3997.89 = 0.00025013)。
每个响应都包含 success 字段,以及记录每月配额的 rate_limit 区块。出错时返回 success: false,以及包含 code、type 和 info 的 error 对象。时间戳为 Unix 秒(UTC);日期格式为 YYYY-MM-DD(UTC)。
Latest rates
/api/v1/latestCurrent rates for every requested symbol. The data you receive is as fresh as your plan's update interval allows (daily on Free, down to 5 seconds on Enterprise).
Add XAU-BID / XAU-ASK to currencies for the book (Standard plan and above). Available for precious metals, major currencies and crypto; futures-based symbols (industrial metals, energy) have no bid/ask.
timestamp is the time of the data, not of the request.
| 参数 | 说明 |
|---|---|
api_key必填 | Your API key. Alternatively send Authorization: Bearer <key> or X-API-Key: <key>. |
base | Currency or symbol the rates are expressed in. Default USD. Any supported symbol works, e.g. EUR, TRY, XAU. |
currencies | Comma-separated symbols to return (alias: symbols). Default: all symbols. Unknown codes are ignored. |
unit | Weight unit for metals: troy_oz (default), gram, kilogram, ounce, pound, metric_ton, short_ton. Ignored for currencies, energy and crypto. |
curl "https://metalapi.com/api/v1/latest?api_key=YOUR_API_KEY&base=USD¤cies=XAU,XAG,EUR"{
"success": true,
"timestamp": 1792834892,
"date": "2026-10-24",
"base": "USD",
"rates": {
"XAU": 0.0002501319,
"USDXAU": 3997.89,
"XAG": 0.0185392857,
"USDXAG": 53.94,
"EUR": 0.8925,
"USDEUR": 1.1204
},
"rate_limit": { "limit": 10000, "remaining": 9875, "reset": 1793491200, "used": 125, "plan": "Standard", "reset_date": "2026-11-01T00:00:00.000Z" }
}Historical rates
/api/v1/{YYYY-MM-DD}Closing rates for a past day. Use /yesterday as a shortcut, or /historical?date=YYYY-MM-DD. For weekends and holidays the most recent trading day's close is returned.
History: currencies since 1999-01-04, metals and energy since 2000, crypto since 2014.
| 参数 | 说明 |
|---|---|
api_key必填 | Your API key. Alternatively send Authorization: Bearer <key> or X-API-Key: <key>. |
base | Currency or symbol the rates are expressed in. Default USD. Any supported symbol works, e.g. EUR, TRY, XAU. |
currencies | Comma-separated symbols to return (alias: symbols). Default: all symbols. Unknown codes are ignored. |
unit | Weight unit for metals: troy_oz (default), gram, kilogram, ounce, pound, metric_ton, short_ton. Ignored for currencies, energy and crypto. |
curl "https://metalapi.com/api/v1/2024-01-15?api_key=YOUR_API_KEY¤cies=XAU,XAG"{
"success": true,
"timestamp": 1705276800,
"historical": true,
"date": "2024-01-15",
"base": "USD",
"rates": {
"XAU": 0.0004874244,
"USDXAU": 2051.6,
"XAG": 0.0431741646,
"USDXAG": 23.162
},
"rate_limit": { "...": "..." }
}Convert
/api/v1/convertConvert an amount from one symbol to another, at the latest rate or on a given date.
| 参数 | 说明 |
|---|---|
api_key必填 | Your API key. Alternatively send Authorization: Bearer <key> or X-API-Key: <key>. |
from必填 | Symbol to convert from. |
to必填 | Symbol to convert to. |
amount必填 | Amount to convert (decimal). |
date | Optional YYYY-MM-DD for a historical conversion. |
unit | Weight unit for metals: troy_oz (default), gram, kilogram, ounce, pound, metric_ton, short_ton. Ignored for currencies, energy and crypto. |
curl "https://metalapi.com/api/v1/convert?api_key=YOUR_API_KEY&from=USD&to=XAU&amount=1000&unit=gram"{
"success": true,
"query": { "from": "USD", "to": "XAU", "amount": 1000, "unit": "gram" },
"info": { "timestamp": 1792834892, "rate": 0.0077799, "quote": 0.0077799 },
"date": "2026-10-24",
"result": 7.7799,
"rate_limit": { "...": "..." }
}Timeframe
/api/v1/timeframeDaily closing rates between two dates (inclusive). /timeseries is an alias that returns "timeseries": true. Maximum range: 30 days on Free, 365 days on paid plans.
| 参数 | 说明 |
|---|---|
api_key必填 | Your API key. Alternatively send Authorization: Bearer <key> or X-API-Key: <key>. |
start_date必填 | YYYY-MM-DD |
end_date必填 | YYYY-MM-DD |
base | Currency or symbol the rates are expressed in. Default USD. Any supported symbol works, e.g. EUR, TRY, XAU. |
currencies | Comma-separated symbols to return (alias: symbols). Default: all symbols. Unknown codes are ignored. |
unit | Weight unit for metals: troy_oz (default), gram, kilogram, ounce, pound, metric_ton, short_ton. Ignored for currencies, energy and crypto. |
curl "https://metalapi.com/api/v1/timeframe?api_key=YOUR_API_KEY&start_date=2026-10-19&end_date=2026-10-23¤cies=XAU"{
"success": true,
"timeframe": true,
"start_date": "2026-10-19",
"end_date": "2026-10-23",
"base": "USD",
"rates": {
"2026-10-19": { "XAU": 0.0002403788, "USDXAU": 4160.1 },
"2026-10-20": { "XAU": 0.0002413943, "USDXAU": 4142.6 },
"2026-10-21": { "XAU": 0.0002409639, "USDXAU": 4150 },
"2026-10-22": { "XAU": 0.0002462812, "USDXAU": 4060.4 },
"2026-10-23": { "XAU": 0.0002495072, "USDXAU": 4007.9 }
},
"rate_limit": { "...": "..." }
}Change
/api/v1/changeHow each rate moved between two dates, as absolute and percentage change.
| 参数 | 说明 |
|---|---|
api_key必填 | Your API key. Alternatively send Authorization: Bearer <key> or X-API-Key: <key>. |
start_date必填 | YYYY-MM-DD |
end_date必填 | YYYY-MM-DD |
base | Currency or symbol the rates are expressed in. Default USD. Any supported symbol works, e.g. EUR, TRY, XAU. |
currencies | Comma-separated symbols to return (alias: symbols). Default: all symbols. Unknown codes are ignored. |
curl "https://metalapi.com/api/v1/change?api_key=YOUR_API_KEY&start_date=2026-01-02&end_date=2026-10-23¤cies=XAU"{
"success": true,
"change": true,
"start_date": "2026-01-02",
"end_date": "2026-10-23",
"base": "USD",
"rates": {
"XAU": { "start_rate": 0.0002309682, "end_rate": 0.0002495072, "change": 0.000018539, "change_pct": 8.02665 },
"USDXAU": { "start_rate": 4329.6, "end_rate": 4007.9, "change": -321.7, "change_pct": -7.43025 }
},
"rate_limit": { "...": "..." }
}Open / High / Low / Close
/api/v1/ohlcDaily OHLC for a date (default: today, intraday so far). Both directions are returned: USDXAU in USD per unit and XAU as the inverse.
| 参数 | 说明 |
|---|---|
api_key必填 | Your API key. Alternatively send Authorization: Bearer <key> or X-API-Key: <key>. |
date | YYYY-MM-DD or latest (default). |
base | Currency or symbol the rates are expressed in. Default USD. Any supported symbol works, e.g. EUR, TRY, XAU. |
currencies | Comma-separated symbols to return (alias: symbols). Default: all symbols. Unknown codes are ignored. |
unit | Weight unit for metals: troy_oz (default), gram, kilogram, ounce, pound, metric_ton, short_ton. Ignored for currencies, energy and crypto. |
curl "https://metalapi.com/api/v1/ohlc?api_key=YOUR_API_KEY&date=2026-10-23¤cies=XAU"{
"success": true,
"ohlc": true,
"date": "2026-10-23",
"base": "USD",
"rates": {
"USDXAU": { "open": 4042.2, "high": 4050.2, "low": 3989.1, "close": 4007.9 },
"XAU": { "open": 0.000247390, "high": 0.000250683, "low": 0.000246901, "close": 0.000249507 }
},
"rate_limit": { "...": "..." }
}Gold by karat
/api/v1/caratGold price for jewellery karats (purity = karat / 24). Paid plans.
| 参数 | 说明 |
|---|---|
api_key必填 | Your API key. Alternatively send Authorization: Bearer <key> or X-API-Key: <key>. |
carat | 24 (default), 23, 22, 21, 20, 18, 16, 14, 12, 10, 9, 8 or all. |
base | Currency or symbol the rates are expressed in. Default USD. Any supported symbol works, e.g. EUR, TRY, XAU. |
unit | Weight unit for metals: troy_oz (default), gram, kilogram, ounce, pound, metric_ton, short_ton. Ignored for currencies, energy and crypto. |
date | Optional YYYY-MM-DD. |
curl "https://metalapi.com/api/v1/carat?api_key=YOUR_API_KEY&carat=22&unit=gram&base=EUR"{
"success": true,
"carat": "22",
"date": "2026-10-24",
"base": "EUR",
"timestamp": 1792834892,
"rates": {
"XAU22K": { "price": 105.5297, "unit": "gram", "carat": "22", "purity": 0.916667 }
},
"rate_limit": { "...": "..." }
}Symbols
/api/v1/symbolsFree — does not count towards your quota.Every supported symbol and its name. Add details=1 for category and unit.
| 参数 | 说明 |
|---|---|
api_key必填 | Your API key. Alternatively send Authorization: Bearer <key> or X-API-Key: <key>. |
details | 1 to return an array with code, name, category, unit. |
curl "https://metalapi.com/api/v1/symbols?api_key=YOUR_API_KEY"{
"success": true,
"symbols": {
"XAU": "Gold",
"XAG": "Silver",
"XPT": "Platinum",
"XPD": "Palladium",
"XCU": "Copper",
"USD": "US Dollar",
"EUR": "Euro",
"BTC": "Bitcoin"
},
"rate_limit": { "...": "..." }
}Usage
/api/v1/usageFree — does not count towards your quota.Your requests this month and what is left.
| 参数 | 说明 |
|---|---|
api_key必填 | Your API key. Alternatively send Authorization: Bearer <key> or X-API-Key: <key>. |
curl "https://metalapi.com/api/v1/usage?api_key=YOUR_API_KEY"{
"success": true,
"usage": {
"requests_made": 125,
"requests_quota": 10000,
"requests_remaining": 9875,
"plan": "standard",
"period_start": "2026-10-01T00:00:00.000Z",
"period_end": "2026-11-01T00:00:00.000Z"
},
"result": { "plan": "Standard", "used": 125, "total": 10000, "remaining": 9875 },
"rate_limit": { "...": "..." }
}实时流(SSE)
/api/v1/streamPro 及以上套餐基于 Server-Sent Events 的数据流,按您套餐的更新间隔(5–60 秒)推送 prices 事件,支持与 /latest 相同的 base、currencies 和 unit 参数。每 15 秒发送一次注释心跳。每个连接在建立时计 1 次请求,保持连接期间每分钟再计 1 次请求。
const es = new EventSource(
"https://metalapi.com/api/v1/stream?api_key=YOUR_API_KEY¤cies=XAU,XAG,EUR"
);
es.addEventListener("prices", (e) => {
const { timestamp, rates } = JSON.parse(e.data);
console.log(timestamp, rates.USDXAU);
});
es.addEventListener("error", (e) => console.warn("stream error", e));event: prices
data: {"timestamp":1792834897,"base":"USD","rates":{"XAU":0.0002501,"USDXAU":3998.12,"XAG":0.01853,"USDXAG":53.97}}单位与买卖价
除非传入 unit 参数,金属价格均以金衡盎司计价;可选值为 gram、kilogram、ounce(常衡盎司)、pound、metric_ton 或 short_ton。单位仅适用于金属——对货币、能源(桶、百万英热单位、加仑)和加密货币无效。金属作为 base 时同样适用。
Standard 及以上套餐可在代码后添加 -BID / -ASK 来请求买卖报价,例如 currencies=XAU,XAU-BID,XAU-ASK。响应中除中间价外,还会包含 XAU-BID 和 USDXAU-BID。
配额与速率限制
每个套餐都有每月请求配额(每月 1 日 00:00 UTC 重置)和每分钟请求上限。两者都会在每个响应中返回:
X-RateLimit-Limit: 10000 # monthly quota
X-RateLimit-Remaining: 9875
X-RateLimit-Used: 125
X-RateLimit-Reset: 1793491200 # unix time of the next reset
X-RateLimit-Reset-Date: 2026-11-01T00:00:00.000Z
X-RateLimit-Plan: Standard
X-RateLimit-Minute-Limit: 60
X-RateLimit-Minute-Remaining: 58
Retry-After: 21 # only on 429 responses/symbols和/usage免费。- 因速率限制、套餐限制、域名限制或服务器错误而被拒绝的请求不计费。
- 参数校验错误(2xx 错误代码)会计费,因此在循环重试前请先校验输入。
您的套餐还决定数据的时效性:Free 获取前一交易日收盘价,Lite 为 30 分钟级,Standard 为 10 分钟级,Advanced/Pro 为 60 秒级,Ultra/Business 为 15 秒级,Enterprise 为 5 秒级数据。比较套餐。
错误
{
"success": false,
"error": { "code": 105, "type": "quota_exceeded", "info": "User has reached or exceeded his subscription plan's monthly API request allowance" },
"rate_limit": { "limit": 100, "remaining": 0, "used": 100, "plan": "Free", "...": "..." }
}| 代码 | HTTP | 类型 | 含义 |
|---|---|---|---|
| 101 | 401 | no_api_key | No API key was supplied. |
| 102 | 401 | invalid_api_key | The key does not exist or was revoked. |
| 103 | 403 | account_inactive | The account is suspended. Contact support. |
| 104 | 429 | too_many_requests | Per-minute rate limit exceeded. Retry after the Retry-After seconds. |
| 105 | 429 | quota_exceeded | Monthly quota used up. Resets on the 1st (UTC) or upgrade your plan. |
| 106 | 403 | plan_restriction | Endpoint or parameter not available on your plan. |
| 107 | 403 | origin_not_allowed | Browser request from a domain the key is not restricted to. |
| 201 | 400 | invalid_base | Unknown base. |
| 202 | 400 | invalid_from | Unknown from. |
| 203 | 400 | invalid_to | Missing or unknown to. |
| 204 | 400 | invalid_amount | Missing or non-numeric amount. |
| 205 | 400 | invalid_date | Not a valid YYYY-MM-DD date, or a future date. |
| 206 | 400 | invalid_timeframe | Missing dates or start_date after end_date. |
| 207 | 400 | timeframe_too_long | Range longer than your plan allows. |
| 208 | 400 | invalid_symbols | None of the requested currencies exist. |
| 209 | 400 | invalid_unit | Unknown unit. |
| 210 | 400 | invalid_carat | Unknown carat. |
| 300 | 404 | no_results | No data for this query (e.g. before history starts). |
| 404 | 404 | invalid_function | Unknown endpoint. |
| 500 | 500 | server_error | Unexpected error. The request is not billed; retry later. |
| 503 | 503 | service_unavailable | Price data temporarily unavailable. |
Webhook
价格提醒(控制台 → Alerts)可通过电子邮件或 HTTPS Webhook(Advanced 及以上套餐)通知您。每次投递都是一个带 JSON 正文的 POST 请求,失败时最多重试三次。请使用控制台中显示的 Webhook 密钥验证签名:
import crypto from "node:crypto";
// Express example: use the raw request body.
app.post("/metalapi-webhook", express.raw({ type: "application/json" }), (req, res) => {
const header = req.get("X-MetalAPI-Signature") ?? ""; // "t=1792834892,v1=5f0c…"
const { t, v1 } = Object.fromEntries(header.split(",").map((p) => p.split("=")));
const expected = crypto
.createHmac("sha256", process.env.METALAPI_WEBHOOK_SECRET)
.update(`${t}.${req.body}`)
.digest("hex");
const fresh = Math.abs(Date.now() / 1000 - Number(t)) < 300;
if (!fresh || !crypto.timingSafeEqual(Buffer.from(v1, "hex"), Buffer.from(expected, "hex"))) {
return res.status(400).end();
}
const event = JSON.parse(req.body); // { event: "alert.triggered", alert: {...}, price: 4012.5 }
res.status(200).end();
});小组件
在控制台中创建小组件,并将嵌入代码粘贴到任意页面。小组件会自动更新,且绝不会暴露您的 API 密钥。
<div id="metalapi-widget-w_abc123"></div>
<script src="https://metalapi.com/js/widget.js" data-widget="w_abc123" async></script>数据与交易时间
- 现货贵金属和主要外汇:银行间买卖报价源,约每 5 秒采集一次。
- 工业金属和能源:COMEX、NYMEX 和 ICE 近月期货。
- 其他货币:市场报价,以欧洲中央银行参考汇率作为备用。
- 加密货币:Kraken 和 Binance,全天候(24/7)。
- 多个数据源按中位数合并,并在发布前进行异常报价检查。
- 金属、外汇和期货的交易时间为纽约时间周日 17:00 至周五 17:00。周末期间价格保持在周五收盘价。
- 2026 年 10 月之前的金属每日历史数据基于近月期货结算价。
价格为指示性报价,仅供参考,不构成交易要约。
旧版端点
以下来自上一版本的端点仍然可用,以保持兼容性:
/api/v1/rates/metals、/api/v1/rates/metal/{symbol}— 附带元数据的美元价格。/api/v1/rates/currencies、/api/v1/rates/currency/{code}— 以美元为基准的货币汇率。/api/v1/timeseries—/timeframe的别名;/api/v1/historical?date=— 等同于/{date}。/api/v1/user— 账户概览(免费)。