---
title: "Batch scrape status and results"
method: GET
path: "/v1/batch/scrape/{id}"
tags: ["Scrape"]
---

# Batch scrape status and results

`GET /v1/batch/scrape/{id}`

## Request

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

## Query parameters

- `skip` integer

## Response `200`

Batch status

- ScrapeJobStatus
  - `success` boolean
  - `status` 'scraping' | 'completed' | 'failed' | 'cancelled'
  - `total` integer
  - `completed` integer
  - `expiresAt` string, date-time
  - `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
  - `next` string: URL of the next page of results (when more than one page is stored)

## Other responses

- `404`: Job not found or expired

## Changes

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

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