DOCUMENTATION

Getting Started

Auretil provides a powerful dashboard for tracking whale activity and coordinated bets in prediction markets. Connect to key platforms like Polymarket or Kalshi, and gain insights into market dynamics and sentiment shifts.

npm install @auretil/client

Core Concepts

Whale Tracking

Monitor significant market movements caused by large participants. Auretil identifies whale entries and coordinated betting patterns to help you make informed decisions.

• Impact analysis: Assess how whale behavior alters market sentiment

• Real-time alerts: Get notified of whale activity as it happens

• Historical tracking: Review past whale movements for insights

Cluster Behaviors

Identify groups of traders making similar bets, revealing concerted efforts that can indicate market trends. Auretil analyzes cluster behaviors to provide insights into potential market shifts.

• Group dynamics: Understand how clusters form and behave

• Anticipate movements: Predict market changes based on cluster data

• Visualization: Access graphical representations of cluster activities

API Endpoints

GET/v1/whales/:market

Retrieve data on recent whale activities for a specified market.

POST/v1/alerts/subscribe

Subscribe to real-time alerts for whale entries and market shifts.

GET/v1/clusters/:market

Query information on cluster behaviors for a specific market.

POST/v1/verify

Submit data for verification against market integrity standards.

Integration Guide

Basic Connection

import { AuretilClient } from '@auretil/client'

const client = new AuretilClient({
  apiKey: process.env.AURETIL_API_KEY,
  network: 'mainnet'
})

// Query whale activity
const whaleData = await client.getWhaleActivity('polymarket')
console.log(whaleData)

Alert Subscription

// Subscribe to whale activity alerts
const alerts = client.subscribeToAlerts({
  market: 'kalshi',
  filter: { volumeThreshold: 1000 }
})

alerts.on('whale', (data) => {
  console.log('New whale activity detected:', data)
})

alerts.on('error', (err) => {
  console.error('Alert error:', err)
})

Developer Notes

Rate Limits

Free tier: 100 queries/minute. Staked tier (10K+ $ARTL): 1000 queries/minute. Enterprise: Unlimited (custom $ARTL stake required).

Data Verification

All data submissions are verified against market integrity standards. Client SDK verifies locally by default. Disable with verifyLocal: false to trust network consensus.

Error Handling

Network rejects invalid queries immediately. Failed submissions return verified: false with detailed rejection reason. Always ensure data integrity before acting on alerts.