GET
Search through the engine selected by the orchestrator’s own configuration (Google, Brave, or DuckDuckGo) — the engine itself isn’t a client-selectable parameter. mode=fast returns organic results and metadata; mode=full (the default) additionally returns available knowledge graph, People Also Ask, related searches, sitelinks, and result attributes. Engines can omit any SERP feature, and don’t always provide an estimated result total.

​
Query parameters

​
Required

  • query (string, 1–512 chars): Keyword to search on the configured engine.

​
Optional

  • country (string, default: US): Two-letter country code used to localize results.
  • language (string, default: en): Two-letter result language code.
  • num_results (integer, default: 10, 1–100): Maximum organic results to return.
  • tbs (string): Time filter — qdr:d (past day), qdr:w (past week), qdr:m (past month).
  • device (string, default: desktop): desktop, mobile, tablet.
  • mode (string, default: full): fast (organic results only) or full (adds knowledge graph, People Also Ask, related searches, sitelinks, and result attributes).
  • output (string): Optional comma-separated page outputs to enrich each organic result with: html, clean_html, links. Omit for metadata-only results. Enrichment fetches each result’s page and is billed as one ordinary scrape per result attempted.
  • only_main_content (boolean, default: true): Remove navigation and other non-main layout content from cleaned outputs.

​
Responses

  • 200: FastSerpResponse (when mode=fast) or FullSerpResponse (when mode=full) — query, pageNumber, dateDownloaded, resultPages (pages the search covered — billed per page), enrichmentScrapes (page-enrichment scrapes attempted, when output is set), and organic (each result has position, title, link, snippet, domain, page, and — in full mode — sitelinks and attributes; plus htmlBody/cleanHtml/links when output was requested). FullSerpResponse additionally includes totalOrganicResults, knowledgeGraph, peopleAlsoAsk, and relatedSearches.
  • 400: Malformed query parameters.
  • 422: Invalid SERP parameter (e.g. empty query, invalid country/language code, num_results out of range, or invalid tbs).
  • 429: Search engine rate limit reached.
  • 502: The search engine returned an invalid or blocked response.
  • 503: The search engine is unavailable.
  • 504: Search request timed out.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
query
string
required

Keyword to search on the configured engine.

Example:

"best running shoes"

​
country
string
default:US

Two-letter country code used to localize results.

Examples:

"US"

"NP"

​
language
string
default:en

Two-letter result language code.

Examples:

"en"

"de"

​
num_results
integer
default:10

Maximum organic results to return.

Required range: 1 <= x <= 100
​
tbs
string

Optional time filter: past day, week, or month.

Examples:

"qdr:d"

"qdr:w"

"qdr:m"

​
device
enum<string>
default:desktop

Browser device profile. Browser device profile used for the OpenSERP request.

Available options:
desktop,
mobile,
tablet
​
mode
enum<string>
default:full

Response detail and credit tier. Response detail and credit tier. fast costs 1 credit; full costs 3 credits.

Available options:
full,
fast
​
output
string

Optional comma-separated page outputs to enrich each organic result with: html, clean_html, links. Omit for metadata-only results.

​
only_main_content
boolean
default:true

Remove navigation and other non-main layout content from cleaned outputs.

Response

Fast or full public SERP response, depending on mode

Returned when mode=fast (1 credit): organic results and metadata only.

​
query
string
required
​
pageNumber
integer
required
​
dateDownloaded
string
required
​
resultPages
integer
required

Result pages the search covered. Billed per page.

​
enrichmentScrapes
integer
required

Enrichment scrapes attempted, one per organic result when output is set. Each is billed as an ordinary scrape.

​
creditsUsed
integer
required
Example:

1

​
organic
SerpOrganicResult · object[]
required