/segmentfault/users

POST /api/segmentfault/users

Price: 1 credit

Get one SegmentFault user profile by alias or URL: bio, reputation and level, question, answer and article counts, followers, badges, top tags, city, school, company and linked accounts

How to use it

The alias is the last segment of a /u/ profile URL and the `alias` of any author in other responses. The user's own posts come from segmentfault/users/questions, segmentfault/users/answers and segmentfault/users/articles.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• user string required — SegmentFault user alias or profile URL (examples: "sevencode", "https://segmentfault.com/u/sevencode")

Response

• @type string (default: "SegmentfaultUserProfile")
• id string required
• name string nullable
• alias string nullable
• url string nullable
• image string nullable
• bio string nullable
• bio_html string nullable
• reputation integer nullable
• reputation_level string nullable
• created_at integer nullable
• answer_count integer nullable
• question_count integer nullable
• article_count integer nullable
• following_count integer nullable
• follower_count integer nullable
• blog_follower_count integer nullable
• like_count integer nullable
• view_count integer nullable
• unique_view_count integer nullable
• badge_count integer nullable
• gold_badge_count integer nullable
• silver_badge_count integer nullable
• bronze_badge_count integer nullable
• ip_location string nullable
• city string nullable
• school string nullable
• school_department string nullable
• company string nullable
• company_department string nullable
• verified_title string nullable
• website_url string nullable
• account_status string nullable
• is_admin boolean nullable
• is_editor boolean nullable
• moderation_reason string nullable
• social_links array (default: [])
  • @type string (default: "SegmentfaultSocialLink")
  • platform string required
  • url string required
• top_tags array (default: [])
  • @type string (default: "SegmentfaultUserTopTag")
  • id string nullable
  • name string required
  • url string nullable
  • icon string nullable
  • reputation_gained integer nullable
• badges array (default: [])
  • @type string (default: "SegmentfaultBadge")
  • id string required
  • level string nullable
  • url string nullable
  • awarded_at integer 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 — No user with that alias, or a profile that is not public 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.