Skip to main content
POST
/
v1
/
search
Search
curl --request POST \
  --url https://sdk.nimbleway.com/v1/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "Nike brand perception consumer reviews 2025",
  "num_results": 10,
  "format": "markdown",
  "focus": "social",
  "include_answer": false,
  "deep_search": false
}
'
{
  "total_results": 123,
  "results": [
    {
      "title": "<string>",
      "description": "<string>",
      "url": "<string>",
      "content": "<string>",
      "extra_fields": {
        "published_date": "2024-01-15"
      }
    }
  ],
  "request_id": "<string>",
  "answer": "The best web scraping tools in 2024 include..."
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Request body model for the /search endpoint

​
query
string
required

Search query string

Minimum string length: 1
​
locale
string

LCID standard locale used for the URL request. Alternatively, user can use 'auto' for automatic locale based on geo-location

Example:

"en-US"

​
country
string

Country used to access the target URL, use ISO Alpha-2 Country Codes

Example:

"US"

​
parsing_type
enum<string>

Enum representing the parsing types supported by Nimble

Available options:
plain_text,
markdown,
simplified_html
​
num_results
integer

Maximum number of results to return (actual count may be less)

Required range: 1 <= x <= 100
​
focus
enum<string>

Enum representing the search focus/specialization. Controls which search engine and parameters are used internally

Available options:
general,
news,
location,
coding,
geo,
shopping,
social
​
deep_search
boolean

If True, fetches and extracts full page content for each search result. If False, returns only metadata (title, snippet, URL)

​
include_answer
boolean

Generate LLM answer summary based on search result snippets (works with both deep_search=True and False)

​
exclude_domains
string[] | null

List of domains to exclude from search results. Maximum 50 domains

Maximum array length: 50
​
start_date
string | null

Filter results after this date (format: YYYY-MM-DD or YYYY)

​
end_date
string | null

Filter results before this date (format: YYYY-MM-DD or YYYY)

​
time_range
enum<string>

Time range filters passed to Webit SERP API as 'time' parameter

Available options:
hour,
day,
week,
month,
year
​
max_subagents
integer

Maximum number of subagents to execute in parallel for Agent focus modes (shopping, social, geo). Ignored for traditional SERP focus modes. Default: 3, Range: 1-5

Required range: 1 <= x <= 5

Response

Successful Response

Search API response containing search results with titles, descriptions, URLs, and content. Includes optional AI-generated answer when llm_answer parameter is enabled. In Deep Search mode (deep_search=true), each result includes full extracted page content. In Fast Mode (deep_search=false), only URLs and metadata are returned.

​
total_results
integer
required

Total number of search results returned in this response

Example:

10

​
results
SearchResultModel · object[]
required

Array of search results, each containing title, description, URL, content (in Deep Search mode), and optional metadata

​
request_id
string
required

Unique identifier for tracking this search request

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
answer
string | null

AI-generated summary answer to your search query (only available when llm_answer parameter is enabled). Returns null if disabled or if generation fails.

Example:

"The best web scraping tools in 2024 include..."