series-scraper

View as Markdown
## Series Scraper Scrapes series information and all books belonging to a series from a Goodreads series page using a direct series URL. Returns structured metadata about the series and each book within it. --- ## Request **Method:** `POST` **URL:** `{{Instance Domain}}/api/series-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 series page URL to scrape (e.g. `https://www.goodreads.com/series/45175-harry-potter`) | **Example Body:** ```json { "queryURL": "https://www.goodreads.com/series/45175-harry-potter" } ``` --- ## Response ### 200 Success Returns a JSON object containing the series metadata and all books in the series. ```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 | | seriesTitle | string | Name of the book series | | seriesDescription | string | Description or overview of the series | | books | array | Ordered list of books in the series, each with title, author, cover image, and Goodreads URL |

Request

This endpoint expects an object.
queryURLstringRequiredformat: "uri"

Response

OK