/kijiji/listings/similar

POST /api/kijiji/listings/similar

Price: 1 credit

Get the listings Kijiji recommends as similar to a given listing: price comparables for the same kind of item, each with title, price, location and images.

How to use it

Fetch Kijiji's own 'similar listings' recommendations for one listing — the fastest way to get price comparables for a specific item. Accepts a numeric listing ID or a listing URL. Returns listing cards with title, price (CAD dollars), location and images. The recommendation feed carries a narrower card than search does: description, dates, attributes, seller and the badge flags come back null here - fetch kijiji/listings by id when those are needed.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• listing string required — Kijiji listing ID or a listing URL containing it (examples: "1738054622"; minLength: 1)
• count integer required — Max number of similar listings to return (min: 1)
• locale string — Language of localized labels (default: "en"; one of: "en", "fr")

Response

• @type string (default: "KijijiListingCard")
• id string required
• url string nullable
• listing_type string nullable
• description string nullable
• category_id integer nullable
• price number nullable
• currency string nullable
• original_price number nullable
• msrp number nullable
• price_type string nullable
• price_rating string nullable
• average_market_price number nullable
• surcharges string nullable
• created_at integer nullable
• updated_at integer nullable
• image string nullable
• images array (default: [])
• image_count integer nullable
• is_top_ad boolean nullable
• is_price_drop boolean nullable
• is_showcase boolean nullable
• is_highlighted boolean nullable
• is_shipped_by_seller boolean nullable
• has_virtual_tour boolean nullable
• has_category_badge boolean nullable
• ad_source string nullable
• seller_id string nullable
• is_seller_verified boolean nullable
• location object nullable
  • @type string (default: "KijijiListingLocation")
  • id integer nullable
  • name string nullable
  • address string nullable
  • latitude number nullable
  • longitude number nullable
  • distance number nullable
  • nearest_intersection string nullable
  • neighbourhood string nullable
  • neighbourhood_id string nullable
• attributes array (default: [])
  • @type string (default: "KijijiListingAttribute")
  • canonical_name string required
  • name string nullable
  • values array (default: [])
  • canonical_values array (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 — Listing not found (well-formed but nonexistent or removed listing ID) 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.