Перейти до вмісту
Підключення
Zero Ghost Spreads
AXARBITRAGEX
Спробувати безкоштовно

Довідник API

Підключіть живі сигнали до власного стеку. API лише для читання: він віддає ринкові дані й ніколи не може розмістити ордер чи торкнутися біржового акаунта. Входить до VIP Quant. Новачок у терміналі? Почніть із документації.

Базовий URL:

https://api.arbitragex.io

Автентифікація

Створіть ключ у Налаштуваннях. Він показується один раз і зберігається лише як хеш, тож бережіть його й ніколи не розміщуйте в браузері. Втрачені ключі не відновити: відкличте й створіть інший. До 5 ключів на користувача. Надсилайте його в заголовку X-API-Key у кожному запиті, включно з websocket upgrade.

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.

get/v1/opportunitiesLive 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/listingsNew 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/noticesExchange 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/fundingFunding 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/historyFunding 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/premiumsRegional 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/marketsVolume 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/feesTaker 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/reliabilityVenue 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/proofProof 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/eventsPrediction 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/proofPrediction 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/marketsPrediction 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/historyA 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/holdersA 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

Підключіться до wss://api.arbitragex.io/v1/stream із ключем у заголовку X-API-Key. Ви отримаєте snapshot усіх рядків, а потім пакети не частіше ніж раз на 250 мс. Клієнт, що відстає приблизно на 4 секунди, відключається й отримує свіжий snapshot після перепідключення.

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 за цілу монету.

Чисті показники — це оцінки, а не виконання. Дивіться як рахується чистий. Ви відповідаєте за все, що автоматизуєте.