⚡ Developer Platform
Build with the AuditFarm API
Integrate token checks, wallet profiles, audit-report verification and security signals into your website, application, exchange, explorer or Web3 dashboard.
API Overview
The AuditFarm API is planned as a secure data layer for applications that need structured wallet, token and audit-report information.
Token Security
Retrieve structured token-risk signals and metadata.
Wallet Directory
Read public wallet profiles and current audit status.
Report Verification
Confirm whether a report ID is valid, current or outdated.
Important: These endpoints are documentation examples only.
A production backend, database, API-key service, logging, rate limiting and security monitoring must be built before launch.
Quick Start
Send a GET request with your API key in the X-AuditFarm-Key header.
cURL example
curl --request GET \ --url "https://api.auditfarm.org/v1/coin/audit?network=bsc&address=0xbe0ebebd622061cb87084377570a1db2a87b42bd" \ --header "X-AuditFarm-Key: af_live_your_api_key"
JavaScript example
const response = await fetch(
"https://api.auditfarm.org/v1/coin/audit?network=bsc&address=0xbe0ebebd622061cb87084377570a1db2a87b42bd",
{
headers: {
"X-AuditFarm-Key": "af_live_your_api_key"
}
}
);
if (!response.ok) {
throw new Error(`AuditFarm API error: ${response.status}`);
}
const result = await response.json();
console.log(result);
Authentication
Production requests should use an API key. Keep secret keys on your server and never expose unrestricted keys inside public frontend code.
Required header
X-AuditFarm-Key: af_live_your_api_key
Security rule: API keys must support rotation, revocation, usage limits,
origin restrictions and audit logs. The demo key generator on this page does not create a real account.
Coin Audit Endpoint
Retrieve token metadata and available automated security signals.
GET
/v1/coin/audit
| Parameter | Type | Required | Description |
|---|---|---|---|
network | string | Yes | Network code, such as bsc or ethereum. |
address | string | Yes | Token contract address. |
include_market | boolean | No | Include available market metadata. |
Example response
{
"success": true,
"data": {
"network": "bsc",
"address": "0xbe0ebebd622061cb87084377570a1db2a87b42bd",
"name": "LegacyTarekToken",
"symbol": "BLT",
"security_score": 92,
"status": "automated_check",
"signals": {
"honeypot": false,
"buy_tax": 0,
"sell_tax": 0,
"mintable": false,
"ownership_renounced": null
},
"disclaimer": "Automated signals do not guarantee security."
}
}
Wallet Profile Endpoint
Retrieve a public wallet-directory profile and its current AuditFarm review status.
GET
/v1/wallets/{slug}
| Parameter | Location | Required | Description |
|---|---|---|---|
slug | Path | Yes | Wallet identifier, such as blt-wallet. |
include_reports | Query | No | Include related public reports. |
Example response
{
"success": true,
"data": {
"slug": "blt-wallet",
"name": "BLT Wallet",
"platforms": ["Android"],
"wallet_type": "non-custodial",
"audit_status": "pending",
"current_report_id": "AF-WALLET-BLT-2026-DRAFT",
"verified": false
}
}
Verify Report Endpoint
Confirm whether a report ID exists and whether it still applies to the current reviewed version.
GET
/v1/reports/verify/{report_id}
| Parameter | Location | Required | Description |
|---|---|---|---|
report_id | Path | Yes | AuditFarm report identifier. |
Example response
{
"success": true,
"data": {
"report_id": "AF-WALLET-BLT-2026-DRAFT",
"project": "BLT Wallet",
"report_type": "wallet_security",
"status": "audit_pending",
"valid": true,
"verified": false,
"current": true,
"version": "pending_submission"
}
}
Error Responses
All errors should use a consistent JSON structure.
Example error
{
"success": false,
"error": {
"code": "INVALID_ADDRESS",
"message": "The supplied contract address is invalid.",
"request_id": "req_01HZAUDITFARM"
}
}
| HTTP Status | Meaning |
|---|---|
| 400 | Invalid request or unsupported parameter. |
| 401 | Missing or invalid API key. |
| 404 | Wallet, token or report not found. |
| 429 | Rate limit exceeded. |
| 500 | Unexpected server error. |
Rate Limits
Rate limits should be attached to each API key and returned through response headers.
Rate-limit headers
X-RateLimit-Limit: 1000 X-RateLimit-Remaining: 742 X-RateLimit-Reset: 1784563200
Planned API Plans
Example commercial structure for future AuditFarm API access.
Free
$0
- 100 requests per month
- Public wallet data
- Basic report verification
- Community support
Developer
$29/mo
- 25,000 requests per month
- Token security endpoints
- Report and wallet data
- Email support
Enterprise
Custom
- Higher rate limits
- Dedicated API keys
- Custom integrations
- Priority support and SLA
Pricing notice: These prices are placeholders for page design and are not a public commercial offer.
Advertisement Space — API Infrastructure Partner