/goodreads/books/reviews

POST /api/goodreads/books/reviews

Price: 20 credits

Get Goodreads (goodreads.com) book reviews by book id, with rating/sort/language/text filters

How to use it

Get user reviews of a Goodreads (goodreads.com) book by id. Filter by rating (1-5 stars), sort (DEFAULT/NEWEST/OLDEST), language (ISO code), text search, or a specific edition. Returns rating, text, dates, like_count, comment_count, shelf, tags, and reviewer profile.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• book string required — Goodreads book id ('5907'), id with slug ('5907.The_Hobbit') or full book URL. (examples: "5907", "5907.The_Hobbit"; minLength: 1; pattern: ^(?:https?://[^\s]+|(?:www\.)?goodreads\.com[^\s]*|\d[\w.\-]*|\d+)$)
• count integer required — Max number of reviews to return (min: 1)
• rating integer nullable — Filter reviews by star rating (min: 1; max: 5)
• sort string — Review sort order (default: "DEFAULT"; one of: "DEFAULT", "NEWEST", "OLDEST")
• language string nullable — Filter reviews by ISO language code (e.g. 'en', 'fr', 'es') (examples: "en", "fr")
• text string nullable — Filter reviews by text search
• edition string nullable — Filter reviews by a specific edition id (Goodreads book id from the editions endpoint)

Response

• @type string (default: "GoodreadsReview")
• id string required
• rating integer nullable
• text string nullable
• created_at integer nullable
• updated_at integer nullable
• is_spoiler boolean nullable
• like_count integer nullable
• comment_count integer nullable
• shelf string nullable
• tags array (default: [])
• reviewer object nullable
  • @type string (default: "GoodreadsReviewer")
  • id integer nullable
  • name string nullable
  • image string nullable
  • url string nullable
  • follower_count integer nullable
  • review_count integer nullable
  • is_author boolean nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Book not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.