> 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/pt-br/api-da-web/scrape.md).

# /scrape

Aprenda a usar o endpoint /scrape da Oxylabs Web API para buscar e analisar qualquer página da web no formato que você quiser.

A `/v1/scrape` endpoint busca páginas da web por URL, lidando automaticamente com renderização headless, rotação de proxy, desafios de acesso e localização. Ele retorna dados estruturados da página em Markdown, HTML, JSON ou como capturas de tela PNG.

## Exemplo de solicitação

O endpoint aceita um payload JSON que define a URL de destino, os formatos de saída solicitados, as opções de renderização e o contexto de geolocalização.

```bash
curl https://webapi.oxylabs.io/v1/scrape \
  -H "Authorization: Bearer $OXYLABS_WEB_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
      "url": "https://artificialintelligenceact.eu/implementation-timeline/",
      "output": ["markdown"]
  }'
```

### Parâmetros da solicitação

<table><thead><tr><th width="98">Parâmetro</th><th width="566">Descrição</th><th width="93">Tipo</th></tr></thead><tbody><tr><td><mark style="background-color:green;"><code>url</code></mark></td><td>Absoluto <code>http</code> / <code>https</code> URL de destino.</td><td>cadeia de caracteres</td></tr><tr><td><code>output</code></td><td>Formato de resposta: <code>markdown</code>, <code>html</code>, <code>json</code>, <code>screenshot</code>. Suporta vários valores. Padrão: <code>html</code></td><td>array de strings</td></tr><tr><td><code>json</code></td><td>Quando <code>output: ["json"]</code>, pode ser usado para análise personalizada por IA por meio de <code>prompt</code> or <code>schema</code>. Veja <a href="https://developers.oxylabs.io/products/pt-br/api-da-web/scrape/analise-por-ia.md">Análise por IA</a>.</td><td>objeto</td></tr><tr><td><code>location</code></td><td>Código de país ISO 3166-1 alfa-2 de duas letras (por exemplo, <code>"US"</code>, <code>"DE"</code>, <code>"JP"</code>).</td><td>cadeia de caracteres</td></tr><tr><td><code>device</code></td><td>Emulação de User-Agent e viewport: <code>"desktop"</code> (padrão) ou <code>"mobile"</code>. </td><td>cadeia de caracteres</td></tr><tr><td><code>run_js</code></td><td>Ativa a renderização de JavaScript quando definido como <code>true</code>. Padrão: <code>false</code>.</td><td>booleano</td></tr></tbody></table>

&#x20;    – parâmetro obrigatório.

<details>

<summary><strong><code>output</code></strong></summary>

A `output` array permite buscar vários formatos de saída em uma única execução da requisição. Abaixo está um exemplo de solicitação de saída combinada:

```json
{
  "url": "https://example.com/product",
  "output": ["markdown", "json"],
  "json": {
    "prompt": "Extract the product name, stock status, and price as a number."
  }
}
```

<table data-header-hidden><thead><tr><th width="119"></th><th></th></tr></thead><tbody><tr><td><code>markdown</code></td><td>Converte a árvore DOM em Markdown limpo e estruturado, removendo scripts de navegação e formatação de estilo. Otimizado para ingestão em janelas de contexto de LLM para minimizar o uso de tokens.</td></tr><tr><td><code>html</code></td><td>O markup bruto da página. Use-o quando precisar do próprio markup (atributos, JSON-LD incorporado, dados inline). Não recomendado para coleta de conteúdo da página.</td></tr><tr><td><code>screenshot</code></td><td>Imagem PNG codificada em Base64 da página totalmente renderizada. <strong><code>run_js: true</code> é obrigatório</strong>, caso contrário a requisição é rejeitada.</td></tr><tr><td><code>json</code></td><td>Extração estruturada na mesma requisição que a busca (sem seletores para escrever ou manter). Usa um parser dedicado (para destinos suportados) ou <a href="https://developers.oxylabs.io/products/pt-br/api-da-web/scrape/analise-por-ia.md">análise por IA</a> descrevendo os campos em um <code>prompt</code>, ou fixar sua forma exata com um <code>schema</code>.</td></tr></tbody></table>

{% hint style="info" %}
**Exceção:** `vídeo` formato de saída está disponível apenas para `/scrape/media` [raspadores dedicados](https://developers.oxylabs.io/products/pt-br/api-da-web/scrape/raspadores-dedicados.md).
{% endhint %}

</details>

<details>

<summary><strong><code>run_js</code></strong></summary>

Executa o JavaScript próprio da página antes que o conteúdo seja capturado.

Ao omitir `run_js` usa o caminho de execução ideal para o caminho de origem fornecido. Definir explicitamente `"run_js": true` usa uma instância de navegador headless para executar scripts do lado do cliente, solicitações XHR dinâmicas e renderização de Single Page Application (SPA).

```json
{
  "url": "https://example.com/spa-dashboard",
  "output": ["markdown"],
  "run_js": true
}
```

* **Impacto na latência:** A renderização em headless browser aumenta significativamente a duração da requisição. Defina timeouts HTTP do cliente para pelo menos `150` segundos. Quando for necessário alto volume, [entrega assíncrona](https://developers.oxylabs.io/products/pt-br/api-da-web/scrape/modos-de-entrega.md) é recomendada.
* **Otimização de recursos:** Sempre tente buscar o conteúdo sem ele. Para páginas estáticas ou feeds RSS/Atom, passe `"run_js": false` para maximizar a taxa de transferência das requisições e minimizar a latência. Escolha a renderização apenas quando necessário.

</details>

<details>

<summary><strong><code>location</code></strong></summary>

O geo-targeting roteia as requisições por nós de saída de proxy localizados. Isso garante que preços localizados, variações de idioma e conteúdo exclusivo da região sejam entregues corretamente.

```json
{
  "url": "https://example.com/pricing",
  "output": ["html"],
  "location": "DE",
  "check_empty_geo": true
}
```

{% hint style="info" %}
Ao usar [Raspadores dedicados](https://developers.oxylabs.io/products/pt-br/api-da-web/scrape/raspadores-dedicados.md), alguns parâmetros de localização podem ter nomes diferentes.
{% endhint %}

</details>

## Exemplo de saída

Uma requisição bem-sucedida retorna um HTTP `200 OK` status com um envelope padrão. Campos dentro de `results[]` com formatos de saída não solicitados retornam `null`.

```json
{
  "status": 200,
  "results": [
    {
      "html": null,
      "markdown": "# Implementation Timeline\n\nProviders need to be compliant...",
      "screenshot": null,
      "json": null,
      "metadata": {
        "page": 1,
        "run_js": false,
        "url": "https://artificialintelligenceact.eu/implementation-timeline/"
      }
    }
  ],
  "params": {
    "url": "https://artificialintelligenceact.eu/implementation-timeline/",
    "output": ["markdown"],
    "json": { "schema": null, "prompt": null },
    "location": null,
    "device": "desktop",
    "run_js": null
  },
  "metadata": {
    "timestamp": 1787431568,
    "request_id": "7503078851572948993"
  }
}
```

{% hint style="info" %}
**`results[]` campo com formatos de saída não solicitados retornam `null`.** \
Por exemplo, solicitar `["markdown"]` preenche `markdown` e deixa `html`, `screenshot` e `json` como null. Qualquer [raspador dedicado](https://developers.oxylabs.io/products/pt-br/api-da-web/scrape/raspadores-dedicados.md) coloca seus campos estruturados em `json`.
{% endhint %}

### Dicionário de saída

<table><thead><tr><th width="208">Campo</th><th>Descrição</th><th width="92">Tipo</th></tr></thead><tbody><tr><td><code>status</code></td><td>código de status HTTP, <code>200</code> em caso de sucesso. Veja <a href="https://developers.oxylabs.io/products/pt-br/api-da-web/solucao-de-problemas.md">Códigos de erro</a>.</td><td>inteiro</td></tr><tr><td><code>resultados</code></td><td>Uma entrada para a URL solicitada.</td><td>vetor</td></tr><tr><td><code>results[].markdown</code></td><td>Página em Markdown, se solicitado. <code>null</code> caso contrário.</td><td>cadeia de caracteres</td></tr><tr><td><code>results[].html</code></td><td>Markup bruto do resultado, se solicitado. <code>null</code> caso contrário.</td><td>cadeia de caracteres</td></tr><tr><td><code>results[].json</code></td><td>Campos analisados por um <a href="https://developers.oxylabs.io/products/pt-br/api-da-web/scrape/raspadores-dedicados.md">raspador dedicado</a> or <a href="https://developers.oxylabs.io/products/pt-br/api-da-web/scrape/analise-por-ia.md">analisador de IA</a>, se solicitado <code>null</code> caso contrário.</td><td>objeto</td></tr><tr><td><code>results[].screenshot</code></td><td>String de imagem codificada em Base64, se solicitado. <code>null</code> caso contrário.</td><td>cadeia de caracteres</td></tr><tr><td><code>results[].metadata.url</code></td><td>URL obtida para raspagem após redirecionamentos.</td><td>cadeia de caracteres</td></tr><tr><td><code>params</code></td><td>Todos os parâmetros usados nas requisições com padrões aplicados.</td><td>objeto</td></tr><tr><td><code>metadata.timestamp</code></td><td>Timestamp Unix em segundos.</td><td>inteiro</td></tr><tr><td><code>metadata.request_id</code></td><td>Identificador desta requisição. <strong>Inclua-o em tickets de suporte.</strong></td><td>cadeia de caracteres</td></tr></tbody></table>

## Latência e concorrência

Uma raspagem renderiza uma página real com orçamento em **segundos, não milissegundos**. Recomendamos algumas práticas seguras para contornar isso:

<table data-header-hidden><thead><tr><th width="123"></th><th></th></tr></thead><tbody><tr><td><strong>Timeout do cliente</strong></td><td>150 segundos é um padrão seguro, enquanto um timeout de 10 segundos pode falhar em páginas que teriam funcionado. Para maior volume (por exemplo, mídia, grandes execuções de SERP etc.), com risco de timeout do cliente, execute os mesmos scrapers com entrega assíncrona em vez de bloquear a requisição. Veja <a href="https://developers.oxylabs.io/products/pt-br/api-da-web/scrape/modos-de-entrega.md">Modos de entrega</a>.</td></tr><tr><td><strong>Limite de concorrência</strong></td><td>Raspar dez resultados de busca em paralelo multiplica o custo e a latência de páginas que você não vai ler. Raspe os dois ou três que plausivelmente respondem à pergunta e aumente a concorrência apenas gradualmente até <code>429</code> o erro ser alcançado.</td></tr></tbody></table>

## Raspadores dedicados

Além da raspagem genérica por URL, raspadores específicos de alvo podem ser usados com `POST /v1/scrape/{target}/{collection}`. Eles aceitam parâmetros específicos do alvo (por exemplo, ASINs, browse nodes, códigos postais de lojas) e retornam campos estruturados em `results[].json`:

```bash
curl https://webapi.oxylabs.io/v1/scrape/amazon/product \
  -H "Authorization: Bearer $OXYLABS_WEB_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "B0935DN1BN",
    "output": ["json"],
    "location": "10115",
    "domain": "de",
    "currency": "EUR"
  }'
```

Veja [Raspadores dedicados](https://developers.oxylabs.io/products/pt-br/api-da-web/scrape/raspadores-dedicados.md) para visões gerais dos alvos (Google, Amazon, YouTube, Bing, IA e LLMs, Commerce, etc.).


---

# 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/pt-br/api-da-web/scrape.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.
