/jmty/users

POST /api/jmty/users

Price: 5 credits

Fetch a Jimoty (jmty.jp) member profile: nickname, avatar, self description, gender, registration date, declared district and occupation, the verification badges the member holds (identity document, phone number, corporate paperwork, antique-dealer and real-estate licences), the good, neutral and bad rating counters, how many listings they currently have and how many reviews they have received. Jimoty's sellers range from private households to used-car dealers and letting agencies, so the badge set and the rating split are the practical trust signal for a Japanese local-classifieds counterparty.

How to use it

Get a Jimoty member profile. user accepts the 24 character hexadecimal profile id or the full profile URL; the id also arrives as author.id from jmty/listings. certifications holds the Japanese badge labels shown on the profile. evaluation splits ratings into good_count, normal_count and bad_count. Use jmty/users/listings for everything the member has posted and jmty/users/reviews for the review texts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• user string required — Profile id or its full jmty.jp profile URL (examples: "563091fb03cb6f093c00059e", "https://jmty.jp/profiles/563091fb03cb6f093c00059e")

Response

• @type string (default: "JmtyUser")
• id string required
• name string nullable
• image string nullable
• profile_text string nullable
• is_business boolean (default: false)
• sex string nullable
• registered_at integer nullable
• residence string nullable
• occupation string nullable
• certifications array (default: [])
• evaluation object nullable
  • @type string (default: "JmtyEvaluationCount")
  • good_count integer (default: 0)
  • normal_count integer (default: 0)
  • bad_count integer (default: 0)
  • score number nullable
• listing_count integer nullable
• review_count integer nullable
• store object nullable
  • @type string (default: "JmtyStore")
  • name string nullable
  • business_hours string nullable
  • address string nullable
  • closed_days string nullable
  • license_number string nullable
  • remark string nullable
  • introduction_title string nullable
  • introduction_text string nullable
  • images array (default: [])
• 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 — No jmty.jp profile with this id exists 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.