Skip to main content
The Pro REST API manages the same tasks you see in the dashboard. To receive the events they produce, use the WebSocket

Authentication

Send your API key in the Authorization header

Endpoints

Manage tasks

Read, create, edit, start, stop, and delete tasks

User data

Username history of an X profile

Errors

Errors return error: true and a message. Validation failures add errors, which maps each field to a list of messages

Bulk endpoints

Bulk endpoints accept up to 200 tasks and stream one progress Server-Sent Event per task, then done. A failed task does not stop the batch, so check result.error on each progress event