Xerberus risk intelligence API

Xerberus vault risk classification for composite scores on DeFi vault pools and protocols.

Unlike Core3 (protocol-level Probability of Loss), Xerberus primarily rates individual vaults by (chain_id, address). Protocol scores are used as a fallback and exported under the top-level xerberus_protocols JSON key.

See eth_defi/xerberus/README-xerberus.md for operator documentation.

Authentication

Live API calls require both:

  • XERBERUS_API_KEY (or create_xerberus_session(api_key=...))

  • XERBERUS_API_EMAIL (or create_xerberus_session(api_email=...)), the email registered with the key, sent as the x-user-email header

Prefer passing credentials explicitly in code. Agents must not invent or probe candidate emails; only use operator-supplied XERBERUS_API_EMAIL or an explicit api_email argument.

Features:

  • Dual-auth REST session (key + registered email) with paced rate limiting

  • DuckDB storage of registry snapshots, vault lists and derived daily scores

  • Per-vault export via calculate_lifetime_metrics

  • Top-level xerberus_protocols metadata parallel to core3_protocols

eth_defi.xerberus.session

HTTP session management for Xerberus public REST API.

eth_defi.xerberus.api

Fetch helpers for Xerberus public REST API endpoints.

eth_defi.xerberus.database

DuckDB persistence for Xerberus risk classification data.

eth_defi.xerberus.scanner

Xerberus risk scanner with DuckDB storage.

eth_defi.xerberus.constants

Shared constants for Xerberus integration.

eth_defi.xerberus.mappings

Mapping between our vault protocol slugs and Xerberus protocol entity ids.

eth_defi.xerberus.vault_export

Export helpers for Xerberus risk data into vault metrics JSON.

eth_defi.xerberus.errors

Xerberus API error types.