ARES TypeScript SDK

Minimal TypeScript client for the public ARES Protocol API.

Canonical MCP quickstart:

• docs/ares-mcp.md

Quickstart

import { AresClient } from '@aresprotocol/sdk';

const client = new AresClient({
  apiBase: 'https://ares-protocol.xyz/api'
});

const agent = await client.getAgent('star');
const score = await client.getScore('star');
const leaderboard = await client.getLeaderboard();
const actions = await client.getActions({ agent: 'star', limit: 10 });
const disputes = await client.getDisputes({ agent: 'star', limit: 10 });
const health = await client.healthCheck();

Available Methods

• getAgent(address: string)
• getScore(address: string)
• getLeaderboard()
• getActions(query?: { agent?: string; limit?: number; cursor?: string; page?: number })
• getDisputes(query?: { agent?: string; limit?: number; cursor?: string | number; resolution?: 'pending' | 'accepted' | 'rejected' | 'no_quorum' })
• healthCheck()

Notes

• apiBase should point to the public API root, for example https://ares-protocol.xyz/api.
• The constructor also accepts legacy baseUrl for backward compatibility, but apiBase is the preferred option.