Skip to navigation

winners-list

View as Markdown

Winners List

Scrapes the list of winners from a Goodreads Choice Awards category page using a direct category URL. Returns structured information about all winning books in the specified awards category.


Request

Method: POST
URL: {{Instance Domain}}/api/awards/winners-list

Headers

KeyValueDescription
Content-Typeapplication/jsonIndicates the request body is JSON

Body

FieldTypeRequiredDescription
queryURLstringYesThe full Goodreads Choice Awards category page URL to scrape (e.g. https://www.goodreads.com/choiceawards/best-fiction-books-2023)

Example Body:

{
"queryURL": "https://www.goodreads.com/choiceawards/best-fiction-books-2023"
}

Response

200 Success

Returns a JSON object containing the list of winners from the specified Choice Awards category.

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

Response Field Descriptions

FieldTypeDescription
statusstringHuman-readable status message
statusCodenumberHTTP status code of the response
winnersarrayList of winning books in the awards category, each with title, author, and metadata

Request

This endpoint expects an object.
queryURLstringRequiredformat: "uri"

Response

OK
statusstring
sourcestringformat: "uri"
scrapeURLstringformat: "uri"
genreslist of objects
lastScrapeddatetime