Loading
Loading
Ocean provides a RESTful API for programmatic access to scan data, user information, risk scores, and detection systems. All endpoints use API keys for authentication and are rate-limited to 1,000 requests per hour.
The Ocean API is only available for users with an active license or enterprise membership. Free users cannot create or use API keys.
The only exception is /v1/version, which is public and needs no API key.
Base URL: https://api.anticheat.ac/v1
Authentication: Pass your API key via the x-api-key header
Optional: Send x-server-name to label which of your servers made the call
/v1/scanned-users/lookup/:discordIdQuery complete scan history, detections, ban/warn status, and related accounts for a Discord user
Permission:scanned-users:lookup/v1/users/:discordId/risk-scoreGet calculated risk score and level for a Discord user
Permission:user:risk-score/v1/pins/:pinCode/resultsRetrieve scan results for your own pins programmatically
Permission:pins:results/v1/pins/:pinCode/statusGet real-time scan progress, status percentage, and result summary for your pins
Permission:pins:status/v1/pins/createCreate scan pins programmatically via API. Enterprise owners only.
Permission:pins:create (Enterprise Owner)/v1/db/query/:discordIdSearch the cheater database by Discord ID: community profile, network lookup, and Ocean scan matches
Permission:db:query (DB Access)/v1/versionRead the currently active Ocean client version. Ideal for a version checker
Permission: none, this endpoint is publicUsage Logging
Every authenticated API call is recorded: which key was used, which endpoint it hit, the calling IP, and the optional x-server-name header. Logs are kept for 90 days and are used to spot key sharing and abuse. They never contain the full API key, only its first 12 characters.
If one key serves several servers, send a distinct x-server-name from each one. It is the fastest way to show which server made a given call.
Rate Limiting
All API endpoints share a global rate limit of 1,000 requests per hour per API key. Rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) are included in every response.