API Docs

• HTTPS only — Enforced by HSTS. No HTTP fallback.
• User-Agent required — All requests must include a descriptive header: YourAppName/1.0 ([email protected]). Empty or generic defaults are blocked by the WAF.
• Rate limited — Hitting the limit returns 429. Use exponential backoff. Persistent abuse results in a 48-hour IP block.
• WAF active — Cloudflare Managed Ruleset, OWASP Core Ruleset, and API Shield schema validation run on all requests. Requests with missing or invalid parameters are blocked at the edge before reaching the origin. Always check Content-Type before parsing — challenge pages return HTML, not JSON.
• Schema validated — All endpoints are protected by Cloudflare API Shield. Required parameters are enforced at the edge — missing steamId or malformed payloads return error code 1020 before hitting the origin.

Parameters

{
  "steamId": "76561198012345678",
  "profile": {
    "personaname": "PlayerName",
    "profileurl": "https://steamcommunity.com/profiles/76561198012345678",
    "avatarfull": "https://avatars.steamstatic.com/...",
    "timecreated": 1234567890
  },
  "bans": {
    "CommunityBanned": false,
    "VACBanned": true,
    "NumberOfVACBans": 1,
    "DaysSinceLastBan": 365,
    "NumberOfGameBans": 0,
    "EconomyBan": "none"
  },
  "rustHours": 1234.5,
  "friendsPrivate": false
}

Fields

Status codes