/retty/users

POST /api/retty/users

Price: 1 credit

Get a reviewer profile from Retty (retty.me): name, introduction, status, review, following and follower counts, join date, specialities, favourite categories, review counts by area and genre, and yearly best picks

How to use it

User ids come from the author of retty reviews or from retty/users/search. retty/users/reviews lists everything the user wrote.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• user string required — Retty user id or user profile URL (examples: "2748093", "https://retty.me/author/2748093/"; minLength: 1)

Response

• @type string (default: "RettyUser")
• id string required
• url string required
• name string nullable
• introduction string nullable
• author_status string nullable
• review_count integer nullable
• following_count integer nullable
• follower_count integer nullable
• joined_at integer nullable
• last_review_at integer nullable
• specialities array (default: [])
• is_pro boolean nullable
• cover_photo_url string nullable
• familiar_categories array (default: [])
  • @type string (default: "RettyFamiliarCategory")
  • id string required
  • name string nullable
  • category_type string nullable
• reviews_by_area array (default: [])
  • @type string (default: "RettyReviewTally")
  • id string required
  • name string nullable
  • review_count integer nullable
• reviews_by_genre array (default: [])
  • @type string (default: "RettyReviewTally")
  • id string required
  • name string nullable
  • review_count integer nullable
• best_picks array (default: [])
  • @type string (default: "RettyBestPick")
  • year integer required
  • review_id string required
  • restaurant_id string nullable
  • restaurant_name string nullable
  • restaurant_url string nullable

Errors

• 422 — user is not a Retty user id or URL 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 — No Retty user under that id 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.