Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.arbiterapi.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Installation

npm install arbiterapi

​
Usage

import { ArbiterClient } from 'arbiterapi';

const client = new ArbiterClient({ apiKey: 'YOUR_API_KEY' });

// List markets
const markets = await client.markets.list({ limit: 10 });

// Search markets
const results = await client.markets.search({ q: 'world cup', min_volume: 100000 });

// Get market details
const market = await client.markets.get('poly_0x24fb...');

// Get current price
const price = await client.markets.price('poly_0x24fb...');

// Get historical price
const historicalPrice = await client.markets.price('poly_0x24fb...', { at_time: 1774300000 });

// Get orderbook
const book = await client.markets.orderbook('poly_0x24fb...');

// Get trades
const trades = await client.markets.trades('poly_0x24fb...', { limit: 50 });

// Get OHLCV candles
const candles = await client.markets.candles('poly_0x24fb...', {
  interval: '1h',
  start: new Date('2026-01-01'),
  end: new Date(),
});

// List events
const events = await client.events.list({ limit: 10 });

// Get event detail
const event = await client.events.get('2026-fifa-world-cup-winner-595');

​
Configuration

const client = new ArbiterClient({
  apiKey: 'YOUR_API_KEY',
  baseUrl: 'https://api.arbiterapi.com', // default
});