Skip to main content
POST
Social media search

Headers

idempotency-key
string
required

A caller-generated idempotency key (a UUID is recommended). One key binds to one run: a retry with the same key after a network timeout is a read, not a second execution.

Minimum string length: 1

Body

application/json
platform
enum<string>
required
Available options:
reddit,
x,
youtube,
tiktok,
instagram,
linkedin
mode
enum<string> | null

Default search. search: posts matching query. profile: the account itself — bio, follower counts, links — from handle (reddit: the subreddit; linkedin: url of a person's profile or a company page). feed: the account's recent posts or videos, from handle (linkedin: url of a company page). post: one post or video from url. find: an account's other social profiles, from handle.

Available options:
search,
profile,
feed,
post,
find
provider
enum<string> | null

Data provider: auto (default) or one of scrapecreators, apify, tikhub. Name one only when the caller asks for that vendor.

Available options:
auto,
scrapecreators,
apify,
tikhub
query
string | null
Required string length: 1 - 500
handle
string | null

A username without @, or a subreddit name without r/.

Required string length: 1 - 100
url
string | null
Required string length: 1 - 2048

Response

a terminal run: COMPLETED, FAILED or STOPPED

id
string
required
run_url
string
required
provider
string
required
Pattern: ^[a-z0-9][a-z0-9-]*$
endpoint
string
required
Pattern: ^\/.+$
endpoint_version
integer
required
status
enum<string>
required
Available options:
QUEUED,
RUNNING,
COMPLETED,
FAILED,
STOPPED
failure
object | null
required
input
object
required
output
any
required
provider_response
object | null
required
charge_usd
string | null
required

Exact USD decimal string (min 2, max 6 decimals, one canonical spelling). Sum with decimal arithmetic or scale by 10^6 — never floats.

Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$
charge_basis
object | null
required
stoppable
boolean
required
stop_requested_at
string<date-time> | null
required

ISO-8601 UTC timestamp

created_at
string<date-time>
required

ISO-8601 UTC timestamp

started_at
string<date-time> | null
required

ISO-8601 UTC timestamp

completed_at
string<date-time> | null
required

ISO-8601 UTC timestamp