Skip to navigation

search-books

View as Markdown

Search Books

Searches Goodreads for books matching a given query string. Returns a list of matching books with their metadata, useful for discovering books by title, author, or keyword.


Request

Method: POST
URL: {{Instance Domain}}/api/search/books

Headers

KeyValueDescription
Content-Typeapplication/jsonIndicates the request body is JSON

Body

FieldTypeRequiredDescription
querystringYesThe search term to look up on Goodreads (e.g. "Harry Potter")

Example Body:

{
"query": "Harry Potter"
}

Response

200 Success

Returns a JSON object containing a list of books matching the search query.

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

Response Field Descriptions

FieldTypeDescription
statusstringHuman-readable status message
statusCodenumberHTTP status code of the response
resultsarrayList of books matching the search query, each with title, author, cover image, and Goodreads URL

Request

This endpoint expects an object.
queryURLstringRequiredformat: "uri"

Response

OK
statusstring
sourcestringformat: "uri"
apiURLstringformat: "uri"
searchTypestring
numberOfResultsstring
resultlist of objects
lastScrapeddatetime