list-scraper

View as Markdown
## 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

This endpoint expects an object.
queryURLstringRequiredformat: "uri"

Response

OK
statusstring
sourcestringformat: "uri"
scrapeURLstringformat: "uri"
titlestring
descstring
bookslist of objects
lastScrapeddatetime