Skip to main content
POST
Scrape image search results
Scrape image search results.

Request

query is required.
This endpoint can be called without an API key, subject to per-address limits. Pagination requires a key.

Response

If successful, the response body contains the standard envelope. data contains results. The following example is a real response, truncated: each list shows one item and long strings are cut.
For every field, see the response schema on this page.

Optional parameters

Billing

A successful request consumes 1 credit per 10 images, up to 10 credits. Requests that fail, or that return no items, are not billed. Set limit to cap the number of items returned and billed.

Pagination

This method is not paginated. A single request returns the complete result.

Authorizations

Authorization
string
header
required

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

Query Parameters

maxTextLength
integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json
query
string
required
Required string length: 1 - 400

Hide explicit images.

limit
integer
default:10

Return at most this many images. You pay 1 credit per 10 returned.

Required range: 1 <= x <= 100

Response

The data, and the credits this call used.

success
any
required
data
object
required
creditsUsed
integer
required
requestId
string
required