v1

latestOpenAPI 3.0.02026-07-223589127.1 KB

Submit search

Run a search across supported web and social sources. The default response returns an operation to poll; add sync=true only when you want to wait briefly for an immediate result.

post/api/v1/search

Query parameters

syncboolean

Set to true to wait briefly for a completed result instead of immediately returning an operation to poll.

Headers

Idempotency-Keystring

Prevents duplicate work if you retry the same request with the same key.

Request body

Type of search to perform

querystring

Search query string. Required unless match_any/match_all are provided.

match_anystring[]

Keywords where ANY must match (OR logic). Used to build search query.

match_allstring[]

Keywords where ALL must match (AND logic). Used to build search query.

excludestring[]

Keywords to exclude from results.

max_resultsnumber

Maximum results to return (default 10, max 50)

sitestring

Domain to restrict search to (required for site_search)

include_domainsstring[]

Domains to include results from (web_search only)

exclude_domainsstring[]

Domains to exclude results from (web_search only)

sort_by'relevance' | 'recent'

Sort by relevance or recency for supported keyword searches. Reddit maps recent to Reddit's new sort.

match_mode'exact' | 'broad'

Match mode for LinkedIn keyword searches. exact searches the query as a quoted phrase; broad sends the query without phrase quotes.

date_filterstring

Date filter for LinkedIn search (e.g. past-24h, past-week)

hashtagstring

Hashtag to search for (required for tiktok_hashtag type, without # prefix)

subredditstring

Subreddit to search within (reddit_search only)

Example request

{
  "type": "web_search",
  "query": "AI startup funding 2026",
  "match_any": [
    "AI startup",
    "machine learning funding"
  ],
  "match_all": [
    "Series A",
    "2026"
  ],
  "exclude": [
    "crypto",
    "blockchain"
  ],
  "site": "techcrunch.com",
  "hashtag": "productanalytics",
  "subreddit": "startups"
}

Response

Search completed immediately.

idstring required

Unique search result ID

status'queued' | 'processing' | 'succeeded' | 'failed' required

Current status

Search type

querystring required

Original query

poll_urlstring

URL to poll for result

total_resultsnumber nullable

Total results found

created_atstring required

ISO timestamp of creation

completed_atstring nullable

ISO timestamp of completion