Chastity Tracker API Documentation: User data

🔐 Authentication

All API requests must be authenticated via https using a bearer token.

Generating a Token

• Users can generate a secure API token from their profile page.
• Tokens are shown only once and must be stored securely.
• Only hashed versions are stored on the server.

Usage

URL

https://www.chastitytracker.org

HEADER

GET /api/userstats.php HTTP/2
Host: www.chastitytracker.org
Authorization: Bearer {YOUR_API_TOKEN}


📌 Endpoint: GET /api/userstats.php

Returns json formatted public profile data for the user associated with the token.

Response Example

{
  "nick":"alescan",
  "profile_url":"localhost\/pprofile.php?user=alescan",
  "locked":true,
  "current_lock_start":"2025-03-23 09:00:00 UTC",
  "scheduled_end":null,
  "current_lock_time":"1 months 18 days 10 hours",
  "total_locked_since":"4 months 10 days 9 hours",
  "since_date":"2025-01-01 00:00:00",
  "link_game":null,
  "last_full":"2025-03-23",
  "last_ruined":"2025-02-09",
  "last_ted":"2025-04-06",
  "last_milking":null
}

Possible Fields

• username: Public-facing username
• profile_url: url of public profile (if available)
• locked: true or false
• current_lock_start: UTC start date of current lock period (if available)
• scheduled_end: UTC date of current unlock schedule (if available)
• current_lock_time: Human-readable duration of current locked time
• total_locked_since: Human-readable duration of locked time since (see next row)
• since_date: Date since the total_locked_since is calculated (if available)
• link_game: link to (if available)
• last_full: Date of last full orgasm (if available)
• last_ruined: Date of last ruined orgasm (if available)
• last_ted: Date of last t&d (if available)
• last_milking: Date of last milking (if available)

Errors

{
  "error": {One of the following}
}

Status Codes

• 200 OK — Data returned successfully
• 301 Moved Permanently — Not using https
• 401 Unauthorized — Invalid authorization
• 403 Forbidden — Missing authorization
• 400 Bad Request — Missing required parameters

⚠️ Security Notes

• Tokens must be stored securely by third parties.
• Users can revoke or regenerate tokens at any time.
• Never share a user’s token or sensitive info.

📅 Changelog

• 2025-05-09: Initial public API version released
• 2025-06-06: Removed "Connection: close" requirement and updated returned status codes

To go back to documentation index click here.