search

One query, each platform's own search results, in one call at each platform's own price.

Runs the same query on several platforms' native search endpoints at once and returns their rows together: TikTok (/v1/tiktok/search), Instagram reels (/v1/instagram/search/reels), YouTube (/v1/youtube/search), Reddit (/v1/reddit/search), Threads (/v1/threads/search), X (/v1/twitter/search/tweets), Facebook (/v1/facebook/search/posts), LinkedIn (/v1/linkedin/search/posts) and Telegram (/v1/telegram/search, whose rows are channels under author, not posts, deduped by handle). platforms picks them (default tiktok,instagram,youtube,reddit,threads). Each platform is searched by calling that platform's own endpoint, so every row in data.items is exactly the row a direct call returns, with its post and computed blocks, plus platform, and each platform is billed exactly as a direct call would be. Rows are grouped by platform in the order you asked for them, in each platform's own order, and a post URL that already appeared is dropped (data.duplicates_removed). Each platform's own filters pass through with a platform prefix, for example tiktok.region=US or reddit.sort=new. since and until keep only posts published inside a date window on every platform; a row without a date is kept. Each platform is also sent the native date filter that fits the window, so its one page holds the right posts: Threads and Facebook start_date and end_date, the X since: and until: operators, and on TikTok, YouTube and Reddit the narrowest rolling bucket (date_posted, uploadDate, timeframe) that still reaches since, for example tiktok.date_posted=last-3-months for a date 44 days back. A filter you send yourself is never changed, and data._warnings says window_unreachable when it cannot reach since. On Instagram and LinkedIn the bucket is only suggested, because their date filter changes what the platform returns (Instagram reels lose their view counts). data.window reports what each platform was sent (native, origin, reaches_since, suggested) and how many of its rows fell outside the window. A newest-first page that ends before since (reddit.sort=new, X) says since_not_reached and names the cursor to continue with. data.sources reports each platform: status (ok, empty or failed), the rows it returned and kept, the credits it cost, its own request_id and warnings (for example the note that a Threads query was expanded), and its next_cursor, which you send as cursor to that platform's own endpoint (listed in endpoint) for its next page. This endpoint does not page itself. Native search matches your words literally; expand=context also runs up to three short searches written from your query and relevant_to (how sellers and posters phrase the same thing), merges them with your query's rows, tags each row with matched_query, and reports the searches in data.expansion. Pair it with relevance=filter and relevant_to to keep only the rows about what you mean. instagram.include=creator adds each Instagram creator's declared country, followers and public email, billed by the reel search as on a direct call. For a planned, reranked and clustered answer across more sources, use /v1/search/everywhere.

get/search/multi

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/search/multi
  • Auth: API key in header x-api-key

Query parameters

querystring required

Keyword or phrase, sent unchanged to every platform (1-500 characters). Each platform matches it the way its own search endpoint does: Reddit matches any of the words unless you wrap a phrase in double quotes, and a phrase Threads does not recognise is expanded into narrower searches.

platformsstring

Comma-separated platforms to search: tiktok, instagram, youtube, reddit, threads, twitter, facebook, linkedin, telegram. Default tiktok,instagram,youtube,reddit,threads. Each one costs its own endpoint's page price, and only when its page came back with rows.

sincestring

Keep only posts published on or after this date on every platform: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. A row with no date is kept. A platform page trimmed to nothing still costs its page, as it would on that platform's own endpoint. When you do not send a platform's own date filter, the narrowest one that reaches this date is sent for you on TikTok, YouTube and Reddit (an exact date on Threads, Facebook and X); data.window says which.

untilstring

Keep only posts published on or before this date on every platform: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. A row with no date is kept. Sent natively as Threads and Facebook end_date and the X until: operator; the other platforms have no upper bound of their own, so their newer rows are dropped from the page and still cost the page. Use since and until together for a calendar month.

expand'context'

Optional. context also searches up to three short phrases written from your query and, when you send it, relevant_to: the words the people who wrote the posts actually use. Native search reads a query literally, so a long phrase such as fake byd spare part sellers scam misses a seller who writes BYD spare parts Sharjah. Your own query always runs as well. Every row carries matched_query, the search that found it; data.expansion lists the searches with the rows each one added and its credits; data.sources.<platform>.by_query has each search's own cursor. Each extra search is billed on each platform exactly like your query (1 credit a page with rows, LinkedIn 5), and writing the searches is free. If they cannot be written in time, one search is made from the product words in your query (data._warnings says expand_fallback), or, when there are none to drop, only your query runs (expand_unavailable). Each search on each platform is one in-flight request on your API key, so one expanded call on six platforms holds up to 24 of the key's 50 at once; a search the limit refuses costs nothing and data._warnings says searches_limited.

expand_queriesinteger

Optional, only with expand=context. How many extra searches to run, 1 to 3 (default 3). Each one can cost up to one more page per platform.

tiktok.date_posted'yesterday' | 'this-week' | 'this-month' | 'last-3-months' | 'last-6-months' | 'all-time'

TikTok only. Sent to /v1/tiktok/search as date_posted, exactly as that endpoint takes it. One of: yesterday, this-week, this-month, last-3-months, last-6-months, all-time.

tiktok.sort_by'relevance' | 'most-liked' | 'date-posted'

TikTok only. Sent to /v1/tiktok/search as sort_by, exactly as that endpoint takes it. One of: relevance, most-liked, date-posted.

tiktok.regionstring

TikTok only. Sent to /v1/tiktok/search as region, exactly as that endpoint takes it.

instagram.date_posted'last-week' | 'last-month' | 'last-year'

Instagram only. Sent to /v1/instagram/search/reels as date_posted, exactly as that endpoint takes it. One of: last-week, last-month, last-year.

instagram.include'creator'

Instagram only. Sent to /v1/instagram/search/reels as include, exactly as that endpoint takes it. One of: creator.

youtube.uploadDate'today' | 'this_week' | 'this_month' | 'this_year'

YouTube only. Sent to /v1/youtube/search as uploadDate, exactly as that endpoint takes it. One of: today, this_week, this_month, this_year.

youtube.sortBy'relevance' | 'popular'

YouTube only. Sent to /v1/youtube/search as sortBy, exactly as that endpoint takes it. One of: relevance, popular.

youtube.type'videos' | 'shorts'

YouTube only. Sent to /v1/youtube/search as type, exactly as that endpoint takes it. One of: videos, shorts.

youtube.duration'under_3_min' | 'between_3_and_20_min' | 'over_20_min'

YouTube only. Sent to /v1/youtube/search as duration, exactly as that endpoint takes it. One of: under_3_min, between_3_and_20_min, over_20_min.

youtube.regionstring

YouTube only. Sent to /v1/youtube/search as region, exactly as that endpoint takes it.

reddit.sort'relevance' | 'new' | 'top' | 'comment_count'

Reddit only. Sent to /v1/reddit/search as sort, exactly as that endpoint takes it. One of: relevance, new, top, comment_count.

reddit.timeframe'all' | 'day' | 'week' | 'month' | 'year'

Reddit only. Sent to /v1/reddit/search as timeframe, exactly as that endpoint takes it. One of: all, day, week, month, year.

threads.start_datestring

Threads only. Sent to /v1/threads/search as start_date, exactly as that endpoint takes it.

threads.end_datestring

Threads only. Sent to /v1/threads/search as end_date, exactly as that endpoint takes it.

twitter.sort'latest' | 'top'

X only. Sent to /v1/twitter/search/tweets as sort, exactly as that endpoint takes it. One of: latest, top.

facebook.start_datestring

Facebook only. Sent to /v1/facebook/search/posts as start_date, exactly as that endpoint takes it.

facebook.end_datestring

Facebook only. Sent to /v1/facebook/search/posts as end_date, exactly as that endpoint takes it.

facebook.recent_postsboolean

Facebook only. Sent to /v1/facebook/search/posts as recent_posts, exactly as that endpoint takes it.

facebook.location_uidstring

Facebook only. Sent to /v1/facebook/search/posts as location_uid, exactly as that endpoint takes it.

linkedin.sort_by'date_posted' | 'relevance'

LinkedIn only. Sent to /v1/linkedin/search/posts as sort_by, exactly as that endpoint takes it. One of: date_posted, relevance.

linkedin.date_posted'past_24h' | 'past_week' | 'past_month'

LinkedIn only. Sent to /v1/linkedin/search/posts as date_posted, exactly as that endpoint takes it. One of: past_24h, past_week, past_month.

linkedin.content_type'videos' | 'photos' | 'jobs' | 'live_videos' | 'documents' | 'collaborative_articles'

LinkedIn only. Sent to /v1/linkedin/search/posts as content_type, exactly as that endpoint takes it. One of: videos, photos, jobs, live_videos, documents, collaborative_articles.

telegram.date_posted'last-hour' | 'last-day' | 'last-week' | 'last-month' | 'last-year'

Telegram only. Sent to /v1/telegram/search as date_posted, exactly as that endpoint takes it. One of: last-hour, last-day, last-week, last-month, last-year.

telegram.regionstring

Telegram only. Sent to /v1/telegram/search as region, exactly as that endpoint takes it.

relevance'score' | 'filter'

Optional. Without this param every row already carries computed.relevance against your query, free ({ p, sense, depth, spam }: is this row about what your query means, or a different thing that shares its words?), and nothing is dropped or reordered. score asks for it explicitly and waits for every row; filter also drops the rows that are not about your query, and lists their ids in data.relevance.dropped_ids. Your query is the topic; nothing to configure. A row that could not be judged is never dropped and carries relevance: null. Pagination is unchanged, so a filtered page can hold fewer rows. Free with your query as the topic; with relevant_to it adds 1 credit per started 25 newly judged rows (rows already judged for the same topic are free, and so is a cached page).

relevance_thresholdstring

Optional, only with relevance. The probability (0 to 1) a row must reach to be kept by relevance=filter. Default 0.5. Lower keeps more rows, higher keeps fewer.

relevant_tostring

Optional, only with relevance. Up to 200 characters describing what you mean, used as the topic instead of the query. Use it when the query is ambiguous, for example query=cleopatra with relevant_to=Cleopatra, the IGT slot game.

judgments'on' | 'off'

Optional, on (the default) or off. By default every row gains free SocialCrawl judgments (computed.labels, and computed.relevance on search endpoints), reported in data.labels (mode default) and data.relevance (origin default), each with a status (complete, partial or skipped) and pending: the rows still being judged when the page was sent, which carry null now and are filled on your next call or cached read. Default judgments never add credits, never change an existing field, and never drop or reorder a row. off returns the page exactly as before, with none of those keys. label=none does the same.

dry_run'1'

Optional. When 1, return a cost preview for this labelled or relevance-filtered request without fetching the page or judging any row. data.estimate reports rows_expected, rows_cached, label_credits_min, label_credits_max and base_credits. 0 credits charged.

fit'goal'

Optional. When goal, keep the rows and fields needed for the goal you pass in goal= (plus any that are uncertain, and the first and last), and replace the rest with a stub. data.held_back lists the held ids and a recall id that re-reads the full page from cache at no extra charge. Without this param the page is unchanged.

goalstring

Required by fit=goal. What you are trying to do, in your own words, up to 300 characters.

fit_tokensinteger

Optional, only with fit=goal. Soft cap on how much of the page to keep, in tokens. Uncertain blocks and the first and last block are kept even if they exceed it.

labelstring

Optional CSV of SocialCrawl labels to add to every post. Without this param every page already carries sponsored, intent and niche, free; label= adds the labels you name to them (the defaults keep running). sponsored, intent and niche are free when asked for too; mention, quality, intent with offer=, and injection add 1 credit per started 25 newly judged posts. judgments=off (or label=none) turns the default labels off. sponsored: is the post a paid or gifted promotion (p, 0 to 1), did it carry a disclosure marker such as #ad or 광고 (disclosed), is it likely paid with no marker (undisclosed), and which of the accounts it mentions does it promote (brand, or null). These are signals to review, never a finding. mention (needs brand=): is the post about that brand rather than something that shares its name (about_brand, 0 to 1), how it feels about the brand on five levels (sentiment_level 0 to 4 and sentiment_score 0 to 1, null when the post is not about the brand), is it sarcastic, which aspect it talks about (taste_or_quality, price_or_value, availability_or_delivery, health_or_safety, advertising_or_campaign, customer_service, none), and did the author buy or use it (first_hand). intent: what the author is mainly doing (label: asking_for_recommendation, comparing_options, switching_away, complaining, promoting, news_or_discussion, other, or null when unsure, with confidence), whether they read as a potential buyer rather than a seller (buyer, seller), how pressing the need is (urgency, 0 to 3), and, when you pass offer=, whether your offer would plausibly help them (fits_offer). niche: which of the 33 niches of the published taxonomy sc-niche-v1 the caption belongs to, or personal_no_niche, or other (label, confidence, taxonomy), with label null when the caption is too thin to tell or the pick is unsure. It reads the caption only, not the video. quality: how much checkable detail the caption carries (fact_density 0 to 3), whether it mainly asks for likes, replies, shares, follows or tags (engagement_bait, 0 to 1), whether it is written to provoke anger as a way to get engagement (rage_bait, 0 to 1; about the writing, never the side taken), whether it only repeats someone else's news or view (secondhand, 0 to 1), and what the post is mainly doing (post_aim: inform, opinion, sell, entertain, provoke, other). exclude=engagement_bait drops posts whose engagement_bait is 0.8 or higher. injection flags text that addresses an AI system and tries to direct it (flagged, p); it never drops or rewrites a row. A post that could not be judged carries labels: null. Posts already labelled for anyone are free, and so is a cached page. data.labels reports what was judged and billed.

excludestring

Optional CSV (engagement_bait), only with label=quality. Drops posts whose engagement_bait probability is 0.8 or higher and lists their ids in data.labels.dropped_ids. A post that could not be judged is never dropped.

brandstring

Required by label=mention, ignored otherwise. The brand or product the posts are judged against, up to 300 characters, for example brand=Buldak. Without it label=mention is skipped with the warning label_mention_needs_brand and is not billed.

brand_descriptionstring

Optional, with label=mention. One plain sentence saying what the brand is, for example brand_description=Samyang's spicy instant noodle brand. Use it when the name is also an ordinary word or another company's name.

offerstring

Optional, with label=intent. One or two plain sentences saying what you sell, up to 300 characters, for example offer=A web design agency that builds websites for small businesses. Adds fits_offer to every post; without it fits_offer is null.

label_evidence'1'

Optional, only with label=. When 1, every labelled row also carries computed.labels_evidence.<preset> = { quote, sentence_index }: the sentence in the row that most clearly shows the label, copied verbatim. Absent or null when no single sentence shows it.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "search",
  "endpoint": "/v1/search/multi",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.