---
title: "Extract structured data from HTML using CSS selectors"
method: POST
path: "/tools/scrape_structured"
tags: ["tools"]
---

# Extract structured data from HTML using CSS selectors

`POST /tools/scrape_structured`

## Request

- Base URL: `https://www.crawlforge.dev/api/v1`
- URL: `https://www.crawlforge.dev/api/v1/tools/scrape_structured`
- Auth: API key in header `X-API-Key`

## Request body

- union
  - object
    - `html` string, required: HTML content to extract data from
    - `url` string, uri: URL to fetch and extract data from
    - `selectors` object, required: Key-value pairs of field names and CSS selectors
    - `base_url` string, uri: Base URL for resolving relative URLs
    - `multiple` boolean: Extract multiple items vs single item
    - `clean_text` boolean: Clean extracted text by trimming whitespace
    - `include_attributes` string[]: HTML attributes to extract (e.g., href, src, alt)
    - `max_items` number: Maximum number of items to extract (for multiple mode)
    - `respect_robots` boolean
  - object
    - `html` string: HTML content to extract data from
    - `url` string, uri, required: URL to fetch and extract data from
    - `selectors` object, required: Key-value pairs of field names and CSS selectors
    - `base_url` string, uri: Base URL for resolving relative URLs
    - `multiple` boolean: Extract multiple items vs single item
    - `clean_text` boolean: Clean extracted text by trimming whitespace
    - `include_attributes` string[]: HTML attributes to extract (e.g., href, src, alt)
    - `max_items` number: Maximum number of items to extract (for multiple mode)
    - `respect_robots` boolean

## Response `200`

The tool's result; 2 credits charged (see x-credits-note and x-extra for add-ons).

- ToolSuccess: The envelope every tool returns on success. Credits are deducted only after the tool succeeded, so credits_used is the price of this call and an error response never charges.
  - `success` true, required
  - `data` object, required: The tool's result. Its shape is tool-specific and documented on the tool's docs page (x-docs-url on the operation).
  - `credits_used` integer, required: Credits charged for this call: the operation's x-credits, plus any add-on x-credits-note or x-extra describes.
  - `credits_remaining` integer, required: The account's credit balance after this call.
  - `processing_time` integer, required: Server-side processing time in milliseconds.
  - `warnings` string[]: Non-fatal notes: a robots.txt override that was recorded, a format that could not be produced, a redaction that changed the payload.

## Other responses

- `400`: VALIDATION_ERROR: the body does not match the request schema.
- `401`: MISSING_API_KEY or INVALID_API_KEY.
- `402`: INSUFFICIENT_CREDITS: the balance does not cover the tool's base price. X-Auto-Recharge-Triggered says whether an automatic recharge was started; retry once it lands.
- `429`: RATE_LIMIT_EXCEEDED: your plan's rate limit. Retry-After: 60.
- `500`: TOOL_ERROR, INTERNAL_ERROR or CREDIT_DEDUCTION_FAILED.
- `default`: Any other error. Which of 403, 404, 413, 422, 501, 502, 503 and 504 a tool can return depends on what it does (fetching a page, calling the execution backend, reading stored results); the code vocabulary is listed on the ErrorResponse schema.

---

[API](https://skmtc.dev/crawlforge/apis/crawlforge-rest-api.md) · [All operations](https://skmtc.dev/crawlforge/apis/crawlforge-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlforge/apis/crawlforge-rest-api/revisions/a5532fa8d5d5?raw)