Skip to main content
POST
/
v1
/
serp
/
async
SERP Async
curl --request POST \
  --url https://sdk.nimbleway.com/v1/serp/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "search_engine": "google_search",
  "query": "NBA Allstar 2026",
  "country": "US",
  "locale": "en"
}
'
{
  "status": "success",
  "task": {
    "id": "8e8cfde8-345b-42b8-b3e2-0c61eb11e00f",
    "state": "pending",
    "created_at": "2026-01-24T12:36:24.685Z",
    "modified_at": "2026-01-24T12:36:24.685Z",
    "input": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.nimbleway.com/llms.txt

Use this file to discover all available pages before exploring further.

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 fast serp endpoint

​
search_engine
enum<string>
required

The search engine to query

Available options:
google_search,
google_aio,
google_maps_search,
google_maps_reviews,
google_maps_place,
google_news,
google_images,
bing_search,
yandex_search
Example:

"google_search"

​
query
string

The search query string. Required for google_search, google_news, google_images, and google_maps_search

Example:

"NBA Allstars 2026"

​
place_id
string

Google Maps place identifier. Required for google_maps_place and google_maps_reviews

Example:

"ChIJtRq8oUjLw4kR_tN2GQKUOXs"

​
coordinates
object
Example:
{
  "latitude": "40.7123695",
  "longitude": "-74.0357317"
}
​
time
string

Filter results by time range. Only supported for google_search, google_news, and google_images

Examples:

"hour"

"day"

"week"

"month"

"year"

​
country
string
default:US

Run the search as if from a specific country. Returns geo-localized results (optimized for US)

Example:

"US"

​
locale
string

Language preference for the search results. Use LCID standard

Example:

"en"

​
location
string

Location context for the search. Accepted for google_search, google_news, and google_images — not supported for Maps engines. Pass a location string (e.g. "United States", "New York, NY") or a raw Google UULE value.

Examples:

"United States"

"New York, NY"

​
no_html
boolean
default:false

When set to true, removes the html_content field from the response

Example:

true

​
num_results
integer

Number of results to return (1–100).

Required range: 1 <= x <= 100
Example:

10

​
start
integer

Result offset for fetching beyond the first batch.

Example:

10

​
include_pages_html
boolean
default:false

When set to true, returns raw HTML per individual result page instead of a single stitched HTML string.

Example:

true

​
device
enum<string>

Emulate a specific device type.

Available options:
mobile
Example:

"mobile"

​
ads_optimization
boolean
default:false

When set to true, boosts sponsored results using incognito rendering (requires JS).

Example:

true

​
storage_type
enum<string>

Storage type for async results. Use s3 for Amazon S3 and gs for Google Cloud Platform.

Available options:
s3,
gs
Example:

"s3"

​
storage_url
string

Repository URL where output will be saved. Format: s3://Your.Bucket.Name/your/object/name/prefix/ - Output will be saved as TASK_ID.json

Example:

"s3://Your.Repository.Path/"

​
callback_url
string<uri>

A URL to callback once the data is delivered. The API will send a POST request with task details (without the requested data) when the task completes.

Example:

"https://your.callback.url/path"

​
storage_compress
boolean

When set to true, the response saved to storage_url will be compressed using GZIP format. If false or not set, response will be saved uncompressed.

Example:

false

​
storage_object_name
string

Custom name for the stored object instead of the default task ID

Example:

"my task"

Response

Async Task Created

​
status
string
required
Example:

"success"

​
task
object
required