> 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/web-scraper-api/features/custom-parser.md). # Custom Parser Custom Parser é um recurso gratuito do Web Scraper API que permite que você **crie lógica de parsing e processamento de dados** que é executada em um resultado HTML bruto. Você pode gerar parsers automaticamente usando IA ou escrevê-los manualmente para cenários avançados. Para instruções detalhadas e exemplos, consulte estas páginas: Como começar Gerando parsers via API Predefinições de Parser Escrevendo instruções manualmente Lista de funções de parsing *** ## Início rápido ### 1. Gere um parser Recomendamos começar com nossa ferramenta com IA, [**OxyCopilot**](/products/pt-br/web-scraper-api/web-scraper-api-playground/oxycopilot.md) ferramenta que permite gerar scrapers e parsers sem escrever nenhum código. {% hint style="success" %} Para acessar o OxyCopilot, faça login no [**painel da Oxylabs**](https://dashboard.oxylabs.io/en/) e selecione **Scraper APIs Playground** no menu lateral. {% endhint %} Siga os passos mostrados no vídeo para **gerar um parser**: {% embed url="" %} Aqui estão os mesmos passos mostrados no vídeo: 1. **Insira a(s) URL(s)** que você quer raspar e analisar 2. **Especifique quaisquer parâmetros** como renderização de JavaScript 3. **Escreva um prompt** que descreve o que você quer analisar 4. **Executar** OxyCopilot Quando estiver satisfeito com o parser gerado, carregue as instruções. ### 2. Salve o parser como um preset Você pode salvar facilmente seus parsers gerados pelo OxyCopilot para uso posterior. Veja os passos abaixo: {% embed url="" %} 1. **Atribua o preset** a um usuário específico da API 2. Clique em **Salvar** 3. **Digite o nome do preset** e a descrição (opcional) Depois de salvar o preset, você pode usá-lo com solicitações da API. ### 3. Use o parser com solicitações da API Para usar seu preset com Web Scraper API, envie um payload com o parâmetro `parser_preset` definido como o nome do seu preset. Nos exemplos de código abaixo, estamos reutilizando o preset `example_parser` criado nas etapas anteriores. {% tabs %} {% tab title="cURL" %} ```shell curl 'https://realtime.oxylabs.io/v1/queries' \\ --user 'USERNAME:PASSWORD' \\ -H 'Content-Type: application/json' \\ -d '{ "source": "universal", "url": "https://example.com/", "parse": true, "parser_preset": "example_parser" }' ``` {% endtab %} {% tab title="Python" %} ```python import requests from pprint import pprint # Set the parser preset to use. payload = { 'source': 'universal', 'url': 'https://example.com/', 'parse': True, 'parser_preset': 'example_parser' } # Get a response. response = requests.request( 'POST', 'https://realtime.oxylabs.io/v1/queries', auth=('USERNAME', 'PASSWORD'), json=payload ) # Print prettified response to stdout. pprint(response.json()) ``` {% endtab %} {% tab title="Node.js" %} ```javascript const https = require("https"); const username = "USERNAME"; const password = "PASSWORD"; const body = { source: "universal", url: "https://example.com/", parse: true, parser_preset: "example_parser" }; const options = { hostname: "realtime.oxylabs.io", path: "/v1/queries", method: "POST", headers: { "Content-Type": "application/json", Authorization: "Basic " + Buffer.from(`${username}:${password}`).toString("base64"), }, }; const request = https.request(options, (response) => { let data = ""; response.on("data", (chunk) => { data += chunk; }); response.on("end", () => { const responseData = JSON.parse(data); console.log(JSON.stringify(responseData, null, 2)); }); }); request.on("error", (error) => { console.error("Error:", error); }); request.write(JSON.stringify(body)); request.end(); ``` {% endtab %} {% tab title="HTTP" %} ```http Toda a string que você enviar precisa ser codificada em URL. https://realtime.oxylabs.io/v1/queries?source=universal&url=https%3A%2F%2Fexample.com%2F&parse=true&parser_preset=example_parser&access_token=12345abcde ``` {% endtab %} {% tab title="PHP" %} ```php 'universal', 'url' => 'https://example.com/', 'parse' => true, 'parser_preset' => 'example_parser' ); $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://realtime.oxylabs.io/v1/queries"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params)); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_USERPWD, "USERNAME" . ":" . "PASSWORD"); $headers = array(); $headers[] = "Content-Type: application/json"; curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); $result = curl_exec($ch); echo $result; if (curl_errno($ch)) { echo 'Error:' . curl_error($ch); } curl_close($ch); ``` {% endtab %} {% tab title="Golang" %} ```go package main import ( "bytes" "encoding/json" "fmt" "io/ioutil" "net/http" ) func main() { const Username = "USERNAME" const Password = "PASSWORD" payload := map[string]interface{}{ "source": "universal", "url": "https://example.com/", "parse": true, "parser_preset": "example_parser", } jsonValue, _ := json.Marshal(payload) client := &http.Client{} request, _ := http.NewRequest("POST", "https://realtime.oxylabs.io/v1/queries", bytes.NewBuffer(jsonValue), ) request.SetBasicAuth(Username, Password) response, _ := client.Do(request) responseText, _ := ioutil.ReadAll(response.Body) fmt.Println(string(responseText)) } ``` {% endtab %} {% tab title="C#" %} ```csharp using System; using System.Collections.Generic; using System.Net.Http; using System.Net.Http.Json; using System.Threading.Tasks; namespace OxyApi { class Program { static async Task Main() { const string Username = "USERNAME"; const string Password = "PASSWORD"; var parameters = new { source = "universal", url = "https://example.com/", parse = true, parser_preset = "example_parser" }; var client = new HttpClient(); Uri baseUri = new Uri("https://realtime.oxylabs.io"); client.BaseAddress = baseUri; var requestMessage = new HttpRequestMessage(HttpMethod.Post, "/v1/queries"); requestMessage.Content = JsonContent.Create(parameters); var authenticationString = $"{Username}:{Password}"; var base64EncodedAuthenticationString = Convert.ToBase64String(System.Text.ASCIIEncoding.UTF8.GetBytes(authenticationString)); requestMessage.Headers.Add("Authorization", "Basic " + base64EncodedAuthenticationString); var response = await client.SendAsync(requestMessage); var contents = await response.Content.ReadAsStringAsync(); Console.WriteLine(contents); } } } ``` {% endtab %} {% tab title="Java" %} ```java package org.example; import okhttp3.*; import org.json.JSONObject; import java.util.concurrent.TimeUnit; public class Main implements Runnable { private static final String AUTHORIZATION_HEADER = "Authorization"; public static final String USERNAME = "USERNAME"; public static final String PASSWORD = "PASSWORD"; public void run() { JSONObject jsonObject = new JSONObject(); jsonObject.put("source", "universal"); jsonObject.put("url", "https://example.com/"); jsonObject.put("parse", true); jsonObject.put("parser_preset", "example_parser"); Authenticator authenticator = (route, response) -> { String credential = Credentials.basic(USERNAME, PASSWORD); return response .request() .newBuilder() .header(AUTHORIZATION_HEADER, credential) .build(); }; var client = new OkHttpClient.Builder() .authenticator(authenticator) .readTimeout(180, TimeUnit.SECONDS) .build(); var mediaType = MediaType.parse("application/json; charset=utf-8"); var body = RequestBody.create(jsonObject.toString(), mediaType); var request = new Request.Builder() .url("https://realtime.oxylabs.io/v1/queries") .post(body) .build(); try (var response = client.newCall(request).execute()) { if (response.body() != null) { try (var responseBody = response.body()) { System.out.println(responseBody.string()); } } } catch (Exception exception) { System.out.println("Error: " + exception.getMessage()); } System.exit(0); } public static void main(String[] args) { new Thread(new Main()).start(); } } ``` {% endtab %} {% tab title="JSON" %} ```json { "source": "universal", "url": "https://example.com/", "parse": true, "parser_preset": "example_parser" } ``` {% endtab %} {% endtabs %}
Exemplo de saída ```json { "results": [ { "content": { "title": "Example Domain", "parse_status_code": 12000 }, "created_at": "2025-10-24 10:04:59", "updated_at": "2025-10-24 10:05:00", "page": 1, "url": "https://example.com/", "job_id": "7387428891226308609", "is_render_forced": false, "status_code": 200, "type": "parsed", "parser_type": "preset", "parser_preset": "example_parser" } ] } ```
## Obtendo o conteúdo HTML de um job analisado Você também pode recuperar o resultado HTML bruto adicionando `?type=raw` ao final da URL de recuperação do resultado. Leia mais [**aqui**](/products/pt-br/web-scraper-api/integration-methods/push-pull.md#endpoints). --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://developers.oxylabs.io/products/pt-br/web-scraper-api/features/custom-parser.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.