Skip to navigation

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

KeyValueDescription
Content-Typeapplication/jsonIndicates the request body is JSON

Body

FieldTypeRequiredDescription
queryURLstringYesThe full Goodreads series page URL to scrape (e.g. https://www.goodreads.com/series/45175-harry-potter)

Example Body:

{
  "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.

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

Response Field Descriptions

FieldTypeDescription
statusstringHuman-readable status message
statusCodenumberHTTP status code of the response
seriesTitlestringName of the book series
seriesDescriptionstringDescription or overview of the series
booksarrayOrdered 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