---
title: "Scrape one URL"
method: POST
path: "/v1/scrape"
tags: ["Scrape"]
---

# Scrape one URL

`POST /v1/scrape`

## Request

- Base URL: `https://search.elixpo.com`
- URL: `https://search.elixpo.com/v1/scrape`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`
  - API key in query parameter `key`
- TypeScript: <https://skmtc.dev/elixpo/apis/lixsearch-api/docs/v1/scrape/post.ts> (a function with typed inputs; its response is checked against the schema)

Returns markdown, HTML, links, a screenshot or LLM-extracted JSON for a public http(s) URL. Private, loopback, link-local and metadata addresses are rejected, including on redirects.

## Request body

- object
  - `url` string, uri, required
  - `formats` ScrapeFormat[]
    - union
      - 'markdown' | 'html' | 'rawHtml' | 'links' | 'screenshot' | 'screenshot@fullPage' | 'json'
      - object
        - `type` 'json', required
        - `schema` object: JSON Schema the extracted object should follow
        - `prompt` string
  - `onlyMainContent` boolean
  - `waitFor` integer: Milliseconds to wait after load (forces browser rendering)
  - `timeout` integer

## Response `200`

Scraped page

- object
  - `success` boolean
  - `data` ScrapeDocument
    - `markdown` string
    - `html` string
    - `rawHtml` string
    - `links` string[]
    - `screenshot` string: PNG as a data URI
    - `json` object
    - `metadata` ScrapeMetadata
      - `title` string
      - `description` string
      - `language` string
      - `sourceURL` string
      - `url` string
      - `statusCode` integer, nullable
      - `error` string: Present only on failed crawl/batch pages

## Other responses

- `400`: Invalid request or URL rejected by the SSRF guard
- `401`: API key required
- `408`: Target site or upstream service failed or timed out
- `502`: Target site or upstream service failed or timed out

## Changes

- **2026-10-27** `dee7777b8958`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/elixpo/apis/lixsearch-api/changes/v1/scrape/post.md)

---

[API](https://skmtc.dev/elixpo/apis/lixsearch-api.md) - [All operations](https://skmtc.dev/elixpo/apis/lixsearch-api/llms.txt) - [OpenAPI document](https://skmtc.dev/elixpo/apis/lixsearch-api/revisions/dee7777b8958?raw)