开发者
集成实时和历史价格所需的一切:交互式参考、Python 和 JavaScript SDK、OpenAPI 规范以及 Postman 集合。
快速开始
Python
# one file, standard library only (Python 3.9+)
curl -O https://app.marketapi.app/sdk/marketapi.py
pip install websockets # only if you use the live stream
from marketapi import MarketAPI
api = MarketAPI("YOUR_API_KEY")
print(api.latest(["EURUSD", "XAUUSD"]))JavaScript
// one ES module, no dependencies (Node 18+ and browsers)
curl -O https://app.marketapi.app/sdk/marketapi.mjs
npm install ws # only for the live stream in Node.js
import { MarketAPI } from "./marketapi.mjs";
const api = new MarketAPI({ apiKey: process.env.API_KEY });
console.log(await api.latest(["EURUSD"]));客户端是保存在您项目中的单个文件,因此无需从包仓库安装任何东西,也无需信任第三方代码。将文件放在脚本旁边,或导入路径中的任意文件夹。
marketapi.py marketapi.mjs OpenAPI 3.1 规范 · Postman 集合 · 指南 · 更新日志 · 预言机(智能合约)
在开发智能合约?
链上价格预言机以签名报告的形式向您的合约提供相同的价格,合约可在链上验证:GET https://api.marketapi.app/v1/oracle/report?symbols=XAUUSD&chain_id=10,然后 submit(report, signature) 和 getPriceNoOlderThan(feedId, maxAge)。Solidity 和 ethers v6 示例、合约地址和价格源 ID 见预言机文档。
交互式参考
General
GET /v1/status Service status
无需 API 密钥 · 计费:free
GET /v1/openapi.json This API description (OpenAPI 3.1)
无需 API 密钥 · 计费:free
GET /v1/postman.json Postman collection
无需 API 密钥 · 计费:free
GET /v1/account Your balance, plan and limits
任意有效 API 密钥 · 计费:free
GET /v1/cost-preview Credits a request would cost
任意有效 API 密钥 · 计费:free
Symbols
GET /v1/symbols Search the symbol list
权限范围 read:symbols · 计费:free
GET /v1/symbols/{canonical} One symbol's specification
权限范围 read:metadata · 计费:free
GET /v1/symbols/{canonical}/properties/history Specification change history
权限范围 read:metadata · 计费:free
Prices
GET /v1/market-status Market status per symbol
权限范围 read:latest · 计费:free
GET /v1/prices/latest Latest bid/ask
权限范围 read:latest · 计费:1 credit per symbol returned
History
GET /v1/bars Historical OHLC candles
权限范围 read:ohlcv · 计费:credits per block of rows
GET /v1/ticks Historical ticks
权限范围 read:history · 计费:credits per block of rows
Analytics
GET /v1/patterns/stats Pattern strategy statistics
权限范围 read:metadata · 计费:25 credits per call
Free tier
GET /v1/free/prices/latest Delayed prices, no key
无需 API 密钥 · 计费:free (fair-use limits)
GET /v1/free/symbols Free-tier symbol list, no key
无需 API 密钥 · 计费:free (fair-use limits)
GET /v1/free/market-status Market status, no key
无需 API 密钥 · 计费:free (fair-use limits)
Oracle
GET /v1/oracle/feeds Oracle feeds, networks and signer (when the oracle is enabled)
无需 API 密钥 · 计费:free
GET /v1/oracle/catalog Oracle feeds by network: asset name, category, contract, decimals (when enabled)
无需 API 密钥 · 计费:free
GET /v1/oracle/report Signed EIP-712 price reports (when the oracle is enabled)
权限范围 read:oracle · 计费:credits per signed report
错误
错误采用 RFC 9457 问题详情格式:{"type", "title", "status", "code", "detail", "request_id"}。联系支持时请提供 request_id。
| HTTP | 代码 | 含义 | 该怎么做 |
|---|---|---|---|
| 400 | invalid_parameter | A parameter is missing or malformed. | Check the parameter named in detail. |
| 400 | too_many_symbols | Too many symbols in one request. | Split the request (up to 100 symbols). |
| 400 | range_too_large | The time range is too long for this endpoint. | Request shorter ranges and page. |
| 400 | credentials_in_query | The API key was sent in the URL. | Send it in the Authorization header. |
| 401 | unauthenticated | No or an invalid API key. | Send Authorization: Bearer <key>. |
| 401 | key_revoked | The API key was revoked. | Create a new key in the dashboard. |
| 401 | key_expired | The API key has expired. | Create a new key or extend it. |
| 402 | insufficient_balance | No credits left. | Top up or choose a plan. |
| 402 | plan_credits_used_up | The plan's credits for this month are used up (your balance is never used while a plan runs). | Add credits to the month or upgrade on the billing page. |
| 402 | plan_ended | The API plan has ended; the balance is not used until you choose. | Renew, pick a plan, or choose pay as you go on the billing page. |
| 403 | insufficient_scope | The key lacks the scope this endpoint needs. | Create a key with that scope. |
| 403 | ip_not_allowed | The request came from an IP the key does not allow. | Update the key's IP list. |
| 403 | account_inactive | The account is suspended or not verified. | Verify your email or contact support. |
| 403 | sandbox_not_billable | Test keys cannot call billable endpoints. | Use a live key. |
| 404 | not_found | Resource not available. | Check the URL; some features may be switched off. |
| 404 | unknown_symbol | The symbol does not exist. | Search /symbols or the ticker list. |
| 404 | free_tier_disabled | The free tier is switched off. | Use an API key. |
| 405 | method_not_allowed | Wrong HTTP method. | Use GET. |
| 409 | idempotency_mismatch | Same Idempotency-Key reused with different parameters. | Use a new key. |
| 409 | idempotency_key_used | The Idempotency-Key was used and its answer is no longer kept (24 h, 2 MB). | Send a new key for current data. |
| 429 | rate_limited | Too many requests per minute or hour. | Wait for Retry-After; batch symbols. |
| 429 | too_many_concurrent_requests | Too many requests in parallel. | Limit concurrency. |
| 429 | daily_limit | Free-tier daily limit reached. | Retry tomorrow or use an API key. |
| 503 | oracle_unavailable | The oracle signing service is temporarily unavailable. | Retry with back-off. |
| 503 | free_tier_unavailable | The free tier is temporarily unavailable. | Retry later. |
| 503 | free_tier_busy | The free tier is busy. | Retry later or use an API key. |