@zarq/elizaos-plugin
v0.1.0
Published
ZARQ risk intelligence plugin for ElizaOS agents — check token safety before trading
Downloads
12
Maintainers
Readme
ZARQ Plugin for ElizaOS
Add crypto risk intelligence to your ElizaOS agent. Automatically checks token safety when users ask about trading.
Quick Start
import zarqPlugin from "./plugin-zarq";
const agent = new AgentRuntime({
plugins: [zarqPlugin],
// ... other config
});Installation
Copy plugin-zarq.ts into your ElizaOS project's plugins directory, then register it in your agent config.
Dependencies: @elizaos/core, zod (both included in ElizaOS)
How It Works
The plugin registers a CHECK_TOKEN_RISK action that automatically triggers when users ask about crypto trading safety. It:
- Detects crypto-related risk/safety questions in messages
- Extracts the token name using the agent's LLM
- Calls the ZARQ API (
GET https://zarq.ai/v1/check/{token}) - Returns a formatted risk report with verdict, trust score, and crash probability
Trigger Examples
The action activates on messages like:
- "Is bitcoin safe to buy right now?"
- "Check the risk on solana before I trade"
- "Should I sell my ETH?"
- "What's the crash risk for cardano?"
Response Format
**Bitcoin (BTC)** — Verdict: **WARNING**
Trust Score: 74.52/100 (A2)
Crash Probability: 31.8%
Distance to Default: 3.03
Price: $70,825
Elevated risk detected. Consider reducing position size.Direct API Usage
You can also call the ZARQ API directly from any ElizaOS action:
import { checkTokenRisk, formatRiskReport } from "./plugin-zarq";
const result = await checkTokenRisk("bitcoin");
console.log(formatRiskReport(result));API Details
- Endpoint:
GET https://zarq.ai/v1/check/{token} - Auth: None required
- Rate limit: 5,000 calls/day per IP (free forever)
- Coverage: 205 tokens
- Latency: <100ms typical
- Docs: https://zarq.ai/docs
