---
title: "Web search with optional scraping of each result"
method: POST
path: "/v1/search"
tags: ["Scrape"]
---

# Web search with optional scraping of each result

`POST /v1/search`

## Request

- Base URL: `https://search.elixpo.com`
- URL: `https://search.elixpo.com/v1/search`
- 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/search/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- object
  - `query` string, required
  - `limit` integer
  - `scrapeOptions` ScrapeOptions
    - `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`

Search results

- object
  - `success` boolean
  - `data` object[]
    - `url` string
    - `title` string
    - `description` string
    - `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

## Changes

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

[Operation history](https://skmtc.dev/elixpo/apis/lixsearch-api/changes/v1/search/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)