Referensi API

Sambungkan sinyal live ke stack Anda sendiri. API ini read-only: hanya menyajikan data pasar dan tidak pernah bisa memasang order atau menyentuh akun bursa. Bagian dari VIP Quant. Baru mengenal terminal? Mulai dengan dokumentasi.

URL dasar:

https://api.arbitragex.io

Autentikasi

Buat key di Pengaturan. Key hanya ditampilkan sekali dan disimpan sebagai hash, jadi simpan dengan aman dan jangan pernah menaruhnya di browser. Key yang hilang tidak dapat dipulihkan: cabut dan buat yang baru. Maksimal 5 key per pengguna. Kirim di header X-API-Key pada setiap request, termasuk upgrade 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 yang dicabut berhenti berfungsi dalam hitungan detik, dan socket yang terbuka segera ditutup. Key berhenti saat paketnya berhenti, dan aktif lagi jika paketnya kembali.

Batas rate

Setiap key memiliki batasnya sendiri, default 120 request per menit, dihitung dalam jendela satu menit, ditambah 3 socket terbuka. Setiap respons memberi tahu posisi Anda:

X-RateLimit-Limit: request yang diizinkan per jendela.
X-RateLimit-Remaining: sisa request di jendela ini.
X-RateLimit-Reset: detik hingga jendela berakhir.

Gunakan websocket untuk baris live. Websocket mengirim perubahan saat terjadi, dan satu socket tidak dihitung terhadap batas setelah terbuka.

Error

Error berupa JSON: { "error": "Rate limit reached." }

401: key salah, dicabut, atau paketnya telah berakhir.
405: API hanya menerima GET.
429: batas rate atau batas socket tercapai. Tunggu Retry-After detik.
503: key tidak dapat diperiksa saat ini. Coba lagi sebentar.

OpenAPI

Seluruh API dijelaskan dalam satu dokumen OpenAPI 3.1 di alamat yang tetap. Impor ke Postman, Insomnia, atau Swagger UI, atau buat klien bertipe darinya. Setiap endpoint di dalamnya menyertakan contoh curl, Python, dan JavaScript di bawah.

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

Referensi endpoint

Setiap endpoint REST, dibuat dari dokumen OpenAPI. Setiap contoh membaca key Anda dari variabel lingkungan 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, wajib: 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, wajib: 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, wajib: The market's venue.
market query, wajib: 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, wajib: 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);

Peluang

GET /v1/opportunities mengembalikan setiap baris live, bersih tertinggi lebih dulu.

{
  "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 mengembalikan funding rate terkini setiap perp.

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

Biaya

GET /v1/fees mengembalikan biaya taker yang dipublikasikan tiap bursa dalam bps, per eksekusi. Angka bersih memakai tarif dasar. Untuk menghitung bersih dengan biaya Anda sendiri pada ukuran 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 mengembalikan spread bersih sebuah rute, live selama terbuka dan sesuai yang tersimpan setelah ditutup. Lakukan URL-encode pada id. Tambahkan from atau to, dalam milidetik unix, untuk membaca rute di seluruh riwayat tersimpannya dalam rentang itu: maksimal 2.000 titik, terlama lebih dulu, dengan mempertahankan puncaknya.

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 mengembalikan peluang yang sudah tertutup dan bertahan setidaknya 30 detik, terbaru lebih dulu. limit maksimal 500. Rute yang kembali dalam 5 menit memperlebar baris terakhirnya, jadi sebuah baris bisa kembali ke atas.

from, to: milidetik unix, berdasarkan waktu baris ditutup.
coin: satu koin.
cursor: nilai next dari halaman terakhir. next bernilai null di halaman terakhir.

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

Hubungkan ke wss://api.arbitragex.io/v1/stream dengan key di header X-API-Key. Anda menerima snapshot dari setiap baris, lalu batch paling cepat setiap 250 ms. Klien yang tertinggal sekitar 4 detik akan ditutup, dan menerima snapshot baru saat terhubung kembali.

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 }, selalu pertama.
upsert: { type, rows }, baris baru atau berubah, maksimal 400 per batch.
remove: { type, ids }, baris yang sudah hilang.
health: { type, venues, medianLatencyMs }, setiap 5 detik.

Tipe

strategy: spot, spot_perp, atau perp_perp.
status: verified atau caution, dengan penjelasan biasa di reasons.
transfer: open, unknown, atau not_needed.
netUsd: estimasi profit pada setiap ukuran. null berarti order book tidak bisa mengisinya.
netBps: setelah biaya pada $1.000, atau pada ukuran paling menguntungkan jika $1.000 rugi.
Waktu dalam milidetik unix. Harga dalam USDT per satu koin utuh.

Angka bersih adalah estimasi, bukan eksekusi. Lihat cara bersih dihitung. Anda bertanggung jawab atas apa pun yang Anda otomatiskan.

Referensi API

Autentikasi

Batas rate

Error

OpenAPI

Referensi 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

Peluang

Funding

Biaya

Spread

Proof Log

Websocket

Tipe

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