# /jmty/listings/search

`POST /api/jmty/listings/search`

Price: 20 credits

Search Jimoty (jmty.jp), Japan's largest local classifieds board, across any of its eleven sections: second-hand goods and giveaways, used cars, pet rehoming, community groups, mutual help, part-time and full-time jobs, lessons and schools, events, real estate and local services. Geography is a first-class filter — nationwide or one of the 47 prefectures, narrowed further to a municipality, a railway station or a whole railway line. Also filters by category and genre, free-text keyword, headline price range including giveaway-only, private versus business posters, online-payment support, job wage period, and car model year and mileage ranges. Each result carries the listing id, title, description, price, category path, geography, the site's own keyword tags and image. Syndicated partner-site adverts and paid placements are removed from the output.

## How to use it

Search Jimoty listings. vertical and count are required, everything else is optional. vertical accepts sale (second-hand goods and giveaways), car, pet, com (community), coop (mutual help), rec (part-time work), job (full-time work), les (lessons), eve (events), est (real estate), ser (local services). prefecture defaults to all of Japan and accepts the 47 romaji prefecture slugs. category must belong to the chosen vertical — read the valid codes from jmty/categories; genre_id also comes from there and requires category. area_id comes from jmty/areas, line_id and station_id from jmty/lines; all three need an explicit prefecture and must belong to it. area_id, station_id and line_id are mutually exclusive, and poster_type cannot be combined with any of them or with genre_id. Several filters are section-bound and are rejected elsewhere rather than silently ignored: min_price and max_price apply to the headline amount and work on sale, car, est, rec and job, where they mean rent for property and wage for work — set both to 0 for giveaways only; pay_system works on rec and job; min_model_year, max_model_year, min_mileage and max_mileage on car; event_date on eve. keyword, poster_type and online_payment work on every section. Feed key from any result into jmty/listings for the full listing. Dates on this surface carry month and day only because the source omits the year there — use jmty/listings for exact timestamps.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `vertical` (string, required) — Section of the board to search (one of: "sale", "car", "pet", "com", "coop", "rec", "job", "les", "eve", "est", "ser")
- `prefecture` (string) — Prefecture to search in, or all of Japan (default: "all"; one of: "all", "hokkaido", "aomori", "iwate", "miyagi", "akita", "yamagata", "fukushima", "ibaraki", "tochigi", "gunma", "saitama", "chiba", "tokyo", "kanagawa", "niigata", "toyama", "ishikawa", "fukui", "yamanashi", "nagano", "gifu", "shizuoka", "aichi", "mie", "shiga", "kyoto", "osaka", "hyogo", "nara", "wakayama", "tottori", "shimane", "okayama", "hiroshima", "yamaguchi", "tokushima", "kagawa", "ehime", "kochi", "fukuoka", "saga", "nagasaki", "kumamoto", "oita", "miyazaki", "kagoshima", "okinawa")
- `category` (string, nullable) — Category inside the section, taken from jmty/categories for the same section (one of: "adl", "alf", "amu", "aud", "auto", "ban", "bea", "bic", "bik", "bmw", "boo", "buy", "care", "cat", "cel", "chat", "chi", "clo", "con", "cons", "coo", "cos", "craf", "cre", "dai", "dan", "desk", "dis", "dog", "eat", "edu", "ele", "eng", "ent", "etc", "fes", "flo", "food", "free", "fri", "fur", "gar", "gard", "gou", "hcl", "hea", "help", "hom", "hon", "hou", "inc", "it", "jpn", "kid", "lan", "land", "les", "lex", "lif", "lig", "liv", "mas", "maz", "medi", "mer", "min", "mit", "mob", "mot", "mov", "mus", "nis", "npo", "nurs", "off", "oth", "par", "pc", "pcp", "pes", "pet", "peu", "pic", "plan", "pro", "qua", "recy", "rent", "res", "sab", "sale", "scr", "sdri", "sec", "ser", "sha", "sho", "shop", "shou", "sof", "spo", "stu", "sub", "suz", "tic", "tou", "town", "toy", "trad", "tran", "tro", "vol", "volv", "wed", "whlp", "wles", "work", "wrnt")
- `genre_id` (integer, nullable) — Genre inside the category, taken from jmty/categories; requires category (>: 0)
- `area_id` (integer, nullable) — Municipality inside the prefecture, taken from jmty/areas (>: 0)
- `station_id` (integer, nullable) — Railway station the listing is tied to (>: 0)
- `line_id` (integer, nullable) — Railway line the listing is tied to (>: 0)
- `keyword` (string) — Free-text keyword (default: ""; examples: "自転車", "メダカ")
- `min_price` (integer, nullable) — Lowest headline amount in JPY, 0 keeps only giveaways (min: 0)
- `max_price` (integer, nullable) — Highest headline amount in JPY, 0 keeps only giveaways (min: 0)
- `poster_type` (string, nullable) — Restrict to private posters or to businesses and agencies (one of: "individual", "corporate")
- `online_payment` (boolean, nullable) — Restrict to listings that accept the platform's online payment, or exclude them
- `pay_system` (string, nullable) — Wage period the job pay is quoted in, for job sections (one of: "hourly", "daily", "monthly")
- `min_model_year` (integer, nullable) — Oldest car model year (min: 1900; max: 2100)
- `max_model_year` (integer, nullable) — Newest car model year (min: 1900; max: 2100)
- `min_mileage` (integer, nullable) — Lowest car mileage in kilometres (min: 0)
- `max_mileage` (integer, nullable) — Highest car mileage in kilometres (min: 0)
- `event_date` (string) — Day an event takes place, as YYYY-MM-DD (default: ""; examples: "2026-08-20"; pattern: ^\d{4}-\d{2}-\d{2}$)
- `count` (integer, required) — Max number of listings to return (min: 1; max: 50000)

## Response

### 200 — Successful Response

- `@type` (string) (default: "JmtyListingCard")
- `key` (string, required)
- `listing_title` (string, required)
- `text` (string, nullable)
- `price` (number, nullable)
- `price_label` (string, nullable)
- `currency` (string) (default: "JPY")
- `vertical` (string, nullable)
- `category` (string, nullable)
- `genre` (object, nullable)
  - `@type` (string) (default: "JmtyRef")
  - `id` (integer, nullable)
  - `name` (string, nullable)
  - `name_en` (string, nullable)
  - `url` (string, nullable)
- `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)
- `station` (object, nullable)
  - `@type` (string) (default: "JmtyRef")
  - `id` (integer, nullable)
  - `name` (string, nullable)
  - `name_en` (string, nullable)
  - `url` (string, nullable)
- `keywords` (array) (default: [])
- `labels` (array) (default: [])
- `created_date` (string, nullable)
- `updated_date` (string, nullable)
- `favorite_count` (integer, nullable)
- `image` (string, nullable)
- `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

Jimoty does not index this combination — the area_id, station_id, line_id or genre_id does not belong to the prefecture and category you asked for. A combination that exists but currently holds nothing returns 200 with an empty list instead.

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.

