# /jmty/listings

`POST /api/jmty/listings`

Price: 5 credits

Fetch one Jimoty (jmty.jp) listing by its id across all eleven sections of the Japanese local classifieds board: second-hand goods and giveaways, used cars, pet rehoming, community groups, mutual help, part-time and full-time jobs, lessons, events, real estate and local services. Returns the title, full description, every photo, the headline price with its label, creation and update timestamps, favourite, inquiry and comment counters, the geography down to town, block and nearest station with coordinates, the poster with their verification badges and rating breakdown, plus the section-specific attribute block (rent, deposit, layout and building age for property, mileage, model year and inspection expiry for cars, pay and working hours for jobs, pet sex, age and neutering status for rehoming, event dates and venue for events), plus the online-payment state with the settlement methods offered and the handover and delivery options with the shipping fee the seller charges.

## How to use it

Get one Jimoty listing. listing accepts the short id printed on the page as 投稿ID (for example 1oog8w) or the full listing URL. vertical is optional: pass it (sale, car, pet, com, coop, rec, job, les, eve, est, ser) when you already know the section to save a lookup, otherwise the section is resolved automatically. Section-specific fields arrive in attributes as name/value pairs — sale and car and job and lesson listings use English names (price, mileage, model_year, pay, working_hours), property, pet, event, community, mutual-help and service listings use names mapped from the site's own labels (rent, deposit_and_key_money, layout_and_area, building_age, pet_sex, pet_age, event_date, business_hours). price holds the headline amount in JPY and is 0 for giveaways. is_online_purchasable is the same axis the online_payment filter of jmty/listings/search selects on; settlement_methods and delivery are filled only where the seller opted into online payment, and delivery.shipping_fee is in JPY where the seller quotes one. author.id feeds jmty/users, jmty/users/listings and jmty/users/reviews.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `listing` (string, required) — Listing id or its full jmty.jp URL (examples: "1oog8w", "https://jmty.jp/osaka/sale-spo/article-1oog8w")
- `vertical` (string, nullable) — Section the listing belongs to, resolved automatically when omitted (one of: "sale", "car", "pet", "com", "coop", "rec", "job", "les", "eve", "est", "ser")

## Response

### 200 — Successful Response

- `@type` (string) (default: "JmtyListing")
- `id` (string, nullable)
- `key` (string, required)
- `listing_title` (string, required)
- `text` (string, nullable)
- `price` (number, nullable)
- `price_label` (string, nullable)
- `currency` (string) (default: "JPY")
- `vertical` (string, nullable)
- `vertical_name` (string, nullable)
- `category` (string, nullable)
- `category_name` (string, nullable)
- `genre` (object, nullable)
  - `@type` (string) (default: "JmtyRef")
  - `id` (integer, nullable)
  - `name` (string, nullable)
  - `name_en` (string, nullable)
  - `url` (string, nullable)
- `sub_genre` (object, nullable)
  - `@type` (string) (default: "JmtyRef")
  - `id` (integer, nullable)
  - `name` (string, nullable)
  - `name_en` (string, nullable)
  - `url` (string, nullable)
- `created_at` (integer, nullable)
- `updated_at` (integer, nullable)
- `favorite_count` (integer, nullable)
- `inquiry_count` (integer, nullable)
- `comment_count` (integer, nullable)
- `is_closed` (boolean) (default: false)
- `is_business` (boolean) (default: false)
- `is_promoted` (boolean) (default: false)
- `is_highlighted` (boolean) (default: false)
- `is_online_purchasable` (boolean) (default: false)
- `phone` (string, nullable)
- `images` (array) (default: [])
- `location` (object, nullable)
  - `@type` (string) (default: "JmtyLocation")
  - `prefecture` (object, nullable)
    - `@type` (string) (default: "JmtyRef")
    - `id` (integer, nullable)
    - `name` (string, nullable)
    - `name_en` (string, nullable)
    - `url` (string, nullable)
  - `city` (object, nullable)
    - `@type` (string) (default: "JmtyRef")
    - `id` (integer, nullable)
    - `name` (string, nullable)
    - `name_en` (string, nullable)
    - `url` (string, nullable)
  - `town` (object, nullable)
    - `@type` (string) (default: "JmtyRef")
    - `id` (integer, nullable)
    - `name` (string, nullable)
    - `name_en` (string, nullable)
    - `url` (string, nullable)
  - `block` (object, nullable)
    - `@type` (string) (default: "JmtyRef")
    - `id` (integer, nullable)
    - `name` (string, nullable)
    - `name_en` (string, nullable)
    - `url` (string, nullable)
  - `station` (object, nullable)
    - `@type` (string) (default: "JmtyRef")
    - `id` (integer, nullable)
    - `name` (string, nullable)
    - `name_en` (string, nullable)
    - `url` (string, nullable)
  - `line` (object, nullable)
    - `@type` (string) (default: "JmtyRef")
    - `id` (integer, nullable)
    - `name` (string, nullable)
    - `name_en` (string, nullable)
    - `url` (string, nullable)
  - `address` (string, nullable)
  - `area_name` (string, nullable)
  - `place_note` (string, nullable)
  - `latitude` (number, nullable)
  - `longitude` (number, nullable)
- `author` (object, nullable)
  - `@type` (string) (default: "JmtyListingAuthor")
  - `id` (string, nullable)
  - `name` (string, nullable)
  - `sex` (string, nullable)
  - `listing_count` (integer, nullable)
  - `profile_text` (string, nullable)
  - `image` (string, nullable)
  - `url` (string, nullable)
  - `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)
  - `certification` (object, nullable)
    - `@type` (string) (default: "JmtyCertification")
    - `is_sms_authenticated` (boolean) (default: false)
    - `is_identified` (boolean) (default: false)
    - `is_multi_identified` (boolean) (default: false)
    - `is_business` (boolean) (default: false)
    - `is_antique_dealer` (boolean) (default: false)
    - `is_real_estate_notary` (boolean) (default: false)
- `attributes` (array) (default: [])
  - `@type` (string) (default: "JmtyListingAttribute")
  - `name` (string, required)
  - `value` (string, required)
- `delivery` (object, nullable)
  - `@type` (string) (default: "JmtyDelivery")
  - `is_shipped_by_seller` (boolean) (default: false)
  - `is_collected_by_purchaser` (boolean) (default: false)
  - `is_locker_handover` (boolean) (default: false)
  - `is_nationwide` (boolean) (default: false)
  - `shipping_fee` (number, nullable)
  - `deliverable_cities` (array) (default: [])
    - `@type` (string) (default: "JmtyRef")
    - `id` (integer, nullable)
    - `name` (string, nullable)
    - `name_en` (string, nullable)
    - `url` (string, nullable)
- `settlement_methods` (array) (default: [])
  - `@type` (string) (default: "JmtySettlementMethod")
  - `name` (string, required)
  - `display_name` (string, nullable)
  - `fee` (number, nullable)
- `related_keywords` (array) (default: [])
- `url` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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 listing with this id exists on jmty.jp

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.