Tài liệu tham khảo API

Đưa tín hiệu trực tiếp vào hệ thống của riêng bạn. API chỉ đọc: nó cung cấp dữ liệu thị trường và không bao giờ đặt lệnh hay chạm vào tài khoản sàn. Thuộc gói VIP Quant. Mới dùng terminal? Hãy bắt đầu với tài liệu.

URL gốc:

https://api.arbitragex.io

Xác thực

Tạo key trong Cài đặt. Key chỉ hiển thị một lần và chỉ được lưu dưới dạng hash, nên hãy giữ an toàn và không bao giờ đặt nó trong trình duyệt. Key bị mất không thể khôi phục: hãy thu hồi và tạo key khác. Tối đa 5 key mỗi người dùng. Gửi key trong header X-API-Key ở mọi request, kể cả khi nâng cấp websocket.

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"]);
}

Key bị thu hồi ngừng hoạt động trong vài giây, và các socket đang mở đóng ngay sau đó. Key ngừng khi gói ngừng, và hoạt động lại nếu gói được khôi phục.

Giới hạn tần suất

Mỗi key có giới hạn riêng, mặc định 120 request mỗi phút, tính theo cửa sổ một phút, cộng 3 socket đang mở. Mọi phản hồi đều cho bạn biết tình trạng hiện tại:

X-RateLimit-Limit: số request được phép mỗi cửa sổ.
X-RateLimit-Remaining: số request còn lại trong cửa sổ này.
X-RateLimit-Reset: số giây đến khi cửa sổ kết thúc.

Nên dùng websocket cho dòng trực tiếp. Nó đẩy thay đổi ngay khi xảy ra, và một socket không bị tính vào giới hạn sau khi đã mở.

Lỗi

Lỗi ở dạng JSON: { "error": "Rate limit reached." }

401: key sai, đã bị thu hồi, hoặc gói đã kết thúc.
405: API chỉ chấp nhận GET.
429: đã đạt giới hạn tần suất hoặc giới hạn socket. Chờ Retry-After giây.
503: hiện không thể kiểm tra key. Thử lại sau giây lát.

OpenAPI

Toàn bộ API được mô tả trong một tài liệu OpenAPI 3.1 tại một địa chỉ cố định. Nhập nó vào Postman, Insomnia hoặc Swagger UI, hoặc tạo client có kiểu từ nó. Mọi endpoint trong đó đều kèm các ví dụ curl, Python và JavaScript bên dưới.

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

Tham chiếu endpoint

Mọi endpoint REST, được tạo từ tài liệu OpenAPI. Mỗi ví dụ đọc key của bạn từ biến môi trường 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, bắt buộc: 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, bắt buộc: 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, bắt buộc: The market's venue.
market query, bắt buộc: 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, bắt buộc: 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);

Cơ hội

GET /v1/opportunities trả về mọi dòng trực tiếp, ròng cao nhất trước.

{
  "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
}

Funding

GET /v1/funding trả về funding rate hiện tại của mọi perp.

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

Phí

GET /v1/fees trả về phí taker công bố của từng sàn tính bằng bps, cho mỗi lần khớp. Số liệu ròng dùng mức cơ bản. Để tính ròng theo phí của riêng bạn ở khối lượng 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

Spread

GET /v1/spread/:id trả về spread ròng của một tuyến, trực tiếp khi đang mở và theo bản lưu sau khi đóng. Mã hóa URL cho id. Thêm from hoặc to, tính bằng mili giây unix, để đọc tuyến trên toàn bộ lịch sử đã lưu trong khoảng đó: tối đa 2.000 điểm, cũ nhất trước, giữ các đỉnh.

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 trả về các cơ hội đã đóng kéo dài ít nhất 30 giây, mới nhất trước. limit tối đa 500. Tuyến quay lại trong vòng 5 phút sẽ nới rộng dòng cuối của nó, nên một dòng có thể quay lại đầu.

from, to: mili giây unix, theo thời điểm dòng đóng.
coin: một coin.
cursor: giá trị next của trang trước. next là null ở trang cuối.

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

Kết nối tới wss://api.arbitragex.io/v1/stream với key trong header X-API-Key. Bạn nhận một snapshot của mọi dòng, sau đó là các lô tối đa mỗi 250 ms. Client bị chậm khoảng 4 giây sẽ bị đóng, và nhận snapshot mới khi kết nối lại.

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 }, luôn đến trước.
upsert: { type, rows }, dòng mới hoặc đã thay đổi, tối đa 400 trong một lô.
remove: { type, ids }, các dòng đã biến mất.
health: { type, venues, medianLatencyMs }, mỗi 5 giây.

Kiểu dữ liệu

strategy: spot, spot_perp hoặc perp_perp.
status: verified hoặc caution, với lời giải thích trong reasons.
transfer: open, unknown hoặc not_needed.
netUsd: lợi nhuận ước tính ở mỗi khối lượng. null nghĩa là sổ lệnh không khớp được.
netBps: sau chi phí ở 1.000 $, hoặc ở khối lượng có lãi nhất nếu 1.000 $ bị lỗ.
Thời gian tính bằng mili giây unix. Giá tính bằng USDT cho mỗi coin nguyên.

Số liệu ròng là ước tính, không phải lệnh khớp. Xem cách tính ròng. Bạn chịu trách nhiệm cho mọi thứ bạn tự động hóa.

Tài liệu tham khảo API

Xác thực

Giới hạn tần suất

Lỗi

OpenAPI

Tham chiếu endpoint

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

Cơ hội

Funding

Phí

Spread

Proof Log

Websocket

Kiểu dữ liệu

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