Extension API Overview
The Extension API provides endpoints specifically designed for interaction between the OnlyAutomator Chrome Extension and the backend services. These APIs facilitate account connection, real-time data synchronization, CRM features within the OnlyFans interface, and access control based on user plans.Base URL
Most Extension API v2 endpoints use the/api/v2 prefix relative to the main base URL:
- Production:
https://onlyautomator.com/api/v2 - Local Development:
http://localhost:3000/api/v2
/api/ prefix.
Authentication
All Extension API endpoints require authentication using a JWT Bearer Token. This token is obtained upon user login to OnlyAutomator and must be included in theAuthorization header for every request:
API Endpoints
Core Extension API (v2 Prefix)
| Method | Endpoint Path (relative to Base URL) | Description |
|---|---|---|
| POST | /account-connect | Connects an OnlyFans account using session data from extension. |
| GET | /get-account | Retrieves connected OnlyFans account info and status. |
| GET | /get-profile | Gets detailed OnlyFans profile metrics for the connected account. |
| GET | /account/allowed-features | Determines features available based on the user’s subscription plan. |
| POST | /update-note | Creates or updates a CRM note for a subscriber (fan). |
| POST | /update-of-note | Synchronizes a note captured directly from OnlyFans to the CRM. |
| POST | /update-preference | Updates or creates specific preference data for a subscriber. |
| POST | /sync-notes | Synchronizes all notes for a subscriber between extension/backend. |
| POST | /update-country | Updates the detected or manually set country for a subscriber. |
| GET | /get-ppv-statistics | Retrieves performance statistics for sent PPV messages. |
| GET | /get-preferences | Gets all stored preferences for a specific subscriber. |
| GET | /get-transactions | Retrieves the transaction history for a specific subscriber. |
Related Management APIs (Root /api/ Prefix)
These endpoints are also used by the extension but reside under the main /api/ path.
| Method | Endpoint Path (relative to https://onlyautomator.com) | Description |
|---|---|---|
| GET | /api/fan/get | Gets details for a specific fan by OnlyFans ID. |
| GET | /api/get-emojis | Gets the user’s custom emoji configuration. |
| POST | /api/create-emoji | Creates or updates the user’s custom emoji config. |
| GET | /api/get-scripts | Gets all automation scripts belonging to the user. |
| POST | /api/create-script | Creates a new automation script for the user. |
Response Format
API responses are JSON and follow the standard format outlined in the main API Overview.- Success: Typically returns
2xxstatus with"success": trueor"status": "success"and adataobject. - Error: Returns
4xxor5xxstatus with"success": falseor"status": "error"and anerrorobject containingcodeandmessage, conforming to theErrorResponseschema.
Error Codes
Common error codes include:| Code | Description |
|---|---|
authentication_required | Missing or invalid JWT token. |
permission_denied | Token valid, but lacks permissions for the action. |
resource_not_found | The requested resource (e.g., account, fan) was not found. |
validation_error | Input data failed validation checks. |
rate_limit_exceeded | Too many requests from the user/token. |
service_unavailable | A downstream service or the server is unavailable. |
CORS
The API endpoints support Cross-Origin Resource Sharing (CORS) required for the extension to function:chrome-extension://[YOUR_EXTENSION_ID](Replace with your actual extension ID)https://onlyfans.comhttps://onlyautomator.comhttp://localhost:3000(For local development)