---
title: "list-scraper"
method: POST
path: "/api/list-scraper"
---

# list-scraper

`POST /api/list-scraper`

## List Scraper

Scrapes books from a Goodreads community-curated reading list using a direct list URL. Returns the list title, description, and all books included in the list along with their rankings.

---

## Request

**Method:** `POST`  
**URL:** `{{Instance Domain}}/api/list-scraper`

### Headers

| Key | Value | Description |
| --- | --- | --- |
| Content-Type | application/json | Indicates the request body is JSON |

### Body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| queryURL | string | Yes | The full Goodreads list page URL to scrape (e.g. `https://www.goodreads.com/list/show/18834.BBC_Top_200_Books`) |

**Example Body:**

```json
{
  "queryURL": "https://www.goodreads.com/list/show/18834.BBC_Top_200_Books"
}
```

---

## Response

### 200 Success

Returns a JSON object containing the list metadata and all books with their rankings.

```json
{
  "status": "Received",
  "statusCode": 200,
  ...
}
```

### Response Field Descriptions

| Field | Type | Description |
| --- | --- | --- |
| status | string | Human-readable status message |
| statusCode | number | HTTP status code of the response |
| listTitle | string | Title of the Goodreads reading list |
| listDescription | string | Description or summary of the reading list |
| books | array | All books in the list, each with ranking and metadata |

## Request body

- object
  - `queryURL` string, uri, required

## Response `200`

OK

- object
  - `status` string, required
  - `source` string, uri, required
  - `scrapeURL` string, uri, required
  - `title` string, required
  - `desc` string, required
  - `books` object[], required
    - `id` integer, required
    - `cover` string, uri, required
    - `title` string, required
    - `bookURL` string, required
    - `author` string, required
    - `authorURL` string, uri, required
    - `rating` string, required
  - `lastScraped` string, date-time, required

## Changes

- **2026-06-15** `6ef082114b12` — 1 info
  - endpoint added
- **2026-06-15** `9188f0ce7be6` — 1 breaking
  - api path removed without deprecation
- **2026-06-15** `6ef082114b12` — 1 info
  - endpoint added
- **2026-06-14** `539ea0e4fa2a` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/nesaku/apis/api-endpoints/changes/api/list-scraper/post.md)

---

[API](https://skmtc.dev/nesaku/apis/api-endpoints.md) · [All operations](https://skmtc.dev/nesaku/apis/api-endpoints/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nesaku/api-endpoints/revisions/182d9252d879/schema)