API 参考

将实时信号接入您自己的系统。API 为只读：它提供市场数据，永远无法下单或操作交易所账户。属于 VIP Quant 的一部分。初次使用终端？请从文档开始。

基础 URL：

https://api.arbitragex.io

身份验证

在设置中创建密钥。密钥只显示一次，且仅以哈希形式存储，请妥善保管，切勿放在浏览器中。丢失的密钥无法找回：请吊销后重新创建。每个用户最多 5 个密钥。在每个请求（包括 websocket 升级）的 X-API-Key 请求头中发送。

curl -H "X-API-Key: $ARBITRAGEX_KEY" https://api.arbitragex.io/v1/opportunities

import os, requests

rows = requests.get(
    "https://api.arbitragex.io/v1/opportunities",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=5,
).json()["rows"]

for row in rows[:5]:
    print(row["coin"], row["buy"]["venue"], row["sell"]["venue"], row["netUsd"]["1000"])

const res = await fetch("https://api.arbitragex.io/v1/opportunities", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
const { rows } = await res.json();

for (const row of rows.slice(0, 5)) {
  console.log(row.coin, row.buy.venue, row.sell.venue, row.netUsd["1000"]);
}

吊销的密钥会在几秒内失效，已打开的连接随后很快关闭。套餐结束时密钥停止工作，套餐恢复后重新生效。

频率限制

每个密钥有独立的限额，默认每分钟 120 次请求，按一分钟窗口计算，另加 3 个开放连接。每个响应都会告诉您当前状态：

X-RateLimit-Limit：每个窗口允许的请求数。
X-RateLimit-Remaining：本窗口剩余的请求数。
X-RateLimit-Reset：距窗口结束的秒数。

获取实时行时建议使用 websocket。它在变化发生时推送，且连接打开后不计入限额。

错误

错误以 JSON 返回： { "error": "Rate limit reached." }

401：密钥错误、已吊销或其套餐已结束。
405：API 只接受 GET。
429：达到频率限制或连接数限制。请等待 Retry-After 秒。
503：暂时无法校验密钥，请稍后重试。

OpenAPI

整个 API 由一份位于固定地址的 OpenAPI 3.1 文档描述。可将其导入 Postman、Insomnia 或 Swagger UI，或据此生成带类型的客户端。其中每个端点都附有下方的 curl、Python 和 JavaScript 示例。

https://arbitragex.io/openapi.json

# A typed client, for example:
npx openapi-typescript https://arbitragex.io/openapi.json -o arbitragex.d.ts
openapi-python-client generate --url https://arbitragex.io/openapi.json

端点参考

每个 REST 端点，均由 OpenAPI 文档生成。每个示例都从 ARBITRAGEX_KEY 环境变量读取您的密钥。

/v1/opportunities Live opportunities
/v1/listings New listings
/v1/notices Exchange notices
/v1/funding Funding rates
/v1/funding/history Funding history
/v1/premiums Regional premiums
/v1/markets Volume and open interest
/v1/fees Taker fees
/v1/reliability Venue reliability
/v1/spread/{id} A route's spread over time
/v1/proof Proof Log
/v1/events Prediction market routes
/v1/events/proof Prediction market Proof Log
/v1/events/markets Prediction market browser
/v1/events/history A market's odds over time
/v1/events/holders A Polymarket market's holders and big bets

get`/v1/opportunities`Live opportunities

Every route on the feed right now, as the plan sees it. Reading it often is fine; the stream is better past a few times a minute.

strategy query: `all`, the default, or one trade type.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/opportunities"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/opportunities",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
for row in data["rows"][:5]:
    print(row["coin"], row["buy"]["venue"], row["sell"]["venue"], row["netBps"])

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/opportunities", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
for (const row of data.rows.slice(0, 5)) console.log(row.coin, row.buy.venue, row.sell.venue, row.netBps);

get`/v1/listings`New listings

Markets first seen in the last 72 hours, newest first, and listings exchanges have announced but don't list yet.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/listings"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/listings",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
for row in data["rows"]:
    print(row["venue"], row["kind"], row["coin"])

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/listings", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
for (const row of data.rows) console.log(row.venue, row.kind, row.coin);

get`/v1/notices`Exchange notices

Delistings, deposit and withdrawal suspensions, maintenance and announced listings still in effect, newest first. The same for every plan.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/notices"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/notices",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
for row in data["rows"]:
    print(row["venue"], row["kind"], row["coins"], row["title"])

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/notices", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
for (const row of data.rows) console.log(row.venue, row.kind, row.coins, row.title);

get`/v1/funding`Funding rates

Every perp's current funding rate, per interval and annualised.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/funding"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/funding",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
top = sorted(data["rows"], key=lambda r: -abs(r["aprPct"]))[:5]
for row in top:
    print(row["coin"], row["venue"], row["aprPct"])

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/funding", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
const top = [...data.rows].sort((a, b) => Math.abs(b.aprPct) - Math.abs(a.aprPct)).slice(0, 5);
for (const row of top) console.log(row.coin, row.venue, row.aprPct);

get`/v1/funding/history`Funding history

One coin's funding settlements over the last 30 days, oldest first. A gap is never filled in.

coin query, 必填: The coin, in any case.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/funding/history?coin=BTC"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/funding/history?coin=BTC",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
for row in data["rows"]:
    print(row["venue"], len(row["points"]), "settlements")

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/funding/history?coin=BTC", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
for (const row of data.rows) console.log(row.venue, row.points.length, "settlements");

get`/v1/premiums`Regional premiums

Each coin's premium in each local currency over the middle USDT price on order book venues, priced through each venue's own USDT book, with each currency's index and its 24 hours of 5-minute means. With coin, that coin's rows only, each with its own 24 hours.

coin query: One coin, in any case.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/premiums"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/premiums",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
for row in data["rows"][:5]:
    print(row["coin"], row["fiat"], row["premiumBps"], row["verified"])

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/premiums", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
for (const row of data.rows.slice(0, 5)) console.log(row.coin, row.fiat, row.premiumBps, row.verified);

get`/v1/markets`Volume and open interest

One row per market, busiest first, as arrays: [venue, kind, coin, symbol, volumeUsd, oiUsd]. Null where the venue publishes no figure.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/markets"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/markets",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
for venue, kind, coin, symbol, volume, oi in data["rows"][:5]:
    print(venue, kind, symbol, volume, oi)

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/markets", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
for (const [venue, kind, , symbol, volume, oi] of data.rows.slice(0, 5)) console.log(venue, kind, symbol, volume, oi);

get`/v1/fees`Taker fees

Each venue's published base taker fee, the rate net figures are priced at. Re-price a route at your own fees with the formula on /docs/api#fees.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/fees"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/fees",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
for row in data["rows"]:
    print(row["venue"], row["spotTakerBps"], row["perpTakerBps"])

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/fees", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
for (const row of data.rows) console.log(row.venue, row.spotTakerBps, row.perpTakerBps);

get`/v1/reliability`Venue reliability

Each venue's track record over the last 7 and 30 UTC days, from watched time only: uptime, outages, how fresh its prices were, the share of its routes that lasted 30 seconds, and wallet list changes. A figure with too little behind it is null, never a guess.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/reliability"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/reliability",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
for row in data["rows"][:5]:
    print(row["venue"], row["online"], row["uptime7d"], row["heldShare30d"])

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/reliability", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
for (const row of data.rows.slice(0, 5)) console.log(row.venue, row.online, row.uptime7d, row.heldShare30d);

get`/v1/spread/{id}`A route's spread over time

Net bps over time for one route. Without a range, the latest row, up to 72 points. With `from` or `to`, every row in that stretch, at most 2,000 points, keeping the peaks.

id path, 必填: A route id, URL-encoded.
from query: Earliest point, unix ms.
to query: Latest point, unix ms.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/spread/BTC%7CBinance%3Aspot%7COKX%3Aperp"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/spread/BTC%7CBinance%3Aspot%7COKX%3Aperp",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
print(len(data["points"]), "points, peak", max((p["netBps"] for p in data["points"]), default=None))

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/spread/BTC%7CBinance%3Aspot%7COKX%3Aperp", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
console.log(data.points.length, "points, peak", Math.max(...data.points.map((p) => p.netBps)));

get`/v1/proof`Proof Log

Closed opportunities that lasted at least 30 seconds, newest first, with a cursor for the next page.

limit query: Rows per page, 50 by default, at most 500.
from query: Earliest close, unix ms.
to query: Latest close, unix ms.
coin query: One coin, exact in any case.
cursor query: `next` from the previous page.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/proof?limit=100"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/proof?limit=100",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
for row in data["rows"][:5]:
    print(row["coin"], row["buyVenue"], row["sellVenue"], row["peakNetBps"])
print("next page:", data["next"])

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/proof?limit=100", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
for (const row of data.rows.slice(0, 5)) console.log(row.coin, row.buyVenue, row.sellVenue, row.peakNetBps);
console.log("next page:", data.next);

get`/v1/events`Prediction market routes

Sets of contracts on Polymarket, Polymarket US and Kalshi that cost less after fees than the $1 they pay at settlement, best net first, as the plan sees them. Every `cross` route is Caution: each exchange settles by its own rules, attached in `rules`.

kind query: `all`, the default, or one route kind.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/events"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/events",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
for row in data["rows"][:5]:
    print(row["kind"], row["title"], row["netBps"], row["days"])

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/events", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
for (const row of data.rows.slice(0, 5)) console.log(row.kind, row.title, row.netBps, row.days);

get`/v1/events/proof`Prediction market Proof Log

Prediction market routes that ended after lasting at least 30 seconds, newest first, with a cursor for the next page. Kept a year.

limit query: Rows per page, 50 by default, at most 500.
from query: Earliest close, unix ms.
to query: Latest close, unix ms.
kind query: `all`, the default, or one route kind.
cursor query: `next` from the previous page.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/events/proof?limit=100"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/events/proof?limit=100",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
for row in data["rows"][:5]:
    print(row["kind"], row["title"], row["venues"], row["peakNetBps"])
print("next page:", data["next"])

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/events/proof?limit=100", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
for (const row of data.rows.slice(0, 5)) console.log(row.kind, row.title, row.venues, row.peakNetBps);
console.log("next page:", data.next);

get`/v1/events/markets`Prediction market browser

Every open market on Polymarket, Polymarket US and Kalshi, routes or not, joined into events so each venue's odds for the same outcome stand side by side. Odds are YES's probability, 0 to 1. With `group`, one event whole; with `markets`, the events holding those markets. Live on every plan.

q query: Every word in the title, outcomes or questions. At most 100 characters.
category query: One category.
venue query: Events on this venue.
days query: An outcome resolving within this many days.
sort query: `volume`, the default, `closing` or `movers`.
limit query: Rows per page, 25 by default, at most 50.
cursor query: `next` from the previous page.
group query: One event's id, for all its outcomes.
markets query: Up to 50 `<venue>|<market id>`, comma separated.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/events/markets?category=crypto&sort=closing"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/events/markets?category=crypto&sort=closing",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
for row in data["rows"][:5]:
    print(row["title"], [(q["venue"], q["prob"]) for q in row["lines"][0]["quotes"]])

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/events/markets?category=crypto&sort=closing", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
for (const row of data.rows.slice(0, 5)) console.log(row.title, row.lines[0].quotes.map((q) => [q.venue, q.prob]));

get`/v1/events/history`A market's odds over time

YES's probability over a day, week or month, oldest first: from the venue where it keeps a history, else sampled by us.

venue query, 必填: The market's venue.
market query, 必填: The market id, as in a quote's `marketId`.
range query: `1d`, `1w` or `1m`.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/events/history"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/events/history",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
print(len(data["points"]), "points from", data["source"])

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/events/history", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
console.log(data.points.length, "points from", data.source);

get`/v1/events/holders`A Polymarket market's holders and big bets

The top 10 holders of each outcome and the latest 20 bets of $1,000 or more, as Polymarket's public data states them.

market query, 必填: Polymarket's condition id.

curl

curl -s -H "X-API-Key: $ARBITRAGEX_KEY" "https://api.arbitragex.io/v1/events/holders"

Python

import os
import requests

res = requests.get(
    "https://api.arbitragex.io/v1/events/holders",
    headers={"X-API-Key": os.environ["ARBITRAGEX_KEY"]},
    timeout=10,
)
res.raise_for_status()
data = res.json()
for h in data["holders"][:5]:
    print(h["side"], h["name"] or h["address"], h["shares"])

JavaScript

const res = await fetch("https://api.arbitragex.io/v1/events/holders", {
  headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
});
if (!res.ok) throw new Error((await res.json()).error);
const data = await res.json();
for (const h of data.holders.slice(0, 5)) console.log(h.side, h.name ?? h.address, h.shares);

机会

GET /v1/opportunities 返回所有实时行，净利最高的在前。

{
  "rows": [
    {
      "id": "BTC|Binance:spot|OKX:perp",
      "coin": "BTC",
      "strategy": "spot_perp",
      "buy": { "venue": "Binance", "kind": "spot", "symbol": "BTCUSDT", "price": 68250.1,
               "sizeUsd": 41200, "ageMs": 120, "fundingBps8h": null, "url": "https://..." },
      "sell": { "venue": "OKX", "kind": "perp", "symbol": "BTC-USDT-SWAP", "price": 68310.4,
                "sizeUsd": 38900, "ageMs": 240, "fundingBps8h": 1.2, "url": "https://..." },
      "grossBps": 8.8,
      "netBps": 2.1,
      "netUsd": { "100": 0.2, "1000": 2.1, "10000": 19.4, "100000": null, "1000000": null },
      "maxSizeUsd": 21400,
      "exitBps": 6.2,
      "transfer": "not_needed",
      "network": null,
      "status": "verified",
      "reasons": [],
      "firstSeenMs": 1793570209670,
      "updatedMs": 1793570229670,
      "spark": [2.0, 2.1]
    }
  ],
  "delayedMs": 0
}

资金费率

GET /v1/funding 返回每个永续合约的当前资金费率。

{ "rows": [ { "coin": "BTC", "venue": "Binance", "symbol": "BTCUSDT", "ratePct": 0.01,
             "hours": 8, "aprPct": 10.95, "nextFundingMs": 1793577600000 } ] }

手续费

GET /v1/fees 返回各交易所公布的吃单手续费，单位为 bps，按每次成交计。净利数值使用基础费率。要按您自己的费率计算规模 S 的净利：

{ "rows": [ { "venue": "Binance", "spotTakerBps": 10, "perpTakerBps": 5 } ] }

fills = 1 if strategy == "spot" else 2   # a hedged route pays again to close
shift = fills * ((paid_buy - mine) + (paid_sell - mine) * (1 + grossBps / 10000))
net   = netUsd[S] + S * shift / 10000

价差

GET /v1/spread/:id 返回某条路径的净价差，开放期间为实时值，关闭后为保存值。请对 id 进行 URL 编码。添加 from 或 to（unix 毫秒）可读取该路径在此范围内的全部保存历史：最多 2,000 个数据点，最早的在前，保留峰值。

curl -H "X-API-Key: $ARBITRAGEX_KEY" \
  "https://api.arbitragex.io/v1/spread/BTC%7CBinance%3Aspot%7COKX%3Aperp"

{ "points": [ { "t": 1793570209670, "netBps": 2.1 } ], "historyFromMs": 0 }

Proof Log

GET /v1/proof?limit=50 返回持续至少 30 秒的已关闭机会，最新的在前。limit 最大为 500。在 5 分钟内重新出现的路径会扩展其最后一行，因此某行可能会回到顶部。

from、to：unix 毫秒，按该行关闭的时间。
coin：单个币种。
cursor：上一页的 next 值。最后一页的 next 为 null。

{ "rows": [ { "id": "BTC|Binance:spot|OKX:perp", "coin": "BTC", "strategy": "spot_perp",
             "buyVenue": "Binance", "sellVenue": "OKX", "peakNetBps": 4.2, "maxSizeUsd": 21400,
             "openNetBps": 3.8, "openSizeUsd": 18200, "closeNetBps": 1.1, "closeSizeUsd": 9600,
             "status": "verified", "openedMs": 1793570209670, "closedMs": 1793570389670 } ],
  "next": "1793570389670:48121", "historyFromMs": 0 }

WebSocket

使用 X-API-Key 请求头中的密钥连接到 wss://api.arbitragex.io/v1/stream。您会先收到包含所有行的 snapshot，之后最多每 250 ms 收到一批更新。落后约 4 秒的客户端会被断开，重连后会收到新的快照。

import WebSocket from "ws";

const rows = new Map();

function connect() {
  const socket = new WebSocket("wss://api.arbitragex.io/v1/stream", {
    headers: { "X-API-Key": process.env.ARBITRAGEX_KEY },
  });
  socket.on("message", (data) => {
    const message = JSON.parse(data);
    if (message.type === "snapshot") {
      rows.clear();
      for (const row of message.rows) rows.set(row.id, row);
    }
    if (message.type === "upsert") for (const row of message.rows) rows.set(row.id, row);
    if (message.type === "remove") for (const id of message.ids) rows.delete(id);
  });
  socket.on("close", () => setTimeout(connect, 1000));
}

connect();

snapshot：{ type, rows, delayedMs }，总是第一条。
upsert：{ type, rows }，新增或变更的行，每批最多 400 条。
remove：{ type, ids }，已消失的行。
health：{ type, venues, medianLatencyMs }，每 5 秒一次。

类型

strategy：spot、spot_perp 或 perp_perp。
status：verified 或 caution，reasons 中为文字说明。
transfer：open、unknown 或 not_needed。
netUsd：每个规模下的预估利润。null 表示订单簿无法满足成交。
netBps：按 $1,000 扣除成本后的值；如果 $1,000 亏损，则按最赚钱的规模计算。
时间为 unix 毫秒。价格为每整枚币的 USDT 价格。

净利数值是估算值，不是实际成交。请参阅净利如何计算。您需对自己所做的任何自动化负责。

API 参考

身份验证

频率限制

错误

OpenAPI

端点参考

get/v1/opportunitiesLive opportunities

get/v1/listingsNew listings

get/v1/noticesExchange notices

get/v1/fundingFunding rates

get/v1/funding/historyFunding history

get/v1/premiumsRegional premiums

get/v1/marketsVolume and open interest

get/v1/feesTaker fees

get/v1/reliabilityVenue reliability

get/v1/spread/{id}A route's spread over time

get/v1/proofProof Log

get/v1/eventsPrediction market routes

get/v1/events/proofPrediction market Proof Log

get/v1/events/marketsPrediction market browser

get/v1/events/historyA market's odds over time

get/v1/events/holdersA Polymarket market's holders and big bets

机会

资金费率

手续费

价差

Proof Log

WebSocket

类型

get`/v1/opportunities`Live opportunities

get`/v1/listings`New listings

get`/v1/notices`Exchange notices

get`/v1/funding`Funding rates

get`/v1/funding/history`Funding history

get`/v1/premiums`Regional premiums

get`/v1/markets`Volume and open interest

get`/v1/fees`Taker fees

get`/v1/reliability`Venue reliability

get`/v1/spread/{id}`A route's spread over time

get`/v1/proof`Proof Log

get`/v1/events`Prediction market routes

get`/v1/events/proof`Prediction market Proof Log

get`/v1/events/markets`Prediction market browser

get`/v1/events/history`A market's odds over time

get`/v1/events/holders`A Polymarket market's holders and big bets