/openrice/users

POST /api/openrice/users

Price: 1 credit

Get an OpenRice reviewer profile by profile GUID, numeric user id or profile URL: username, self-written bio, avatar and cover image, membership level, VIP and vlogger flags, registration country and date, follower and following counts, profile views, review, photo, media and bookmark counters, plus the country codes the member is active in.

How to use it

Fetch one OpenRice member profile. Accepts the profile GUID from /user/{guid} URLs, the numeric user id seen inside review payloads, or a full profile URL. Returns username, bio, image, grade/grade_name, review_count, photo_count, follower_count, following_count, bookmarked_restaurant_count, registered_at and active_review_countries. Useful for judging reviewer authority.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• region string — OpenRice regional market the request is scoped to (default: "hongkong"; one of: "hongkong", "macau", "shenzhen", "guangzhou", "zhuhai", "dongguan", "foshan", "zhongshan", "taipei", "newtaipei-keelung", "taoyuan", "hsinchu-miaoli", "taichung", "changhua-nantou", "yunlin-chiayi", "tainan", "kaohsiung-pingtung", "eastern", "tokyo-kanto", "osaka-kobe", "kyoto-kinki", "nagoya-chubu", "hokkaido", "tohoku", "hiroshima-chugoku", "shikoku", "fukuoka-kyushu", "okinawa", "bangkok", "chonburi", "phuket", "prachuapkhirikhan", "chiangmai", "suratthani", "nakhonratchasima", "chiangrai", "others", "singapore", "manila")
• lang string — Content language for names, addresses and category labels (default: "en"; one of: "en", "tc", "sc", "tc-tw", "ja", "th", "id")
• user string required — Reviewer profile GUID, numeric user id or profile URL (examples: "0494b132-9684-4d1e-9d2c-2448f2ff0139", "248554", "https://www.openrice.com/en/user/0494b132-9684-4d1e-9d2c-2448f2ff0139"; minLength: 1)

Response

• @type string (default: "OpenriceUser")
• id integer required
• sso_id string nullable
• url string nullable
• username string nullable
• bio string nullable
• image string nullable
• cover string nullable
• region_id integer nullable
• register_country string nullable
• registered_at integer nullable
• grade integer nullable
• grade_name string nullable
• is_vip boolean (default: false)
• is_vlogger boolean (default: false)
• follower_count integer nullable
• following_count integer nullable
• view_count integer nullable
• review_count integer nullable
• editor_choice_review_count integer nullable
• photo_count integer nullable
• media_count integer nullable
• event_count integer nullable
• bookmarked_restaurant_count integer nullable
• bookmarked_offer_count integer nullable
• bookmarked_voucher_count integer nullable
• active_countries array (default: [])
• active_review_countries array (default: [])
• active_photo_countries array (default: [])
• short_url string 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 — User 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.