Skip to navigation

reviews-scraper

View as Markdown

Reviews Scraper

Scrapes reader reviews for a book from a Goodreads book page using a direct book URL. Returns structured review data including reviewer details, ratings, and review text.


Request

Method: POST
URL: {{Instance Domain}}/api/reviews-scraper

Headers

KeyValueDescription
Content-Typeapplication/jsonIndicates the request body is JSON

Body

FieldTypeRequiredDescription
queryURLstringYesThe full Goodreads book page URL to scrape reviews from (e.g. https://www.goodreads.com/book/show/5907)

Example Body:

{
"queryURL": "https://www.goodreads.com/book/show/5907"
}

Response

200 Success

Returns a JSON object containing the scraped reviews for the specified book.

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

Response Field Descriptions

FieldTypeDescription
statusstringHuman-readable status message
statusCodenumberHTTP status code of the response
reviewsarrayList of reader reviews, each with reviewer name, star rating, review text, and date

Request

This endpoint expects an object.
resourceIDstringRequired
legacyBookIDany or nullOptional
nextPageTokenany or nullOptional

Response

OK
statusstring
statusCodeinteger
sourcestringformat: "uri"
scrapeURLstringformat: "uri"
totalCountinteger
nextPageTokenstring
prevPageTokenstring
reviewslist of objects
lastScrapeddatetime