/screenshoter

Captures high quality screenshots of any webpage simply by providing its URL

GET

Webpage Screenshotter

Request

Endpoint:

GET https://api.outscraper.com/screenshoter

Parameters

Name	In	Type	Required	Description	Example	Constraints
`query`	query	array<string>	Yes	Links to web pages (e.g., `https://www.apple.com/iphone/`). It supports batching by sending arrays with up to `1000` queries (e.g., `query=text1&query=text2&query=text3`). It allows multiple queries to be sent in one request and to save on network latency time.	-	-
`region`	query	string enum	No	The parameter specifies the country to use for the screenshot.	-	allowed AF, AL, DZ, AS, AD, AO, AI, AG, …
`type`	query	string enum	No	The parameter specifies the image extension.	-	default webp, allowed webp, png, jpeg, pdf
`fullPage`	query	boolean	No	The parameter specifies whether to capture the full page. It overrides the viewport height.	-	default false
`width`	query	integer	No	The parameter specifies the width of the viewport.	-	default 1200
`height`	query	integer	No	The parameter specifies the height of the viewport.	-	default 800
`fields`	query	string	No	The parameter defines which fields you want to include with each item returned in the response. By default, it returns all fields. Use `&fields=query,name` to return only the specific ones.	-	-
`async`	query	boolean	Yes	The parameter defines the way you want to submit your task to Outscraper. It can be set to `false` to open an HTTP connection and keep it open until you get your results, or `true` (default) to just submit your requests to Outscraper and retrieve them later (usually within 1-3 minutes) with the Request Results endpoint. Each response is available for `4` hours after a request has been completed. A good practice is to send async requests and start checking the results after the estimated execution time. Check out this Python implementation as an example. As most of the requests take some time to be executed the `async=true` option is preferred to avoid HTTP request timeouts.	-	default true
`ui`	query	boolean	No	The parameter defines whether a task will be executed as a UI task. This is commonly used when you want to create a regular platform task with API. Using this parameter overwrites the `async` parameter to `true`.	-	default false
`format`	query	array<string enum>	No	The parameter defines the format of the output data. Using this parameter overwrites the `ui` parameter to `true`.	-	-
`webhook`	query	string	No	The parameter defines the URL address (callback) to which Outscraper will create a POST request with a JSON body once a task/request is finished. Using this parameter overwrites the webhook from integrations.	-	-

Responses

200

application/json

The response contains the status of the request and data. Data is an array where each element represents a response for a single query from the request.

Response 200

{
  "id": "your-request-id",
  "status": "Success",
  "data": [
    {
      "query": "https://outscraper.com",
      "screenshot": "https://os-storage.b-cdn.net/2024/12/10/1ec3016b-c3fa-4248-8a5c-73ad27e98f82.webp"
    }
  ]
}

202

application/json

The response contains a request ID that can be used to fetch results by using Request Results endpoint. Each response is available for 4 hours after a request has been completed.

Response 202

{
  "id": "your-request-id",
  "status": "Pending",
  "results_location": "https://api.outscraper.cloud/requests/your-request-id"
}

401

application/json

Wrong or missing API Key (token).

Response 401

{
  "error": true,
  "errorMessage": "401 Unauthorized: The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required."
}

402

application/json

Past due invoices or a payment method not connected.

Response 402

{
  "error": true,
  "errorMessage": "Please close past due invoices or verify your card information is correct."
}

422

application/json

Invalid query URL parameters.

Response 422

{
  "error": true,
  "errorMessage": "422 Unprocessable Entity: The request was well-formed but was unable to be followed due to semantic errors."
}

Code Samples

cURL

curl -X GET "https://api.outscraper.cloud/screenshoter?query=https://www.apple.com/iphone&async=false" -H  "X-API-KEY: YOUR-API-KEY"

cURL (async)

curl -X GET "https://api.outscraper.cloud/screenshoter?query=https://www.apple.com/iphone" -H  "X-API-KEY: YOUR-API-KEY"

Related Endpoints

/ai-scraper

Extracts the data you need from any web page by using AI. You can provide either a prompt for natural language instructions or a schema for structured JSON output, or both.

/company-insights

Finds company firmographics such as revenue, size, founding year, public status, etc.

/geocoding

Translates human readable addresses into locations on the map (latitude, longitude).

/reverse-geocoding

Translates locations on the map into human readable addresses.

/universal-scraper

Extracts the data you need from any web page by using AI.