Skip to navigation

questions-scraper

View as Markdown

Questions Scraper

Scrapes community Q&A questions for a book from its Goodreads questions page. Returns a list of questions and answers submitted by the Goodreads community.


Request

Method: POST
URL: {{Instance Domain}}/api/works/questions

Headers

KeyValueDescription
Content-Typeapplication/jsonIndicates the request body is JSON

Body

FieldTypeRequiredDescription
queryURLstringYesThe full Goodreads book questions page URL (e.g. https://www.goodreads.com/book/5907/questions)

Example Body:

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

Response

200 Success

Returns a JSON object containing the scraped questions and answers.

{
"status": "Received",
"statusCode": 200,
"scrapeURL": "string",
"questions": [
{
"question": "string",
"askedBy": "string",
"answers": [
{
"answer": "string",
"answeredBy": "string",
"likes": "string"
}
]
}
]
}

Response Field Descriptions

FieldTypeDescription
statusstringHuman-readable status message
statusCodenumberHTTP status code of the scrape operation
scrapeURLstringThe Goodreads URL that was scraped
questionsarrayList of community questions for the book
questions[].questionstringThe question text
questions[].askedBystringUsername of the person who asked the question
questions[].answersarrayList of answers to the question
questions[].answers[].answerstringThe answer text
questions[].answers[].answeredBystringUsername of the person who answered
questions[].answers[].likesstringNumber of likes on the answer

Request

This endpoint expects an object.
queryURLstringRequiredformat: "uri"

Response

OK
statusstring
sourcestringformat: "uri"
scrapeURLstringformat: "uri"
imagestringformat: "uri"
bookstring
bookURLstring
authorstring
questionslist of objects
unansweredQuestionslist of objects
lastScrapeddatetime