API
Sign In to Get Started
Interactive API Documentation
Explore all endpoints, try requests, and see responses in real-time with our Swagger UI
Open Swagger UICLI
Run audits from the command line
SETUP (ONCE)
curl -L audited.sh -o audited.sh
sh audited.sh --local [directory]
export AUDITED_API_KEY=your_key
sh audited.sh --api [directory]
--fix
export AUDITED_CODE=your_code
MCP Server
Use audited.xyz from Claude Desktop, Claude Code, Cursor, or any MCP-compatible client
CLAUDE CODE
claude mcp add audited npx audited-mcp
CLAUDE DESKTOP
Add to ~/Library/Application Support/Claude/claude_desktop_config.json
{
"mcpServers": {
"audited": {
"command": "npx",
"args": ["-y", "audited-mcp"]
}
}
}Browse public reports immediately. To start audits, use the login tool with your API key.
Tools
list_reports
no auth
List public audit reports. Filter by project type (solidity, rust, c, etc.)
get_report
no auth
Get full markdown audit report by slug
get_findings
no auth
Get findings with severity, description, location, and recommended fix
start_audit
API key
Start a new audit from a GitHub URL. Returns audit ID for status polling.
check_status
API key
Check audit generation progress. Returns status, findings count, and report URL when complete.
Works with any MCP-compatible client. The API key is only needed for starting new audits — browsing public reports is free.
Claude Code Skill
AI assistant for audited.xyz inside Claude Code
INSTALL / UPDATE (FROM YOUR PROJECT ROOT)
curl -L audited.sh/skill | sh
USAGE (IN CLAUDE CODE)
/audit
ask anything about the platform
Requires Claude Code. The skill knows the full audited.xyz platform — CLI flags, API, findings, badges, attestations, credits, CI setup, and more. Re-run the one-liner anytime to update.
GitHub Actions
Run audits automatically on every push or PR
.github/workflows/audit.yml
name: Audit
on: [push, pull_request]
jobs:
audit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Get Audited
env:
AUDITED_API_KEY: ${{ secrets.AUDITED_API_KEY }}
run: |
curl -sL audited.sh -o audited.sh
sh audited.sh --api --fail-on high . -o audit-report.md
- name: Upload Report
uses: actions/upload-artifact@v4
with:
name: audit-report
path: audit-report.md
Setup
- Create API key above
- Go to repo Settings → Secrets → Actions
- Add secret named
AUDITED_API_KEY