Manage Tasks

Get User Info

Retrieves user account informations, including the expiration date, task limits, and current tasks list

• URL: /info

• Method: GET

• Headers:

  • Authorization: <user_token>

Example Request:

curl -X GET 'https://monitor-api.tweet-catcher.com:9999/pro/info' -H 'Authorization: your_user_token_here'

Example Response:

{
   "expireAt":"2024-12-31T23:59:59Z",
   "tasksLimit":200,
   "tasks":[
      {
         "id":685,
         "user":"Gioppooo",
         "options":[
            "ocr",
            "posts",
            "retweets",
            "replies"
         ],
         "notification":"discord",
         "webhook":"https://discord.com/api/webhooks/...",
         "ping":"everyone",
         "running":false
      }
   ]
}

Get Tasks List

Retrieves a list of the user's tasks

• URL: /tasks-list

• Method: GET

• Headers:

  • Authorization: <user_token>

Example Request:

curl -X GET 'https://monitor-api.tweet-catcher.com:9999/pro/tasks-list' -H 'Authorization: your_user_token_here'

Example Response:

[
   {
      "id":685,
      "user":"Gioppooo",
      "options":[
         "ocr",
         "posts",
         "retweets",
         "replies"
      ],
      "notification":"discord",
      "webhook":"https://discord.com/api/webhooks/...",
      "ping":"everyone",
      "running":false
   },
   {
      "id":732,
      ....
   }
]

Add Task

Adds a new task

• URL: /add-task

• Method: POST

• Headers:

  • Authorization: <user_token>

  • Content-Type: application/json

• Body: JSON object containing task details

When creating a task via API, the following options are available:

user: String - The Twitter user handle to monitor (required)

options: Array of Strings - Monitoring options (at least one required)

• Possible values: "posts", "retweets", "replies", "following", "userUpdates", "ocr"

• Note: "ocr" can only be included if "posts", "retweets", or "replies" are also selected

notification: String - Notification method (required)

• Possible values: "discord", "telegram", "webhook", "websocket" (websocket only for pro plan)

webhook: String - Discord webhook URL or custom webhook URL (required for Discord and custom webhook notifications)

chatId: String - Telegram chat ID (required for Telegram notifications)

differentWebhooks: Boolean - Whether to use different webhooks for different monitoring options

ping: String - Discord ping option (for Discord notifications)

• Possible values: "none", "everyone", "here", "role"

roleId: String - Discord role ID to ping (required if ping is set to "role")

pingKeywords: Object - Keywords or regex for selective pinging (only for Discord notifications)

• For non-regex: { n: Array of negative keywords, p: Array of positive keywords }

• For regex: { regex: String, isRegex: true }

useRegex: Boolean - Whether to use regex for ping keywords

start: Boolean - Whether to automatically start the task after creation or not

Additional webhook fields (if differentWebhooks is true):

• webhook-posts: String - Webhook for posts

• webhook-following: String - Webhook for following updates

• webhook-userUpdates: String - Webhook for user updates

• (Similarly for Telegram) chatId-posts, chatId-following, chatId-userUpdates

When creating a task via API, format these options as a JSON object. Remember to include all required fields and ensure that the values match the expected types and formats as described above.

Example Request:

curl -X POST 'https://monitor-api.tweet-catcher.com:9999/pro/add-task' -H 'Authorization: your_user_token_here' -H 'Content-Type: application/json' -d '{"user":"gioppooo","options":["following"],"notification":"websocket","start":true}'

Example Response:

{ "id": 932, ... }

Start Task

Starts a specific task

• URL: /start-task

• Method: POST

• Headers:

  • Authorization: <user_token>

  • Content-Type: application/json

• Body: JSON object containing the task ID

Example Request:

curl -X POST 'https://monitor-api.tweet-catcher.com:9999/pro/start-task' -H 'Authorization: your_user_token_here' -H 'Content-Type: application/json' -d '{"id":932}'

Example Response:

{ "error": false }

Edit Task

Edits an existing task for the user.

• URL: /edit-task

• Method: POST

• Headers:

  • Authorization: <user_token>

  • Content-Type: application/json

• Body: JSON object containing the task ID and updated details

Example Request:

curl -X POST 'https://monitor-api.tweet-catcher.com:9999/pro/edit-task' -H 'Authorization: your_user_token_here' -H 'Content-Type: application/json' -d '{"id":932,"user":"solvingkasada","options":["following"],"notification":"websocket"}'

Example Response:

{ "error": false }

Stop Task

Stops a specific task for the user.

• URL: /stop-task

• Method: POST

• Headers:

  • Authorization: <user_token>

  • Content-Type: application/json

• Body: JSON object containing the task ID

Example Request:

curl -X POST 'https://monitor-api.tweet-catcher.com:9999/pro/stop-task' -H 'Authorization: your_user_token_here' -H 'Content-Type: application/json' -d '{"id": 932}'

Example Response:

{ "error": false }

Delete Task

Deletes a specific task for the user.

• URL: /delete-task

• Method: POST

• Headers:

  • Authorization: <user_token>

  • Content-Type: application/json

• Body: JSON object containing the task ID

Example Request:

curl -X POST 'https://monitor-api.tweet-catcher.com:9999/pro/delete-task' -H 'Authorization: your_user_token_here' -H 'Content-Type: application/json' -d '{"id": 932}'

Example Response:

{ "error": false }