{ "document": { "title": "MissXss API AI Reference", "language": "en", "generated_at": "2026-06-14T00:18:40+03:00", "purpose": "This document is generated so AI tools can understand MissXss API endpoints, parameters, scope requirements, and request/response examples." }, "authentication": { "scheme": "Bearer", "header": "Authorization: Bearer YOUR_API_KEY", "notes": [ "API keys are created from the API Key Management page.", "Each API key only works for its selected scopes." ] }, "base_url": "https://api.missxss.com.tr", "request_format": { "method": "POST", "content_type": "application/json", "body": "Send endpoint parameters as a JSON body." }, "available_scopes": [], "endpoint_count": 62, "groups": [ { "key": "chat", "name": "Chat & Messaging", "endpoints": [ { "scope": "send-message", "scope_label": "Send Message (As Broadcaster)", "name": "Send Message (As Broadcaster)", "description": "Sends a chat message as the broadcaster account. The message appears under your own name.", "method": "POST", "url": "https://api.missxss.com.tr/v1/send-message", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "message", "type": "string", "required": true, "description": "Message text to send (1-500 characters)" }, { "name": "platform", "type": "string", "required": false, "description": "Target platform: Kick or Twitch (default: Kick)" } ], "example_request_body": { "message": "Hello Chat!" }, "example_success_response": { "success": true, "message_id": "abc123" }, "rate_limit_per_minute": 90 }, { "scope": "send-bot-message", "scope_label": "Send Message (As Bot)", "name": "Send Message (As Bot)", "description": "Sends a chat message via the MissXss bot account. The message appears under the bot name.", "method": "POST", "url": "https://api.missxss.com.tr/v1/send-bot-message", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "message", "type": "string", "required": true, "description": "Message text to send (1-500 characters)" }, { "name": "platform", "type": "string", "required": false, "description": "Target platform: Kick or Twitch (default: Kick)" } ], "example_request_body": { "message": "This is a bot message!" }, "example_success_response": { "success": true, "message_id": "def456" }, "rate_limit_per_minute": 90 }, { "scope": "tts", "scope_label": "Send TTS Message", "name": "Send TTS Message", "description": "Reads a text-to-speech message on stream. The overlay must be connected. A per-minute rate limit applies.", "method": "POST", "url": "https://api.missxss.com.tr/v1/tts", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "text", "type": "string", "required": true, "description": "Text to speak (1-500 characters)" }, { "name": "username", "type": "string", "required": false, "description": "Display username shown on screen (default: \"API\")" } ], "example_request_body": { "text": "Hello Stream!", "username": "Bot" }, "example_success_response": { "success": true, "ttsId": "a1b2c3d4..." }, "rate_limit_per_minute": 20 } ] }, { "key": "stream", "name": "Stream Controls", "endpoints": [ { "scope": "clip", "scope_label": "Create Clip", "name": "Create Clip", "description": "Creates a clip from the current live stream. Works via extension connection on Kick and API on Twitch. Stream must be live.", "method": "POST", "url": "https://api.missxss.com.tr/v1/clip", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "title", "type": "string", "required": false, "description": "Clip title (default: \"Clip - MissXss API\")" }, { "name": "duration", "type": "integer", "required": false, "description": "Clip duration (5-180 seconds, default: 30)" } ], "example_request_body": { "title": "Epic moment!", "duration": 45 }, "example_success_response": { "success": true }, "rate_limit_per_minute": 20 }, { "scope": "game", "scope_label": "Change Game / Category", "name": "Change Game / Category", "description": "Changes the stream category. Both Kick and Twitch are updated simultaneously. You can send a game name or Kick category ID; if both are sent, ID takes priority.", "method": "POST", "url": "https://api.missxss.com.tr/v1/game", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "game", "type": "string", "required": false, "description": "Game/category name (e.g. \"Valorant\"). Required if kick_category_id is not sent." }, { "name": "kick_category_id", "type": "integer", "required": false, "description": "Kick category ID. Sending the ID directly is faster if known." } ], "example_request_body": { "game": "Valorant" }, "example_success_response": { "success": true, "game": "VALORANT" }, "rate_limit_per_minute": 20 }, { "scope": "search-games", "scope_label": "Smart Game / Category Search", "name": "Smart Game / Category Search", "description": "Performs a smart search in the game database. Exact name match, slug match, starts-with match, word containment and spelling similarity are scored together; closest games are returned based on similarity ratio.", "method": "POST", "url": "https://api.missxss.com.tr/v1/search-games", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "query", "type": "string", "required": true, "description": "Game/category name to search (2-100 chars). game or search is also accepted." }, { "name": "limit", "type": "integer", "required": false, "description": "Maximum row count to return (1-50, default: 10)" }, { "name": "min_similarity", "type": "number", "required": false, "description": "Minimum similarity score (0-100, default: 25)" } ], "example_request_body": { "query": "banana", "limit": 10 }, "example_success_response": { "success": true, "query": "banana", "total": 3, "best_match": { "kick_category_id": 123, "name": "Banana", "slug": "banana", "score": 100, "match_type": "exact_name" }, "games": [ { "kick_category_id": 123, "name": "Banana", "slug": "banana", "score": 100, "match_type": "exact_name" } ] }, "rate_limit_per_minute": 40 }, { "scope": "title", "scope_label": "Change Stream Title", "name": "Change Stream Title", "description": "Changes the stream title. Both Kick and Twitch are updated simultaneously.", "method": "POST", "url": "https://api.missxss.com.tr/v1/title", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "title", "type": "string", "required": true, "description": "New stream title (1-140 characters)" } ], "example_request_body": { "title": "New stream title!" }, "example_success_response": { "success": true }, "rate_limit_per_minute": 20 }, { "scope": "get-stream-meta", "scope_label": "Get Stream Meta", "name": "Get Stream Meta", "description": "Returns stream metadata via POST method, including viewer_count and followers_count.", "method": "POST", "url": "https://api.missxss.com.tr/v1/get-stream-meta", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "platform", "type": "string", "required": false, "description": "Kick or Twitch (default: Kick)" } ], "example_request_body": {}, "example_success_response": { "success": true, "platform": "Kick", "channel": "kanaladi", "title": "Live Stream", "category": "Just Chatting", "category_id": "123", "viewer_count": 245, "followers_count": 19234, "is_live_any": 1, "is_live_kick": 1, "is_live_twitch": 0, "kick_last_connection ": "2026-04-18" }, "rate_limit_per_minute": 120 }, { "scope": "set-stream-meta", "scope_label": "Set Stream Meta", "name": "Set Stream Meta", "description": "Updates title and/or game metadata in one request. At least one of title, game or kick_category_id must be provided.", "method": "POST", "url": "https://api.missxss.com.tr/v1/set-stream-meta", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "title", "type": "string", "required": false, "description": "New stream title (1-140 characters)" }, { "name": "game", "type": "string", "required": false, "description": "Game/category name" }, { "name": "kick_category_id", "type": "integer", "required": false, "description": "Direct Kick category ID" }, { "name": "platform", "type": "string", "required": false, "description": "Kick or Twitch (default: Kick)" } ], "example_request_body": { "title": "New Title", "game": "Valorant" }, "example_success_response": { "success": true, "title_updated": true, "game_updated": true, "title": "New Title", "category": "VALORANT", "viewer_count": 245, "followers_count": 19234 }, "rate_limit_per_minute": 30 } ] }, { "key": "alerts", "name": "Alerts & Events", "endpoints": [ { "scope": "trigger-audio-alert", "scope_label": "Trigger Audio Alert", "name": "Trigger Audio Alert", "description": "Triggers an active audio alert by ID or name. Overlay connection is required.", "method": "POST", "url": "https://api.missxss.com.tr/v1/trigger-audio-alert", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "id", "type": "integer", "required": false, "description": "Audio alert ID (id or name is required)" }, { "name": "name", "type": "string", "required": false, "description": "Audio alert name (id or name is required)" }, { "name": "username", "type": "string", "required": false, "description": "Username to display on alert (default: API)" } ], "example_request_body": { "id": 849, "name": "airhorn", "username": "api_bot" }, "example_success_response": { "success": true, "id": 12, "alert_id": "A12", "name": "airhorn" }, "rate_limit_per_minute": 60 }, { "scope": "list-audio-alerts", "scope_label": "List Audio Alerts", "name": "List Audio Alerts", "description": "Lists audio alert records with ID, name and points.", "method": "POST", "url": "https://api.missxss.com.tr/v1/list-audio-alerts", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "status", "type": "string", "required": false, "description": "Filter: all | active | inactive (default: all)" }, { "name": "limit", "type": "integer", "required": false, "description": "Row count (1-200, default: 50)" }, { "name": "offset", "type": "integer", "required": false, "description": "Start offset (default: 0)" } ], "example_request_body": { "status": "active", "limit": 20, "offset": 0 }, "example_success_response": { "success": true, "total": 2, "limit": 20, "offset": 0, "alerts": [ { "id": 14, "name": "airhorn", "points": 500, "status": "active" } ] }, "rate_limit_per_minute": 90 }, { "scope": "send-donation", "scope_label": "Send Donation Simulation", "name": "Send Donation Simulation", "description": "Simulates donation flow for BynoGame, StreamElements, StreamLabs or Ko-fi, writes event log and triggers donation alert.", "method": "POST", "url": "https://api.missxss.com.tr/v1/send-donation", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "provider", "type": "string", "required": true, "description": "BynoGame | StreamElements | StreamLabs | Ko-fi" }, { "name": "amount", "type": "number", "required": true, "description": "Donation amount (positive)" }, { "name": "currency", "type": "string", "required": true, "description": "Currency Format ($ € ₺ ex.)" }, { "name": "username", "type": "string", "required": false, "description": "Donor username (default: api_donor)" }, { "name": "displayname", "type": "string", "required": false, "description": "Donor display name" }, { "name": "message", "type": "string", "required": false, "description": "Donation message" }, { "name": "userid", "type": "string", "required": false, "description": "Donor user ID (optional)" }, { "name": "platform", "type": "string", "required": false, "description": "Kick or Twitch (default: Kick)" } ], "example_request_body": { "provider": "StreamLabs", "amount": 50, "currency": "₺", "username": "viewer123", "displayname": "Viewer123", "message": "GG!" }, "example_success_response": "{\"success\": true, \"provider\": \"StreamLabs\", \"amount\": 50, \"currency\" => \"₺\", \"username\": \"viewer123\", \"displayname\": \"Viewer123\", \"message\": \"GG!\"}", "rate_limit_per_minute": 90 }, { "scope": "get-recent-activity", "scope_label": "Get Recent Activity", "name": "Get Recent Activity", "description": "Returns latest followers, subscribers, banned users, donors, Kick bits and Twitch bits in a single request.", "method": "POST", "url": "https://api.missxss.com.tr/v1/get-recent-activity", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "limit", "type": "integer", "required": false, "description": "Row count per list (1-20, default: 5)" } ], "example_request_body": { "limit": 5 }, "example_success_response": { "success": true, "limit": 5, "latest_followers": [], "latest_subscribers": [], "latest_banned": [], "latest_donors": [], "latest_kick_bits": [], "latest_twitch_bits": [] }, "rate_limit_per_minute": 60 } ] }, { "key": "effects", "name": "Effects", "endpoints": [ { "scope": "effect-trigger", "scope_label": "Trigger Effect", "name": "Trigger Effect", "description": "Triggers a trigger-enabled effect overlay through the API. The overlay receives action, overlay_id, effect_type, effect_settings and data; options is not sent. If data is omitted, only data.userstate is included by default.", "method": "POST", "url": "https://api.missxss.com.tr/v1/effect-trigger", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "overlay_id", "type": "string", "required": false, "description": "Effect overlay ID to trigger (overlay_id or overlay_ids is required)" }, { "name": "overlay_ids", "type": "array", "required": false, "description": "List of overlay IDs for bulk triggering (maximum 20)" }, { "name": "platform", "type": "string", "required": false, "description": "Default userstate platform: Kick, Twitch, YouTube or TikTok (default: Kick)" }, { "name": "data", "type": "object", "required": false, "description": "Custom JSON object passed to effect code. If omitted, only userstate is added; if provided, your fields are available under payload.data together with userstate." } ], "example_request_body": { "overlay_id": "effect_overlay_1", "data": { "message": "API trigger", "amount": 100, "userstate": { "username": "api_user", "displayname": "API User", "platform": "Kick" } } }, "example_success_response": { "success": true, "triggered": 1, "total": 1, "results": [ { "overlay_id": "effect_overlay_1", "success": true, "error": null } ], "data_keys": [ "message", "amount", "userstate" ] }, "rate_limit_per_minute": 120 } ] }, { "key": "community", "name": "Community Data", "endpoints": [ { "scope": "get-kick-subscribers", "scope_label": "List Kick Subscribers", "name": "List Kick Subscribers", "description": "Lists subscribers from kick_subscribers table. Returns only non-expired subscribers by default.", "method": "POST", "url": "https://api.missxss.com.tr/v1/get-kick-subscribers", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "include_expired", "type": "boolean|string", "required": false, "description": "Include expired subscribers when set to 1/true" }, { "name": "limit", "type": "integer", "required": false, "description": "Row count (1-200, default: 50)" }, { "name": "offset", "type": "integer", "required": false, "description": "Start offset (default: 0)" } ], "example_request_body": { "include_expired": 0, "limit": 20, "offset": 0 }, "example_success_response": { "success": true, "total": 12, "limit": 20, "offset": 0, "include_expired": 0, "subscribers": [ { "id": 1, "kick_user_id": "123", "kick_username": "viewer", "kick_displayname": "Viewer", "subscription_type": "self", "tier": 1 } ] }, "rate_limit_per_minute": 60 } ] }, { "key": "music", "name": "Music & Song Request", "endpoints": [ { "scope": "start-song", "scope_label": "Start / Resume Song", "name": "Start / Resume Song", "description": "Resumes a paused song or starts playback.", "method": "POST", "url": "https://api.missxss.com.tr/v1/start-song", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [], "example_request_body": {}, "example_success_response": { "success": true }, "rate_limit_per_minute": 30 }, { "scope": "stop-song", "scope_label": "Pause Song", "name": "Pause Song", "description": "Pauses the currently playing song.", "method": "POST", "url": "https://api.missxss.com.tr/v1/stop-song", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [], "example_request_body": {}, "example_success_response": { "success": true }, "rate_limit_per_minute": 30 }, { "scope": "skip-song", "scope_label": "Skip Song", "name": "Skip Song", "description": "Skips the current song and plays the next one in queue.", "method": "POST", "url": "https://api.missxss.com.tr/v1/skip-song", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [], "example_request_body": {}, "example_success_response": { "success": true }, "rate_limit_per_minute": 30 } ] }, { "key": "points", "name": "Points & Economy", "endpoints": [ { "scope": "add-points", "scope_label": "Add Points", "name": "Add Points", "description": "Adds points to target user. Resolves user by userid (Kick ID) first, then falls back to username.", "method": "POST", "url": "https://api.missxss.com.tr/v1/add-points", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "userid", "type": "string", "required": false, "description": "Target user ID" }, { "name": "username", "type": "string", "required": false, "description": "Target username (without @). Used as fallback if userid is not found." }, { "name": "amount", "type": "number", "required": true, "description": "Points amount to add (1 - 99,999,999)" }, { "name": "platform", "type": "string", "required": true, "description": "Required platform: Kick, Twitch, YouTube or TikTok" } ], "example_request_body": { "platform": "Kick", "userid": "123456", "username": "viewer123", "amount": 100 }, "example_success_response": { "success": true }, "rate_limit_per_minute": 90 }, { "scope": "remove-points", "scope_label": "Remove Points", "name": "Remove Points", "description": "Removes points from target user. Resolves by userid (Kick ID) first, then username fallback.", "method": "POST", "url": "https://api.missxss.com.tr/v1/remove-points", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "userid", "type": "string", "required": false, "description": "Target user ID" }, { "name": "username", "type": "string", "required": false, "description": "Target username (without @). Used as fallback if userid is not found." }, { "name": "amount", "type": "number", "required": true, "description": "Points amount to remove (1 - 99,999,999)" }, { "name": "platform", "type": "string", "required": true, "description": "Required platform: Kick, Twitch, YouTube or TikTok" } ], "example_request_body": { "platform": "Kick", "userid": "123456", "username": "viewer123", "amount": 50 }, "example_success_response": { "success": true }, "rate_limit_per_minute": 90 }, { "scope": "get-points", "scope_label": "Get User Points", "name": "Get User Points", "description": "Returns points/coin/message count for a user. Resolves by userid (Kick ID) first, then username fallback.", "method": "POST", "url": "https://api.missxss.com.tr/v1/get-points", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "userid", "type": "string", "required": false, "description": "Target user ID" }, { "name": "username", "type": "string", "required": false, "description": "Username (without @). Used as fallback if userid is not found." }, { "name": "platform", "type": "string", "required": true, "description": "Required platform: Kick, Twitch, YouTube or TikTok" } ], "example_request_body": { "platform": "Kick", "userid": "123456", "username": "viewer123" }, "example_success_response": { "success": true, "platform": "Kick", "user_id": "123", "username": "viewer123", "displayname": "Viewer123", "points": 500, "coin": 25, "message_count": 18 }, "rate_limit_per_minute": 120 }, { "scope": "get-points-top", "scope_label": "Get Points Top", "name": "Get Points Top", "description": "Returns points leaderboard (supports limit/offset).", "method": "POST", "url": "https://api.missxss.com.tr/v1/get-points-top", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "limit", "type": "integer", "required": false, "description": "Row count (1-100, default: 20)" }, { "name": "offset", "type": "integer", "required": false, "description": "Start offset (default: 0)" }, { "name": "platform", "type": "string", "required": true, "description": "Required platform: Kick, Twitch, YouTube or TikTok" } ], "example_request_body": { "platform": "Kick", "limit": 10, "offset": 0 }, "example_success_response": { "success": true, "platform": "Kick", "limit": 10, "offset": 0, "total": 1200, "users": [ { "rank": 1, "username": "topuser", "points": 99999 } ] }, "rate_limit_per_minute": 90 }, { "scope": "set-points", "scope_label": "Set Points Directly", "name": "Set Points Directly", "description": "Sets user points to an exact value. Resolves by userid (Kick ID) first, then username fallback.", "method": "POST", "url": "https://api.missxss.com.tr/v1/set-points", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "userid", "type": "string", "required": false, "description": "Target user ID" }, { "name": "username", "type": "string", "required": false, "description": "Username (without @). Used as fallback if userid is not found." }, { "name": "amount", "type": "integer", "required": true, "description": "New points value (0 - 99,999,999)" }, { "name": "platform", "type": "string", "required": true, "description": "Required platform: Kick, Twitch, YouTube or TikTok" } ], "example_request_body": { "platform": "Kick", "userid": "123456", "username": "viewer123", "amount": 2500 }, "example_success_response": { "success": true, "platform": "Kick", "username": "viewer123", "old_points": 1200, "points": 2500, "changed": 1300 }, "rate_limit_per_minute": 90 }, { "scope": "transfer-points", "scope_label": "Transfer Points", "name": "Transfer Points", "description": "Transfers points from one user to another. For sender/receiver, userid is checked first, then username fallback.", "method": "POST", "url": "https://api.missxss.com.tr/v1/transfer-points", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "from_userid", "type": "string", "required": false, "description": "Sender user ID" }, { "name": "from_username", "type": "string", "required": false, "description": "Sender username (without @), fallback" }, { "name": "to_userid", "type": "string", "required": false, "description": "Receiver user ID" }, { "name": "to_username", "type": "string", "required": false, "description": "Receiver username (without @), fallback" }, { "name": "amount", "type": "integer", "required": true, "description": "Transfer amount (1 - 99,999,999)" }, { "name": "platform", "type": "string", "required": true, "description": "Required platform: Kick, Twitch, YouTube or TikTok" } ], "example_request_body": { "platform": "Kick", "from_userid": "111", "from_username": "alice", "to_userid": "222", "to_username": "bob", "amount": 100 }, "example_success_response": { "success": true, "platform": "Kick", "from_username": "alice", "from_user_id": "111", "to_username": "bob", "to_user_id": "222", "amount": 100 }, "rate_limit_per_minute": 90 } ] }, { "key": "watchtime", "name": "Watch Time", "endpoints": [ { "scope": "adjust-watch-time", "scope_label": "Adjust Watch Time", "name": "Adjust Watch Time", "description": "Adjusts watch time with add/remove/set modes. amount is in minutes. If day is omitted, an old fallback date is used to increase total stats without affecting current day.", "method": "POST", "url": "https://api.missxss.com.tr/v1/adjust-watch-time", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "userid", "type": "string", "required": false, "description": "Target user ID" }, { "name": "username", "type": "string", "required": false, "description": "Target username (without @). Used as fallback if userid is not found." }, { "name": "mode", "type": "string", "required": true, "description": "Operation mode: add | remove | set" }, { "name": "amount", "type": "integer", "required": true, "description": "Amount in minutes. min 1 for add/remove, min 0 for set (maximum 99,999,999 minutes)" }, { "name": "day", "type": "string", "required": false, "description": "Target day (YYYY-MM-DD). Fallback date is used when omitted." }, { "name": "platform", "type": "string", "required": true, "description": "Required platform: Kick, Twitch, YouTube or TikTok" } ], "example_request_body": { "platform": "Kick", "userid": "123456", "mode": "add", "amount": 30, "day": "2026-04-17" }, "example_success_response": { "success": true, "platform": "Kick", "user_id": "123456", "username": "viewer123", "displayname": "Viewer123", "mode": "add", "amount": 30, "amount_unit": "minute", "day": "2026-04-17", "used_fallback_day": 0, "watch_time": 245, "watch_time_unit": "minute" }, "rate_limit_per_minute": 60 }, { "scope": "get-watch-time", "scope_label": "Get Watch Time", "name": "Get Watch Time", "description": "Returns watch time and message count for a single user. Use day for one day, date_from/date_to for range, and omit date fields for all-time query.", "method": "POST", "url": "https://api.missxss.com.tr/v1/get-watch-time", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "userid", "type": "string", "required": false, "description": "Target user ID" }, { "name": "username", "type": "string", "required": false, "description": "Target username (without @). Used as fallback if userid is not found." }, { "name": "day", "type": "string", "required": false, "description": "Single day filter (YYYY-MM-DD)" }, { "name": "date_from", "type": "string", "required": false, "description": "Range start date (YYYY-MM-DD), must be sent with date_to" }, { "name": "date_to", "type": "string", "required": false, "description": "Range end date (YYYY-MM-DD), must be sent with date_from" }, { "name": "platform", "type": "string", "required": true, "description": "Required platform: Kick, Twitch, YouTube or TikTok" } ], "example_request_body": { "platform": "Kick", "userid": "123456", "day": "2026-04-17" }, "example_success_response": { "success": true, "platform": "Kick", "user_id": "123456", "username": "viewer123", "displayname": "Viewer123", "query_mode": "day", "day": "2026-04-17", "date_from": null, "date_to": null, "watch_time": 245, "watch_time_unit": "minute", "message_count": 18 }, "rate_limit_per_minute": 120 }, { "scope": "get-watch-time-top", "scope_label": "Get Watch Time Top", "name": "Get Watch Time Top", "description": "Returns user leaderboard ordered by watch time. Supports filtering by day or date_from/date_to range.", "method": "POST", "url": "https://api.missxss.com.tr/v1/get-watch-time-top", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "limit", "type": "integer", "required": false, "description": "Row count (1-100, default: 20)" }, { "name": "offset", "type": "integer", "required": false, "description": "Start offset (default: 0)" }, { "name": "day", "type": "string", "required": false, "description": "Single day filter (YYYY-MM-DD)" }, { "name": "date_from", "type": "string", "required": false, "description": "Range start date (YYYY-MM-DD), must be sent with date_to" }, { "name": "date_to", "type": "string", "required": false, "description": "Range end date (YYYY-MM-DD), must be sent with date_from" }, { "name": "platform", "type": "string", "required": true, "description": "Required platform: Kick, Twitch, YouTube or TikTok" } ], "example_request_body": { "platform": "Kick", "day": "2026-04-17", "limit": 10, "offset": 0 }, "example_success_response": { "success": true, "platform": "Kick", "query_mode": "day", "day": "2026-04-17", "date_from": null, "date_to": null, "limit": 10, "offset": 0, "total": 152, "watch_time_unit": "minute", "users": [ { "rank": 1, "user_id": "123456", "username": "viewer123", "displayname": "Viewer123", "watch_time": 245, "message_count": 18 } ] }, "rate_limit_per_minute": 90 }, { "scope": "adjust-watch-time-bulk", "scope_label": "Adjust Watch Time Bulk", "name": "Adjust Watch Time Bulk", "description": "Adjusts watch time for multiple users in one request. amount is in minutes. You can set amount per user row; if omitted, request-level default amount is used.", "method": "POST", "url": "https://api.missxss.com.tr/v1/adjust-watch-time-bulk", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "mode", "type": "string", "required": true, "description": "Operation mode: add | remove | set" }, { "name": "day", "type": "string", "required": false, "description": "Target day (YYYY-MM-DD). Fallback date is used when omitted." }, { "name": "amount", "type": "integer", "required": false, "description": "Default amount in minutes. Used when users[].amount is missing." }, { "name": "users", "type": "array", "required": true, "description": "User list of 1-100 items. Each item must include userid or username and optional amount." }, { "name": "platform", "type": "string", "required": true, "description": "Required platform: Kick, Twitch, YouTube or TikTok" } ], "example_request_body": { "platform": "Kick", "mode": "add", "day": "2026-04-17", "users": [ { "userid": "123456", "amount": 30 }, { "username": "viewer2", "amount": 15 } ] }, "example_success_response": { "success": true, "partial": 0, "platform": "Kick", "mode": "add", "day": "2026-04-17", "used_fallback_day": 0, "amount_unit": "minute", "watch_time_unit": "minute", "total_requested": 2, "processed_count": 2, "failed_count": 0, "users": [ { "index": 0, "user_id": "123456", "username": "viewer123", "displayname": "Viewer123", "mode": "add", "amount": 30, "day": "2026-04-17", "watch_time": 245, "message_count": 18 } ], "failed": [] }, "rate_limit_per_minute": 20 } ] }, { "key": "commands", "name": "Command Management", "endpoints": [ { "scope": "run-command", "scope_label": "Run Command", "name": "Run Command", "description": "Runs a chat command you defined in the MissXss panel. Can be called by command name or command ID. The command response message is sent and its actions (timeout, ban, voicemod etc.) are automatically processed.", "method": "POST", "url": "https://api.missxss.com.tr/v1/run-command", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "command", "type": "string", "required": false, "description": "Command name (e.g. \"!hello\" or \"hello\"). command or id is required." }, { "name": "id", "type": "integer", "required": false, "description": "Command ID value. command or id is required." }, { "name": "message", "type": "string", "required": false, "description": "Additional message / arguments to append to the command" }, { "name": "username", "type": "string", "required": false, "description": "Username running the command (default: broadcaster name)" } ], "example_request_body": { "command": "!hello" }, "example_success_response": { "success": true, "id": 22029, "command": "!hello", "active": 1, "response": "Hello everyone!" }, "rate_limit_per_minute": 90 }, { "scope": "list-commands", "scope_label": "List Commands (Detailed)", "name": "List Commands (Detailed)", "description": "Returns all commands for the broadcaster with detailed fields and can be used to discover command IDs for run-command and toggle-command. Response fields: total=total command count; commands[]=command list; id=command ID; command=primary command name; aliases=alternative triggers; active=enabled flag (1/0); show_in_list=show in command list; cooldown_global_seconds=global cooldown; cooldown_user_seconds=user cooldown; message=command response text; permissions=allowed roles/permissions; denied_permissions=blocked roles/permissions; action_json=command action JSON; platform_kick/platform_twitch/platform_tiktok/platform_youtube=platform enable flags; auto_message_interval_minutes=auto-send interval in minutes; auto_message_min_chat_count=minimum chat messages before next auto-send; last_run_at=last run timestamp; last_global_run_at=last global run timestamp; last_user_run_data=per-user last run data; points_cost/coin_cost/delete_cost=command costs; only_game_ids=allowed category/game IDs; blocked_game_ids=blocked category/game IDs; last_auto_message_kick_at/last_auto_message_twitch_at=last auto-send timestamps by platform; raw=raw in-memory command object.", "method": "POST", "url": "https://api.missxss.com.tr/v1/list-commands", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [], "example_request_body": {}, "example_success_response": { "success": true, "total": 2, "commands": [ { "id": 22029, "command": "!hello", "aliases": [ "!hello", "hello" ], "active": 1, "show_in_list": 0, "cooldown_global_seconds": 0, "cooldown_user_seconds": 0, "message": "Hello!", "permissions": "", "denied_permissions": "", "action_json": "", "platform_kick": 1, "platform_twitch": 1, "platform_tiktok": 1, "platform_youtube": 1, "auto_message_interval_minutes": 0, "auto_message_min_chat_count": 0, "last_run_at": 0, "last_global_run_at": 0, "last_user_run_data": false, "points_cost": 0, "coin_cost": 0, "delete_cost": 0, "only_game_ids": "", "blocked_game_ids": "", "last_auto_message_kick_at": 0, "last_auto_message_twitch_at": 0, "raw": { "id": 22029 } } ] }, "rate_limit_per_minute": 90 }, { "scope": "toggle-command", "scope_label": "Toggle Command", "name": "Toggle Command", "description": "Enables, disables, or toggles a command by name or ID. mode value: on | off | toggle.", "method": "POST", "url": "https://api.missxss.com.tr/v1/toggle-command", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "command", "type": "string", "required": false, "description": "Command name. command or id is required." }, { "name": "id", "type": "integer", "required": false, "description": "Command ID value. command or id is required." }, { "name": "mode", "type": "string", "required": true, "description": "Mode: on | off | toggle" } ], "example_request_body": { "id": 22029, "mode": "off" }, "example_success_response": { "success": true, "id": 22029, "command": "!hello", "active": 0, "changed": true, "mode": "off" }, "rate_limit_per_minute": 60 }, { "scope": "create-command", "scope_label": "Create Command", "name": "Create Command", "description": "Creates a new command and adds it to command list.", "method": "POST", "url": "https://api.missxss.com.tr/v1/create-command", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "command", "type": "string", "required": true, "description": "Command name (max 50 chars)" }, { "name": "message", "type": "string", "required": true, "description": "Command response message" } ], "example_request_body": { "command": "!hi", "message": "Hello everyone!" }, "example_success_response": { "success": true, "id": 22035, "command": "!hi", "aliases": [ "!hi" ], "active": 1 }, "rate_limit_per_minute": 60 }, { "scope": "update-command", "scope_label": "Update Command", "name": "Update Command", "description": "Updates command message and/or aliases.", "method": "POST", "url": "https://api.missxss.com.tr/v1/update-command", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "command", "type": "string", "required": false, "description": "Command name (command or id required)" }, { "name": "id", "type": "integer", "required": false, "description": "Command ID (command or id required)" }, { "name": "message", "type": "string", "required": false, "description": "New command response" }, { "name": "aliases", "type": "string|array", "required": false, "description": "New aliases (comma string or array)" } ], "example_request_body": { "id": 22035, "message": "Hello there!" }, "example_success_response": { "success": true, "id": 22035, "command": "!hi", "aliases": [ "!hi", "!hello" ], "message": "Hello there!" }, "rate_limit_per_minute": 60 }, { "scope": "delete-command", "scope_label": "Delete Command", "name": "Delete Command", "description": "Deletes command by name or ID.", "method": "POST", "url": "https://api.missxss.com.tr/v1/delete-command", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "command", "type": "string", "required": false, "description": "Command name (command or id required)" }, { "name": "id", "type": "integer", "required": false, "description": "Command ID (command or id required)" } ], "example_request_body": { "id": 22035 }, "example_success_response": { "success": true, "deleted": true, "command": "selam", "id": 22035 }, "rate_limit_per_minute": 60 }, { "scope": "set-command-cooldown", "scope_label": "Set Command Cooldown", "name": "Set Command Cooldown", "description": "Sets global and user cooldown values for command.", "method": "POST", "url": "https://api.missxss.com.tr/v1/set-command-cooldown", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "command", "type": "string", "required": false, "description": "Command name (command or id required)" }, { "name": "id", "type": "integer", "required": false, "description": "Command ID (command or id required)" }, { "name": "cooldown_global_seconds", "type": "integer", "required": false, "description": "Global cooldown seconds (0-86400)" }, { "name": "cooldown_user_seconds", "type": "integer", "required": false, "description": "User cooldown seconds (0-86400)" } ], "example_request_body": { "id": 22029, "cooldown_global_seconds": 10, "cooldown_user_seconds": 30 }, "example_success_response": { "success": true, "id": 22029, "command": "hello", "cooldown_global_seconds": 10, "cooldown_user_seconds": 30 }, "rate_limit_per_minute": 60 }, { "scope": "set-command-platforms", "scope_label": "Set Command Platforms", "name": "Set Command Platforms", "description": "Updates command platform enable flags.", "method": "POST", "url": "https://api.missxss.com.tr/v1/set-command-platforms", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "command", "type": "string", "required": false, "description": "Command name (command or id required)" }, { "name": "id", "type": "integer", "required": false, "description": "Command ID (command or id required)" }, { "name": "platform_kick", "type": "boolean|integer", "required": false, "description": "Kick active flag (1/0)" }, { "name": "platform_twitch", "type": "boolean|integer", "required": false, "description": "Twitch active flag (1/0)" }, { "name": "platform_tiktok", "type": "boolean|integer", "required": false, "description": "TikTok active flag (1/0)" }, { "name": "platform_youtube", "type": "boolean|integer", "required": false, "description": "YouTube active flag (1/0)" } ], "example_request_body": { "id": 22029, "platform_kick": 1, "platform_twitch": 0, "platform_youtube": 1 }, "example_success_response": { "success": true, "id": 22029, "command": "hello", "platform_kick": 1, "platform_twitch": 0, "platform_tiktok": 1, "platform_youtube": 1 }, "rate_limit_per_minute": 60 } ] }, { "key": "ai", "name": "AI Bot", "endpoints": [ { "scope": "ai-bot", "scope_label": "Update AI Bot Settings", "name": "Update AI Bot Settings", "description": "Updates AI Bot settings independently. You can send any single field alone. Supports on/off/toggle for gemini_aktif and ai_sadeceAbone. If ai_text changes, conversation history is automatically cleared.", "method": "POST", "url": "https://api.missxss.com.tr/v1/ai-bot", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "gemini_aktif", "type": "string", "required": false, "description": "AI Bot state: on | off | toggle" }, { "name": "ai_sadeceAbone", "type": "string", "required": false, "description": "Subscriber-only mode: on | off | toggle" }, { "name": "ai_text", "type": "string", "required": false, "description": "AI Bot prompt text (max 12000 characters)" } ], "example_request_body": { "gemini_aktif": "on" }, "example_success_response": { "success": true, "gemini_aktif": 1, "ai_sadeceAbone": 0, "ai_text_updated": true, "clearai_triggered": false }, "rate_limit_per_minute": 20 }, { "scope": "clear-ai", "scope_label": "Clear AI Conversation History", "name": "Clear AI Conversation History", "description": "Clears AI conversation history. API equivalent of !clearai command.", "method": "POST", "url": "https://api.missxss.com.tr/v1/clear-ai", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [], "example_request_body": {}, "example_success_response": { "success": true, "cleared": true }, "rate_limit_per_minute": 10 } ] }, { "key": "mod", "name": "Moderation", "endpoints": [ { "scope": "timeout", "scope_label": "Timeout", "name": "Timeout", "description": "Times out a user for a specified duration. Duration is in minutes (maximum 525600 minutes = 1 year).", "method": "POST", "url": "https://api.missxss.com.tr/v1/timeout", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "username", "type": "string", "required": true, "description": "Username to timeout" }, { "name": "duration", "type": "integer", "required": false, "description": "Duration (minutes). Min: 1, Max: 525600. Default: 1" }, { "name": "reason", "type": "string", "required": false, "description": "Timeout reason (default: \"API Timeout\")" }, { "name": "platform", "type": "string", "required": false, "description": "Kick or Twitch (default: Kick)" } ], "example_request_body": { "username": "troll_user", "duration": 5, "reason": "Spamming" }, "example_success_response": { "success": true }, "rate_limit_per_minute": 200 }, { "scope": "ban", "scope_label": "Ban", "name": "Ban", "description": "Permanently bans a user. Use with caution.", "method": "POST", "url": "https://api.missxss.com.tr/v1/ban", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "username", "type": "string", "required": true, "description": "Username to ban" }, { "name": "userid", "type": "string", "required": false, "description": "User ID to ban. If sent with username, userid is used preferentially." }, { "name": "reason", "type": "string", "required": false, "description": "Ban reason (default: \"API Ban\")" }, { "name": "platform", "type": "string", "required": false, "description": "Kick or Twitch (default: Kick)" } ], "example_request_body": { "username": "bad_user", "reason": "Rule violation" }, "example_success_response": { "success": true }, "rate_limit_per_minute": 200 }, { "scope": "clear-chat", "scope_label": "Clear Chat", "name": "Clear Chat", "description": "Clears all chat messages.", "method": "POST", "url": "https://api.missxss.com.tr/v1/clear-chat", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [], "example_request_body": {}, "example_success_response": { "success": true }, "rate_limit_per_minute": 15 }, { "scope": "shield-mode", "scope_label": "Manage Shield Mode", "name": "Manage Shield Mode", "description": "Turns shield mode on, off, or toggles it. mode parameter: on, off, toggle.", "method": "POST", "url": "https://api.missxss.com.tr/v1/shield-mode", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "mode", "type": "string", "required": false, "description": "Operation mode: on | off | toggle (default: toggle)" }, { "name": "duration", "type": "integer", "required": false, "description": "Shield-ban lookback window in minutes (min: 0). Used only when enabling/toggle->on." } ], "example_request_body": { "mode": "on" }, "example_success_response": { "success": true, "shield_mode": 1, "changed": true, "mode": "on" }, "rate_limit_per_minute": 15 }, { "scope": "get-shield-mode-status", "scope_label": "Get Shield Mode Status", "name": "Get Shield Mode Status", "description": "Returns current shield mode configuration.", "method": "POST", "url": "https://api.missxss.com.tr/v1/get-shield-mode-status", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [], "example_request_body": {}, "example_success_response": { "success": true, "shield_mode": 1, "shield_ban_enabled": 1, "shield_lookback_minutes": 2 }, "rate_limit_per_minute": 90 }, { "scope": "set-moderation-feature", "scope_label": "Set Moderation Feature", "name": "Set Moderation Feature", "description": "Enables, disables, or toggles a specific moderation feature.", "method": "POST", "url": "https://api.missxss.com.tr/v1/set-moderation-feature", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "feature", "type": "string", "required": true, "description": "username_kontrol, spam_korumasi, link_korumasi, kufur_korumasi, caps_korumasi, flood_korumasi, coklu_hesap_spam, ziyaretci_kontrol" }, { "name": "mode", "type": "string", "required": true, "description": "on | off | toggle" } ], "example_request_body": { "feature": "spam_korumasi", "mode": "on" }, "example_success_response": { "success": true, "feature": "spam_korumasi", "enabled": 1, "changed": true, "mode": "on" }, "rate_limit_per_minute": 10 }, { "scope": "get-moderation-status", "scope_label": "Get Moderation Status", "name": "Get Moderation Status", "description": "Returns enabled/disabled state for moderation modules. If feature is provided, returns single module status.", "method": "POST", "url": "https://api.missxss.com.tr/v1/get-moderation-status", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "feature", "type": "string", "required": false, "description": "Optional single feature name" } ], "example_request_body": {}, "example_success_response": { "success": true, "status": { "username_kontrol": 1, "spam_korumasi": 1, "link_korumasi": 1, "kufur_korumasi": 1, "caps_korumasi": 1, "flood_korumasi": 1, "coklu_hesap_spam": 0, "ziyaretci_kontrol": 1, "kalkan_modu": 0, "kalkan_ban": 1, "kalkan_sure": 2 } }, "rate_limit_per_minute": 90 }, { "scope": "get-platform-ban-list", "scope_label": "Get Platform Ban List", "name": "Get Platform Ban List", "description": "Lists ban records from platform_ban_list table.", "method": "POST", "url": "https://api.missxss.com.tr/v1/get-platform-ban-list", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "platform", "type": "string", "required": false, "description": "Kick | Twitch | YouTube | TikTok (optional filter)" }, { "name": "limit", "type": "integer", "required": false, "description": "Row count (1-200, default: 50)" }, { "name": "offset", "type": "integer", "required": false, "description": "Start offset (default: 0)" } ], "example_request_body": { "platform": "Kick", "limit": 20, "offset": 0 }, "example_success_response": { "success": true, "total": 8, "limit": 20, "offset": 0, "platform": "Kick", "bans": [ { "id": 15, "platform": "Kick", "banned_id": "123", "banned_username": "baduser", "reason": "spam" } ] }, "rate_limit_per_minute": 60 }, { "scope": "get-moderation-log", "scope_label": "Get Moderation Log", "name": "Get Moderation Log", "description": "Returns moderation records from event table. Source: event records written by eventlog().", "method": "POST", "url": "https://api.missxss.com.tr/v1/get-moderation-log", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "type", "type": "string", "required": false, "description": "Filter: all | ban | timeout | shield (default: all)" }, { "name": "limit", "type": "integer", "required": false, "description": "Row count (1-50, default: 25)" }, { "name": "offset", "type": "integer", "required": false, "description": "Start offset (default: 0)" } ], "example_request_body": { "type": "all", "limit": 25, "offset": 0 }, "example_success_response": { "success": true, "source": "event", "type": "all", "limit": 25, "offset": 0, "logs": [ { "id": 991, "type": "Timeout", "username": "user1", "date": "2026-03-29 14:20:00" } ] }, "rate_limit_per_minute": 60 }, { "scope": "unban-user", "scope_label": "Unban User", "name": "Unban User", "description": "Removes ban for specified user.", "method": "POST", "url": "https://api.missxss.com.tr/v1/unban-user", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "username", "type": "string", "required": true, "description": "Username to unban" }, { "name": "platform", "type": "string", "required": false, "description": "Kick or Twitch (default: Kick)" } ], "example_request_body": { "username": "old_banned_user" }, "example_success_response": { "success": true, "username": "old_banned_user", "platform": "Kick" }, "rate_limit_per_minute": 60 }, { "scope": "ban-recent-followers", "scope_label": "Ban Recent Followers", "name": "Ban Recent Followers", "description": "Quickly ban/timeout the most recent followers. Can ban up to 10 users at once. offset parameter specifies starting position (1 = most recent), count parameter specifies how many users to ban.", "method": "POST", "url": "https://api.missxss.com.tr/v1/ban-recent-followers", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "action", "type": "string", "required": true, "description": "ban or timeout" }, { "name": "offset", "type": "integer", "required": false, "description": "Starting position (1 = most recent; default: 1)" }, { "name": "count", "type": "integer", "required": false, "description": "How many users to process (1-10; default: 1)" }, { "name": "duration", "type": "integer", "required": false, "description": "Timeout duration in minutes, only for action=timeout (min: 1, max: 525600; default: 1)" }, { "name": "reason", "type": "string", "required": false, "description": "Reason for action (default: \"API Ban Recent\")" }, { "name": "platform", "type": "string", "required": false, "description": "Kick or Twitch (default: Kick)" } ], "example_request_body": { "action": "ban", "offset": 1, "count": 2, "reason": "Spam" }, "example_success_response": { "success": true, "action": "ban", "processed_count": 2, "users": [ { "username": "user1", "userid": "123" }, { "username": "user2", "userid": "456" } ], "failed": [] }, "rate_limit_per_minute": 200 } ] }, { "key": "discord", "name": "Discord Core", "endpoints": [ { "scope": "discord-status", "scope_label": "Discord Status", "name": "Discord Status", "description": "Returns Discord bot connection status, guild/channel availability and core permissions.", "method": "POST", "url": "https://api.missxss.com.tr/v1/discord-status", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "guild_id", "type": "string", "required": false, "description": "Discord guild ID (read from active settings if omitted)" }, { "name": "channel_id", "type": "string", "required": false, "description": "Discord message channel ID (optional check)" }, { "name": "log_channel_id", "type": "string", "required": false, "description": "Discord log channel ID (optional check)" } ], "example_request_body": { "guild_id": "123456789012345678" }, "example_success_response": { "success": true, "bot_connected": true, "guild_found": true, "channel_found": true, "permissions": { "manage_roles": true, "move_members": true, "mute_members": true } }, "rate_limit_per_minute": 90 }, { "scope": "discord-send-message", "scope_label": "Discord Send Message", "name": "Discord Send Message", "description": "Sends text or embed message to your Discord guild channel. Channel ID is required and must belong to your configured guild for security.", "method": "POST", "url": "https://api.missxss.com.tr/v1/discord-send-message", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "channel_id", "type": "string", "required": true, "description": "Target Discord channel ID (required, must belong to your guild)" }, { "name": "message", "type": "string", "required": false, "description": "Text message to send (max 2000 characters)" }, { "name": "embed_title", "type": "string", "required": false, "description": "Embed title (max 256 characters)" }, { "name": "embed_description", "type": "string", "required": false, "description": "Embed description (max 4096 characters)" }, { "name": "embed_color", "type": "string", "required": false, "description": "Embed color (hex: #FF5733 or decimal: 16721715)" } ], "example_request_body": { "channel_id": "1383215007457611957", "message": "Merhaba Discord!" }, "example_success_response": { "success": true, "channel_id": "1383215007457611957", "guild_id": "700705230106394645", "message_id": "1445427371040571642" }, "rate_limit_per_minute": 30 }, { "scope": "discord-linked-users", "scope_label": "List Discord Linked Users", "name": "List Discord Linked Users", "description": "Returns paginated Discord-Kick/Twitch linked user records for this broadcaster.", "method": "POST", "url": "https://api.missxss.com.tr/v1/discord-linked-users", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "limit", "type": "integer", "required": false, "description": "Records per page (1-200, default 50)" }, { "name": "offset", "type": "integer", "required": false, "description": "Start offset (default 0)" } ], "example_request_body": { "limit": 50, "offset": 0 }, "example_success_response": { "success": true, "total": 120, "limit": 50, "offset": 0, "users": [ { "id": 1, "discord_id": "123", "kick_id": "456", "twitch_id": "789" } ] }, "rate_limit_per_minute": 90 } ] }, { "key": "discord-voice", "name": "Discord Voice Controls", "endpoints": [ { "scope": "discord-voice-members", "scope_label": "List Discord Voice Members", "name": "List Discord Voice Members", "description": "Returns all voice channels in a guild or members of a specific voice channel. Guild ID is automatically resolved from account settings.", "method": "POST", "url": "https://api.missxss.com.tr/v1/discord-voice-members", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "channel_id", "type": "string", "required": false, "description": "Voice channel ID to filter a single channel" } ], "example_request_body": {}, "example_success_response": { "success": true, "guild_id": "123456789012345678", "total_channels": 2, "channels": [ { "id": "111", "name": "Genel", "member_count": 3 } ] }, "rate_limit_per_minute": 90 }, { "scope": "discord-voice-kick", "scope_label": "Discord Voice Kick User", "name": "Discord Voice Kick User", "description": "Disconnects the specified user from their current voice channel. Guild ID is automatically resolved from account settings (security).", "method": "POST", "url": "https://api.missxss.com.tr/v1/discord-voice-kick", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "discord_id", "type": "string", "required": true, "description": "Discord user ID to disconnect" } ], "example_request_body": { "discord_id": "555555555555555555" }, "example_success_response": { "success": true, "discord_id": "555555555555555555", "kicked": true }, "rate_limit_per_minute": 30 }, { "scope": "discord-voice-move", "scope_label": "Discord Voice Move User", "name": "Discord Voice Move User", "description": "Moves the specified user to the target voice channel. Guild ID is automatically resolved from account settings (security).", "method": "POST", "url": "https://api.missxss.com.tr/v1/discord-voice-move", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "discord_id", "type": "string", "required": true, "description": "Discord user ID to move" }, { "name": "target_channel_id", "type": "string", "required": true, "description": "Target voice channel ID" } ], "example_request_body": { "discord_id": "555555555555555555", "target_channel_id": "999999999999999999" }, "example_success_response": { "success": true, "discord_id": "555555555555555555", "target_channel_id": "999999999999999999", "moved": true }, "rate_limit_per_minute": 30 }, { "scope": "discord-voice-mute", "scope_label": "Discord Voice Mute/Unmute User", "name": "Discord Voice Mute/Unmute User", "description": "Mutes, unmutes, or toggles mute state for the specified user. Guild ID is automatically resolved from account settings (security).", "method": "POST", "url": "https://api.missxss.com.tr/v1/discord-voice-mute", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "discord_id", "type": "string", "required": true, "description": "Discord user ID" }, { "name": "mode", "type": "string", "required": false, "description": "on | off | toggle (default: toggle)" } ], "example_request_body": { "discord_id": "555555555555555555", "mode": "on" }, "example_success_response": { "success": true, "discord_id": "555555555555555555", "muted": true, "changed": true, "mode": "on" }, "rate_limit_per_minute": 30 }, { "scope": "discord-voice-mute-all", "scope_label": "Discord Voice Mute All", "name": "Discord Voice Mute All", "description": "Mutes all non-bot users in the specified voice channel. Guild ID is automatically resolved from account settings (security).", "method": "POST", "url": "https://api.missxss.com.tr/v1/discord-voice-mute-all", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "channel_id", "type": "string", "required": true, "description": "Voice channel ID" } ], "example_request_body": { "channel_id": "999999999999999999" }, "example_success_response": { "success": true, "channel_id": "999999999999999999", "muted_count": 6 }, "rate_limit_per_minute": 30 }, { "scope": "discord-voice-unmute-all", "scope_label": "Discord Voice Unmute All", "name": "Discord Voice Unmute All", "description": "Unmutes all non-bot users in the specified voice channel. Guild ID is automatically resolved from account settings (security).", "method": "POST", "url": "https://api.missxss.com.tr/v1/discord-voice-unmute-all", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "channel_id", "type": "string", "required": true, "description": "Voice channel ID" } ], "example_request_body": { "channel_id": "999999999999999999" }, "example_success_response": { "success": true, "channel_id": "999999999999999999", "unmuted_count": 6 }, "rate_limit_per_minute": 30 }, { "scope": "discord-voice-pull-all", "scope_label": "Discord Voice Pull All", "name": "Discord Voice Pull All", "description": "Pulls users into one room. If from_channel_id is provided, only users in that channel are moved; otherwise users from all voice channels are moved to target_channel_id. Guild ID is automatically resolved from account settings (security).", "method": "POST", "url": "https://api.missxss.com.tr/v1/discord-voice-pull-all", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "target_channel_id", "type": "string", "required": true, "description": "Target voice channel ID" }, { "name": "from_channel_id", "type": "string", "required": false, "description": "Source voice channel ID (optional)" } ], "example_request_body": { "target_channel_id": "999999999999999999" }, "example_success_response": { "success": true, "target_channel_id": "999999999999999999", "source_channel_id": null, "moved_count": 4 }, "rate_limit_per_minute": 30 } ] }, { "key": "voicemod", "name": "Voicemod", "endpoints": [ { "scope": "voicemod-voice-change", "scope_label": "Change Voice", "name": "Change Voice", "description": "Changes the voice effect via Voicemod. Overlay connection required.", "method": "POST", "url": "https://api.missxss.com.tr/v1/voicemod-voice-change", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "voice", "type": "string", "required": true, "description": "Voice effect name (e.g. \"baby\", \"deep\")" }, { "name": "wait_time", "type": "integer", "required": false, "description": "Effect duration (seconds, default: 60)" }, { "name": "original_voice", "type": "integer", "required": false, "description": "Return to original voice after duration (0 or 1, default: 0)" } ], "example_request_body": { "voice": "baby", "wait_time": 60 }, "example_success_response": { "success": true }, "rate_limit_per_minute": 60 }, { "scope": "voicemod-effect-play", "scope_label": "Play Sound Effect", "name": "Play Sound Effect", "description": "Plays a Voicemod meme sound effect (soundboard).", "method": "POST", "url": "https://api.missxss.com.tr/v1/voicemod-effect-play", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "voice", "type": "string", "required": true, "description": "Effect name" } ], "example_request_body": { "voice": "applause" }, "example_success_response": { "success": true }, "rate_limit_per_minute": 60 }, { "scope": "voicemod-hear-self", "scope_label": "Hear My Self", "name": "Hear My Self", "description": "Activates the Voicemod \"Hear My Self\" feature for a specified duration.", "method": "POST", "url": "https://api.missxss.com.tr/v1/voicemod-hear-self", "headers": { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, "parameters": [ { "name": "wait_time", "type": "integer", "required": false, "description": "Duration (seconds, default: 60)" } ], "example_request_body": { "wait_time": 120 }, "example_success_response": { "success": true }, "rate_limit_per_minute": 60 } ] } ], "common_errors": [ { "status": 200, "description": "Request completed successfully." }, { "status": 400, "description": "Bad request. Check your parameters." }, { "status": 401, "description": "Unauthorized. API key is invalid or missing." }, { "status": 403, "description": "Forbidden. You don't have permission for this scope." }, { "status": 404, "description": "Resource not found (user, command, etc.)." }, { "status": 429, "description": "Too many requests. Please wait a moment." }, { "status": 500, "description": "Server error. Try again or contact support." }, { "status": 502, "description": "Backend service is unavailable." } ] }