> For the complete documentation index, see [llms.txt](https://developers.oxylabs.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.oxylabs.io/products/web-scraper-api/faq.md).

# FAQ

Frequently asked questions about Oxylabs Web Scraper API

Find answers to common Web Scraper API questions. Look through the table of contents on the right or scroll down to find your answers.

### How do I start using Web Scraper API?

Create an [Oxylabs Dashboard account](https://dashboard.oxylabs.io/en/) and select Web Scraper API. Choose a trial or subscription, then create an API user. Use that user's credentials to authorize requests.

Send your first request through a terminal, Postman, or another HTTP client. Use the [Web Scraper API Playground](https://developers.oxylabs.io/products/web-scraper-api/web-scraper-api-playground.md) to build and test requests without writing code.

### Which integration method should I use?

Web Scraper API offers three integration methods:

* **Realtime** keeps a connection open until the result is ready.
* **Push-Pull** creates asynchronous jobs for larger workloads.
* **Proxy Endpoint** provides a proxy-style endpoint for synchronous requests.

Use Realtime or Proxy Endpoint for simpler synchronous workflows. Use Push-Pull when you need asynchronous processing or cloud delivery. See [Integration Methods](https://developers.oxylabs.io/products/web-scraper-api/integration-methods.md) for request examples.

### What features does Web Scraper API support?

Web Scraper API supports OxyCopilot, cloud delivery, batch queries, Custom Parser, and Scheduler. It also supports browser instructions, Fetch/XHR capture, and Markdown output.

Use cloud delivery for Amazon S3, Google Cloud Storage, Alibaba OSS, or compatible storage. Batch jobs support up to 5,000 `query` or `url` values. See [Features](https://developers.oxylabs.io/products/web-scraper-api/features.md) for configuration details.

### Can I test Web Scraper API before integrating?

Yes, you can use the [Web Scraper API Playground](https://developers.oxylabs.io/products/web-scraper-api/web-scraper-api-playground.md) in the Legacy Oxylabs Dashboard. Enter a query or URL, configure request parameters, and inspect the result.

The Playground can generate request code for your implementation. It also helps you test parsing, JavaScript rendering, localization, and browser instructions.

### How do I manage Web Scraper API in the Dashboard?

Open **My Products** and select Web Scraper API. Use **Statistics** to review usage and **Users** to manage API credentials.

You can configure spending limits, top up available results, change a subscription, or manage payment details. Use the [Web Scraper API Playground](https://developers.oxylabs.io/products/web-scraper-api/web-scraper-api-playground.md) to test requests from the Dashboard.

### Are any targets restricted?

Some websites are restricted to prevent misuse and support responsible data collection. See [Restricted Targets](https://developers.oxylabs.io/products/web-scraper-api/restricted-targets.md) for the current list.

Selected targets may become available after a KYC review. Contact your account manager or [Oxylabs Support](mailto:support@oxylabs.io) to request access.

### How does Web Scraper API pricing work?

Subscriptions include a monthly result allowance. A result is successfully retrieved content, such as page HTML.

Responses with `2xx` or `4xx` target status codes count as successful results. System-error responses with `5xx` or `6xx` codes do not incur result charges.

Allowances depend on the target category, plan, and JavaScript-rendering requirements. See [Traffic and Billing](https://developers.oxylabs.io/products/web-scraper-api/usage-and-billing/billing-information.md) for billing details. Contact your account manager for plan-specific allowances.

### What response codes can Web Scraper API return?

Web Scraper API returns standard API and parser-specific response codes. Use the response body to diagnose invalid requests and authorization errors. See [Response Codes](https://developers.oxylabs.io/products/web-scraper-api/response-codes.md) for the full reference.

Common API codes include:

* `200` – request completed successfully.
* `202` – request accepted for processing.
* `400`, `401`, `403`, or `422` – request or authorization issue.
* `429` – rate limit reached.
* `500`, `524`, `612`, or `613` – system or processing issue.

Retry faulted `612` or `613` jobs. Contact [Oxylabs Support](mailto:support@oxylabs.io) when you need higher rate limits.

### Where can I find my scraping job ID?

For Realtime and Proxy Endpoint requests, find `job_id` in the response. You can also use the `x-oxylabs-job-id` response header.

For Push-Pull requests, use the `id` field. Job IDs remain available for 48 hours.

### Which targets support parsed data?

Web Scraper API returns parsed JSON for supported target page types. Supported targets include Google, Google Shopping, Amazon, YouTube, ChatGPT, Perplexity, Bing, Walmart, Best Buy, Etsy, and Target.

Use [Custom Parser](https://developers.oxylabs.io/products/web-scraper-api/features/custom-parser.md) for other targets. You can save parsers as reusable presets. OxyCopilot can generate parsing logic from plain-language instructions.

### What targets can I scrape?

Web Scraper API supports popular target-specific scrapers and universal web scraping. Browse [Targets](https://developers.oxylabs.io/products/web-scraper-api/targets.md) or use the API Playground to test your target.

Use a target-specific source when available. Use the `universal` source with a target URL for other public websites.

### Can I automate browser actions?

Yes. [JS Rendering & Browser Control](https://developers.oxylabs.io/products/web-scraper-api/features/js-rendering-and-browser-control.md) can render JavaScript and automate clicks, scrolling, text input, and other browser actions.

Create instructions manually or in the Playground. You can also generate them with OxyCopilot from a plain-language prompt.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.oxylabs.io/products/web-scraper-api/faq.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
