API reference

Everything the app does, from your own code: search, comments, runs and their data.

Credits

• Check your credits: GET /api/v1/credits. Returns what each platform can use right now, whether your workspace can start runs at all, and when today’s credits reset (midnight UTC).
• Is it working right now?: GET /api/v1/status. Free workers are not the whole story: a worker can be free while the runs on it keep timing out.
• Account and plan: GET /api/v1/me. Your workspace, plan limits, what you have used, and your billing status.

Search

• Search posts on one platform: GET /api/v1/search. Searches one platform and answers with its public posts, each with the same fields on every platform: id, url, platform, text, published_at (ISO 8601 UTC), the author, the counts, hashtags, media and geo.
• Comments on one post: GET /api/v1/comments. Returns the comments on one post on X, YouTube, TikTok, Facebook, Instagram, Reddit or LinkedIn, by its link.

Background search

• Start a background search: GET /api/v1/search. The same request as Search posts, with async=true.
• A background search's status: GET /api/v1/search/{search_id}. How far the search has got, keyword by keyword.
• Read a background search's posts: GET /api/v1/search/{search_id}/posts. The posts of a finished search, a page at a time, in a fixed order: a post from each keyword in turn.
• Cancel a background search: DELETE /api/v1/search/{search_id}. Stops a search that is queued or running.

Running

• See what you can fetch: GET /api/v1/platforms. Lists every platform your workspace can use, with the input it takes (docs.inputs), an example input, what comes back (docs.returns) and notes on it (docs.notes).
• Check an input without running it: POST /api/v1/platforms/{platform}/validate. Tells you whether the input is complete, how many records it holds and how many credits it would use.
• Paste links and run: POST /api/v1/quick-run. The shortest way in: send links, and the platform and the request are worked out for you (for a Shopee or Temu link, the region too).
• Save a run: POST /api/v1/runs. Saves a named run with its input, and an optional schedule, without starting it.
• Start a run: POST /api/v1/runs/{name}/history. Starts a saved run and returns at once with its id.
• Stop a run: POST /api/v1/runs/{name}/history/{id}/cancel. Stops a run that is still going.

Getting the data

• Get a run’s data by its id: GET /api/v1/results/{id}. Pass the run id from when you started it.
• List a saved run’s recent entries: GET /api/v1/runs/{name}/history. The 50 most recent entries of a saved run, newest first, without their data.
• Get one entry with its data: GET /api/v1/runs/{name}/history/{id}. The same answer as the results call, for when you also have the run’s name.
• Download as a file: GET /api/v1/runs/{name}/history/{id}/export. format is json, csv or xlsx.