FraudifyHomeFAQBadgesAPIDashboard
Open a ticket on Discord to request a key
API Reference

API Reference

Programmatic access to profiles, users, and invites. All endpoints require an API key.

Open a Discord ticket to request a keyGo to Dashboard
Authentication

All API endpoints require a valid API key. To get one, open a ticket on our Discord server and request API access. Send your key in one of the two supported header formats:

http
x-api-key: fraudify_live_...

# or equivalently

Authorization: Bearer fraudify_live_...
Key types
  • User-linked keys — scoped to your account. Required for endpoints that return personal data (e.g. /api/v1/invites).
  • Environment keys — server-to-server keys set via API_KEY env var. Accepted by read-only endpoints, but rejected by user-scoped ones.
Endpoints
GET/api/v1/profile/:username

Returns public profile data including display name, bio, avatar, banner, publish status, view count, and all profile blocks.

Request
curl
curl https://fraudify.me/api/v1/profile/johndoe \
  -H "x-api-key: fraudify_live_..."
Response · 200 OK
json
{
  "ok": true,
  "profile": {
    "username": "johndoe",
    "displayName": "John Doe",
    "bio": "hello world",
    "avatarPath": "/uploads/abc.jpg",
    "bannerPath": null,
    "isPublished": true,
    "viewCount": 1234,
    "blocks": [{ "type": "LINK_BUTTON", "data": {} }]
  }
}
GET/api/v1/profile/:username/views

Returns the profile's total view count as a lightweight alternative to fetching the full profile.

Request
curl
curl https://fraudify.me/api/v1/profile/johndoe/views \
  -H "x-api-key: fraudify_live_..."
Response · 200 OK
json
{
  "ok": true,
  "username": "johndoe",
  "views": 1234
}
GET/api/v1/user/:username

Returns the user's role, suspension status, and earned badges.

Request
curl
curl https://fraudify.me/api/v1/user/johndoe \
  -H "x-api-key: fraudify_live_..."
Response · 200 OK
json
{
  "ok": true,
  "username": "johndoe",
  "displayName": "John Doe",
  "role": "USER",
  "isSuspended": false,
  "badges": []
}
GET/api/v1/invites

Returns all active, unexpired invites created by the API key owner. Only returns invites belonging to the authenticated user.

Requires a user-linked API key — environment keys are not accepted.
Request
curl
curl https://fraudify.me/api/v1/invites \
  -H "x-api-key: fraudify_live_..."
Response · 200 OK
json
{
  "ok": true,
  "invites": [
    {
      "code": "ABC123",
      "uses": 0,
      "maxUses": 1,
      "active": true,
      "expiresAt": null,
      "note": "for ismet"
    }
  ]
}
Error Reference
Status
Error code
Meaning
401
unauthorized
Missing or invalid API key
403
forbidden
Endpoint requires a user-linked key
404
not_found
Profile or user not found
Rate Limits

Rate limits are enforced per API key. Exceeding the limit will result in a 429 Too Many Requests response.

Tip: Cache responses on your end where possible — profile and user data do not change frequently. This reduces latency and keeps you well within limits.