/stackexchange/users

POST /api/stackexchange/users

Price: 1 credit

Get Stack Exchange user details by id

How to use it

Get full profile of a Stack Exchange user by their numeric id. Returns display name, reputation, gold/silver/bronze badge counts, location, website, bio, view/answer/question counts, account age, and last access time. Specify the network site via the 'site' parameter (default stackoverflow).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• site string — Stack Exchange network site to query (e.g. stackoverflow, superuser, serverfault, math) (default: "stackoverflow"; examples: "stackoverflow"; minLength: 1)
• user integer required — User id (examples: 22656; >: 0)

Response

• @type string (default: "StackexchangeUser")
• id integer required
• account_id integer nullable
• display_name string (default: "")
• reputation integer nullable
• badge_counts object nullable
  • @type string (default: "StackexchangeBadgeCounts")
  • gold integer (default: 0)
  • silver integer (default: 0)
  • bronze integer (default: 0)
• image string nullable
• location string nullable
• website_url string nullable
• bio string nullable
• view_count integer nullable
• answer_count integer nullable
• question_count integer nullable
• user_type string nullable
• created_at integer nullable
• last_access_at integer nullable
• profile_url string (default: "")

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. Verify the id and site. 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.