05 — API Reference

Integrate with GuardFi AI

Use the REST API to scan contracts, retrieve reports, and verify results programmatically.

Base URL

https://api.guardfi.ai/v1

POST /scanGET /reports/:idPOST /verify

Request

curl -X POST https://api.guardfi.ai/v1/scan \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contractAddress": "0x8f3a...7bC9d2",
    "chainId": 133
  }'

Response200 OK

{
  "success": true,
  "scanId": "scan_01J2KQ9Z6V7YQW5E8R1T2A3D",
  "status": "completed",
  "riskScore": 72,
  "reportHash": "QmY8U2x7...9nL3kP1v",
  "contractAddress": "0x8f3a...7bC9d2"
}