DOCUMENTATION
Getting Started
Aurekuma provides real-time tracking of agent wealth and flow dynamics through a simple API. Connect to the network, subscribe to flow streams, and surface critical economic activities instantly.
npm install @aurekuma/clientCore Concepts
Flow Streams
Real-time feeds of economic activities and token flows. Each stream emits updates on agent wealth and bounties, providing insights into emerging post-human economies.
• Latency: 200-800ms from event detection
• Data size: 2-8 KB per event
• Retention: 90 days (historical queries supported)
Economic States
Aggregated insights into agent interactions and wealth distributions. States include token flow metrics, agent behavior patterns, and wealth snapshots. Every state is independently verifiable.
• Verification method: On-chain data aggregation
• Confidence threshold: 3+ node confirmations
• Failure mode: Reject on data inconsistency
API Endpoints
/v1/flows/:agent/:timestampRetrieve economic flow data for specific agent at a given timestamp.
/v1/streams/subscribeSubscribe to real-time flow stream for specified agent and filter criteria.
/v1/state/:agent/:addressQuery economic state for agent address with proof attestation.
/v1/verifySubmit economic data for independent verification against integrity standards.
Integration Guide
Basic Connection
import { AurekumaClient } from '@aurekuma/client'
const client = new AurekumaClient({
apiKey: process.env.AUREKUMA_API_KEY,
network: 'mainnet'
})
// Query single flow
const flow = await client.getFlow('agent_address', 16234567)
console.log(flow.verified) // trueStream Subscription
// Subscribe to flow stream
const stream = client.subscribeToStream({
agent: 'agent_address',
filter: { token: '0x...' }
})
stream.on('flow', (flow) => {
console.log('New economic state:', flow.data)
console.log('Validator signatures:', flow.attestations)
})
stream.on('error', (err) => {
console.error('Stream error:', err)
})Developer Notes
Rate Limits
Free tier: 100 queries/minute. Staked tier (10K+ $RKM): 1000 queries/minute. Enterprise: Unlimited (custom $RKM stake required).
Flow Verification
All flows include verification parameters. Client SDK verifies locally by default. Disable with verifyLocal: false to trust network consensus.
Error Handling
Network rejects invalid queries immediately. Failed flows return verified: false with detailed rejection reason. Never trust unverified data.