{ "item": [ { "name": "search", "description": "Vehicle search and free-text auction-id lookup.", "item": [ { "id": "0e0f014e-b741-4a08-976a-2057f92e9383", "name": "Search live auction inventory", "request": { "name": "Search live auction inventory", "description": { "content": "The primary search. Every parameter below is optional; a request with no\nfilter at all returns the whole active inventory in feed order.\n\n**Depth policy is different here.** The general public offset cap is\n`pagination.max_offset` from `GET /api/contract` (5000 by default), but\nan *unfiltered* search pages to any depth — it seeks a precomputed feed\nrank window rather than counting rows. A *filtered* search has no\nprecomputed rank to seek into and stays bounded by that cap. Asking for\na page too deep returns a `400` that says which of the two you are in.\n\n**Selecting sources.** `site` and `site_exclude` take a comma-separated\nslug list, OR within the parameter. An unknown slug on either is a `400`\nnaming the offender — one bad member rejects the whole list rather than\nquietly serving a different search. Sent together, the exclusion narrows\nthe include list; excluding everything you included is a `400`.\n", "type": "text/plain" }, "url": { "path": [ "api", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Free-text query over brand, model and keywords.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated source slugs from `/api/sites`, OR within the parameter.\nCase-insensitive; padding and empty members are ignored. An unknown slug\nis a `400` naming the offender.\n", "type": "text/plain" }, "key": "site", "value": "openlane,ecarstrade" }, { "disabled": true, "description": { "content": "Comma-separated source slugs to leave out. Same rules as `site`.", "type": "text/plain" }, "key": "site_exclude", "value": "copart" }, { "disabled": true, "description": { "content": "Brand display name, slug (from `/api/brands`), or numeric `brand_id`.", "type": "text/plain" }, "key": "brand", "value": "bmw" }, { "disabled": true, "description": { "content": "Model name or slug.", "type": "text/plain" }, "key": "model", "value": "320d" }, { "disabled": true, "description": { "content": "Lower bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_from", "value": "2018" }, { "disabled": true, "description": { "content": "Upper bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_to", "value": "2024" }, { "disabled": true, "description": { "content": "Canonical fuel group from `/api/fuels`.", "type": "text/plain" }, "key": "fuel", "value": "Diesel" }, { "disabled": true, "description": { "content": "Canonical gearbox group from `/api/gearboxes`.", "type": "text/plain" }, "key": "gearbox", "value": "Automatic" }, { "disabled": true, "description": { "content": "ISO country code from `/api/countries`, or the pseudo-country `europe`.\nAccepted and ignored by `/api/sites` and `/load-models`.\n", "type": "text/plain" }, "key": "country", "value": "DE" }, { "disabled": true, "description": { "content": " (This can only be one of cars,suvs & trucks,suvs and trucks)", "type": "text/plain" }, "key": "vehicle_type", "value": "suvs and trucks" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "body_style", "value": "" }, { "disabled": true, "description": { "content": "Which side the steering wheel is on. `left`/`lhd` and `right`/`rhd` are\nequivalent spellings; any other value is a 400.\n\nDerived rather than stored. `japanauction` is the only source that publishes a\nsteering field; for every other source the side is taken from the car's\nregistration market, so a car from an ISO country that drives on the left\n(GB, IE, JP, CY, MT, AU, NZ, ZA, IN, TH, HK, SG) is `right` and everything\nelse is `left`. Every listing resolves to one side or the other, so the\ntwo values partition the inventory and their totals sum to the unfiltered\ntotal. The same value is published on each result as `steering`.\n\nAccepted by `/api/search`, `/api/listVehicles`, `/api/top-offers` and\nevery facet endpoint, which narrow their option lists by it. Sending it\nto a facet endpoint takes that request off the precomputed facet table\nand onto a live aggregate, so it is slower than an unfiltered facet call.\n (This can only be one of left,lhd,right,rhd)", "type": "text/plain" }, "key": "steering", "value": "left" }, { "disabled": true, "description": { "content": "Lower bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_to", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_from", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_to", "value": "" }, { "disabled": true, "description": { "content": "Lower bound on the public EUR price.", "type": "text/plain" }, "key": "price_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on the public EUR price.", "type": "text/plain" }, "key": "price_to", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to damaged/broken vehicles. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "damaged", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to Buy-Now listings. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "buy_now", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to auctions ending within roughly two hours.", "type": "text/plain" }, "key": "ending_soon", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of top_offers,low_mileage,best_value)", "type": "text/plain" }, "key": "smart_filter", "value": "best_value" }, { "disabled": true, "description": { "content": "The ended-lot switch, and the spelling most callers reach for.\n`true` (the default) hides lots whose auction has closed. `false`\nshows closed lots **in addition to** live ones — it does not return\nonly ended lots, and it is not a filter on the `is_active` response\nfield. Also accepts `1`/`0`/`yes`/`no`.\n", "type": "text/plain" }, "key": "is_active", "value": "true" }, { "disabled": true, "description": { "content": "The same switch inverted: `include_ended=true` == `is_active=false`.\nSent together, `include_ended` wins. Also accepts `1`/`0`/`yes`/`no`.\n", "type": "text/plain" }, "key": "include_ended", "value": "false" }, { "disabled": true, "description": { "content": "Result ordering. `default` is photo-first, then newest. The retired\n`random` value is still accepted and is served as `default`.\n (This can only be one of default,newest,top_offers,time_left_least,time_left_desc,time_left_most,price_low,price_high,year_new,year_old,brand_az,brand_za)", "type": "text/plain" }, "key": "sort", "value": "default" }, { "disabled": true, "description": { "content": "Page size. Capped at `pagination.max_limit` from `GET /api/contract`\n(100 by default); larger values are clamped down rather than rejected.\nDo not combine with `page_size` — that is a `400`.\n", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "0-based row offset. Do not combine with `page` — that is a `400`.\nBounded by `pagination.max_offset` (5000 by default) everywhere except\nan unfiltered `/api/search`.\n", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "1-based page number; maps to `offset = (page - 1) * limit`. Do not combine with `offset`.", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": true, "description": { "content": "Alias for `limit`. Do not combine with `limit`.", "type": "text/plain" }, "key": "page_size", "value": "" }, { "disabled": true, "description": { "content": "`false` returns `total: null` and skips the count, which is faster.", "type": "text/plain" }, "key": "include_total", "value": "true" }, { "disabled": true, "description": { "content": "`true` returns the counts only, with no result rows.", "type": "text/plain" }, "key": "count_only", "value": "false" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee08b098-b7a5-4e01-aa33-25b3484d1b43", "name": "Free-text search returning only auction ids", "request": { "name": "Free-text search returning only auction ids", "description": { "content": "Typesense-backed id-only search, for pre-filtering before hydrating via\nthe auction detail routes. If full-text search is disabled server-side\nthis returns an empty list with `success: true`, not an error.\n", "type": "text/plain" }, "url": { "path": [ "api", "search", "auction-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Free-text query. An empty query returns an empty list.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "facets", "description": "Filter vocabularies with live counts. Part of the `search` scope.", "item": [ { "id": "1da86b0d-f491-44f1-821c-47343c80b1de", "name": "Available registration years", "request": { "name": "Available registration years", "description": { "content": "Distinct registration years in the filtered inventory, newest first.", "type": "text/plain" }, "url": { "path": [ "api", "years" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "`true` restricts to damaged/broken vehicles. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "damaged", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to Buy-Now listings. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "buy_now", "value": "" }, { "disabled": true, "description": { "content": "ISO country code from `/api/countries`, or the pseudo-country `europe`.\nAccepted and ignored by `/api/sites` and `/load-models`.\n", "type": "text/plain" }, "key": "country", "value": "DE" }, { "disabled": true, "description": { "content": "Brand display name, slug (from `/api/brands`), or numeric `brand_id`.", "type": "text/plain" }, "key": "brand", "value": "bmw" }, { "disabled": true, "description": { "content": "Model name or slug.", "type": "text/plain" }, "key": "model", "value": "320d" }, { "disabled": true, "description": { "content": "Lower bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_from", "value": "2018" }, { "disabled": true, "description": { "content": "Upper bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_to", "value": "2024" }, { "disabled": true, "description": { "content": "Canonical fuel group from `/api/fuels`.", "type": "text/plain" }, "key": "fuel", "value": "Diesel" }, { "disabled": true, "description": { "content": "Canonical gearbox group from `/api/gearboxes`.", "type": "text/plain" }, "key": "gearbox", "value": "Automatic" }, { "disabled": true, "description": { "content": "Lower bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_to", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_from", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_to", "value": "" }, { "disabled": true, "description": { "content": "Lower bound on the public EUR price.", "type": "text/plain" }, "key": "price_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on the public EUR price.", "type": "text/plain" }, "key": "price_to", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of cars,suvs & trucks,suvs and trucks)", "type": "text/plain" }, "key": "vehicle_type", "value": "suvs and trucks" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "body_style", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to auctions ending within roughly two hours.", "type": "text/plain" }, "key": "ending_soon", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated source slugs from `/api/sites`, OR within the parameter.\nCase-insensitive; padding and empty members are ignored. An unknown slug\nis a `400` naming the offender.\n", "type": "text/plain" }, "key": "site", "value": "openlane,ecarstrade" }, { "disabled": true, "description": { "content": "Comma-separated source slugs to leave out. Same rules as `site`.", "type": "text/plain" }, "key": "site_exclude", "value": "copart" }, { "disabled": true, "description": { "content": "Which side the steering wheel is on. `left`/`lhd` and `right`/`rhd` are\nequivalent spellings; any other value is a 400.\n\nDerived rather than stored. `japanauction` is the only source that publishes a\nsteering field; for every other source the side is taken from the car's\nregistration market, so a car from an ISO country that drives on the left\n(GB, IE, JP, CY, MT, AU, NZ, ZA, IN, TH, HK, SG) is `right` and everything\nelse is `left`. Every listing resolves to one side or the other, so the\ntwo values partition the inventory and their totals sum to the unfiltered\ntotal. The same value is published on each result as `steering`.\n\nAccepted by `/api/search`, `/api/listVehicles`, `/api/top-offers` and\nevery facet endpoint, which narrow their option lists by it. Sending it\nto a facet endpoint takes that request off the precomputed facet table\nand onto a live aggregate, so it is slower than an unfiltered facet call.\n (This can only be one of left,lhd,right,rhd)", "type": "text/plain" }, "key": "steering", "value": "left" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ff16459-e150-429b-b26b-138f79e7aba0", "name": "Available fuel groups", "request": { "name": "Available fuel groups", "description": { "content": "Canonical fuel groups. Send a value back as `?fuel=` on `/api/search`.", "type": "text/plain" }, "url": { "path": [ "api", "fuels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "`true` restricts to damaged/broken vehicles. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "damaged", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to Buy-Now listings. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "buy_now", "value": "" }, { "disabled": true, "description": { "content": "ISO country code from `/api/countries`, or the pseudo-country `europe`.\nAccepted and ignored by `/api/sites` and `/load-models`.\n", "type": "text/plain" }, "key": "country", "value": "DE" }, { "disabled": true, "description": { "content": "Brand display name, slug (from `/api/brands`), or numeric `brand_id`.", "type": "text/plain" }, "key": "brand", "value": "bmw" }, { "disabled": true, "description": { "content": "Model name or slug.", "type": "text/plain" }, "key": "model", "value": "320d" }, { "disabled": true, "description": { "content": "Lower bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_from", "value": "2018" }, { "disabled": true, "description": { "content": "Upper bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_to", "value": "2024" }, { "disabled": true, "description": { "content": "Canonical fuel group from `/api/fuels`.", "type": "text/plain" }, "key": "fuel", "value": "Diesel" }, { "disabled": true, "description": { "content": "Canonical gearbox group from `/api/gearboxes`.", "type": "text/plain" }, "key": "gearbox", "value": "Automatic" }, { "disabled": true, "description": { "content": "Lower bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_to", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_from", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_to", "value": "" }, { "disabled": true, "description": { "content": "Lower bound on the public EUR price.", "type": "text/plain" }, "key": "price_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on the public EUR price.", "type": "text/plain" }, "key": "price_to", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of cars,suvs & trucks,suvs and trucks)", "type": "text/plain" }, "key": "vehicle_type", "value": "suvs and trucks" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "body_style", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to auctions ending within roughly two hours.", "type": "text/plain" }, "key": "ending_soon", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated source slugs from `/api/sites`, OR within the parameter.\nCase-insensitive; padding and empty members are ignored. An unknown slug\nis a `400` naming the offender.\n", "type": "text/plain" }, "key": "site", "value": "openlane,ecarstrade" }, { "disabled": true, "description": { "content": "Comma-separated source slugs to leave out. Same rules as `site`.", "type": "text/plain" }, "key": "site_exclude", "value": "copart" }, { "disabled": true, "description": { "content": "Which side the steering wheel is on. `left`/`lhd` and `right`/`rhd` are\nequivalent spellings; any other value is a 400.\n\nDerived rather than stored. `japanauction` is the only source that publishes a\nsteering field; for every other source the side is taken from the car's\nregistration market, so a car from an ISO country that drives on the left\n(GB, IE, JP, CY, MT, AU, NZ, ZA, IN, TH, HK, SG) is `right` and everything\nelse is `left`. Every listing resolves to one side or the other, so the\ntwo values partition the inventory and their totals sum to the unfiltered\ntotal. The same value is published on each result as `steering`.\n\nAccepted by `/api/search`, `/api/listVehicles`, `/api/top-offers` and\nevery facet endpoint, which narrow their option lists by it. Sending it\nto a facet endpoint takes that request off the precomputed facet table\nand onto a live aggregate, so it is slower than an unfiltered facet call.\n (This can only be one of left,lhd,right,rhd)", "type": "text/plain" }, "key": "steering", "value": "left" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1cb43a9d-1e67-48ec-8a0d-663061ca9a9c", "name": "Available gearbox groups", "request": { "name": "Available gearbox groups", "description": { "content": "Canonical gearbox groups. Send a value back as `?gearbox=` on `/api/search`.", "type": "text/plain" }, "url": { "path": [ "api", "gearboxes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "`true` restricts to damaged/broken vehicles. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "damaged", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to Buy-Now listings. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "buy_now", "value": "" }, { "disabled": true, "description": { "content": "ISO country code from `/api/countries`, or the pseudo-country `europe`.\nAccepted and ignored by `/api/sites` and `/load-models`.\n", "type": "text/plain" }, "key": "country", "value": "DE" }, { "disabled": true, "description": { "content": "Brand display name, slug (from `/api/brands`), or numeric `brand_id`.", "type": "text/plain" }, "key": "brand", "value": "bmw" }, { "disabled": true, "description": { "content": "Model name or slug.", "type": "text/plain" }, "key": "model", "value": "320d" }, { "disabled": true, "description": { "content": "Lower bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_from", "value": "2018" }, { "disabled": true, "description": { "content": "Upper bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_to", "value": "2024" }, { "disabled": true, "description": { "content": "Canonical fuel group from `/api/fuels`.", "type": "text/plain" }, "key": "fuel", "value": "Diesel" }, { "disabled": true, "description": { "content": "Canonical gearbox group from `/api/gearboxes`.", "type": "text/plain" }, "key": "gearbox", "value": "Automatic" }, { "disabled": true, "description": { "content": "Lower bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_to", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_from", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_to", "value": "" }, { "disabled": true, "description": { "content": "Lower bound on the public EUR price.", "type": "text/plain" }, "key": "price_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on the public EUR price.", "type": "text/plain" }, "key": "price_to", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of cars,suvs & trucks,suvs and trucks)", "type": "text/plain" }, "key": "vehicle_type", "value": "suvs and trucks" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "body_style", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to auctions ending within roughly two hours.", "type": "text/plain" }, "key": "ending_soon", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated source slugs from `/api/sites`, OR within the parameter.\nCase-insensitive; padding and empty members are ignored. An unknown slug\nis a `400` naming the offender.\n", "type": "text/plain" }, "key": "site", "value": "openlane,ecarstrade" }, { "disabled": true, "description": { "content": "Comma-separated source slugs to leave out. Same rules as `site`.", "type": "text/plain" }, "key": "site_exclude", "value": "copart" }, { "disabled": true, "description": { "content": "Which side the steering wheel is on. `left`/`lhd` and `right`/`rhd` are\nequivalent spellings; any other value is a 400.\n\nDerived rather than stored. `japanauction` is the only source that publishes a\nsteering field; for every other source the side is taken from the car's\nregistration market, so a car from an ISO country that drives on the left\n(GB, IE, JP, CY, MT, AU, NZ, ZA, IN, TH, HK, SG) is `right` and everything\nelse is `left`. Every listing resolves to one side or the other, so the\ntwo values partition the inventory and their totals sum to the unfiltered\ntotal. The same value is published on each result as `steering`.\n\nAccepted by `/api/search`, `/api/listVehicles`, `/api/top-offers` and\nevery facet endpoint, which narrow their option lists by it. Sending it\nto a facet endpoint takes that request off the precomputed facet table\nand onto a live aggregate, so it is slower than an unfiltered facet call.\n (This can only be one of left,lhd,right,rhd)", "type": "text/plain" }, "key": "steering", "value": "left" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a652be8-65c1-4a32-97c3-dc6a6700a1ff", "name": "Available origin countries", "request": { "name": "Available origin countries", "description": { "content": "ISO country codes present in the filtered inventory, plus a\n`country_details` array carrying the display name for each.\n\n**The `europe` pseudo-country.** `country=europe` means \"every origin\nthat is not overseas\", implemented as an exclusion rather than a list —\nso a source shipping from outside Europe has to be named for it to be\nexcluded. It currently excludes `KR` (Encar) and `JP` (`japanauction`). Rows\nwith no recorded country are treated as European and are included. If\nyou need strict membership, pass explicit ISO codes instead.\n", "type": "text/plain" }, "url": { "path": [ "api", "countries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "`true` restricts to damaged/broken vehicles. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "damaged", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to Buy-Now listings. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "buy_now", "value": "" }, { "disabled": true, "description": { "content": "ISO country code from `/api/countries`, or the pseudo-country `europe`.\nAccepted and ignored by `/api/sites` and `/load-models`.\n", "type": "text/plain" }, "key": "country", "value": "DE" }, { "disabled": true, "description": { "content": "Brand display name, slug (from `/api/brands`), or numeric `brand_id`.", "type": "text/plain" }, "key": "brand", "value": "bmw" }, { "disabled": true, "description": { "content": "Model name or slug.", "type": "text/plain" }, "key": "model", "value": "320d" }, { "disabled": true, "description": { "content": "Lower bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_from", "value": "2018" }, { "disabled": true, "description": { "content": "Upper bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_to", "value": "2024" }, { "disabled": true, "description": { "content": "Canonical fuel group from `/api/fuels`.", "type": "text/plain" }, "key": "fuel", "value": "Diesel" }, { "disabled": true, "description": { "content": "Canonical gearbox group from `/api/gearboxes`.", "type": "text/plain" }, "key": "gearbox", "value": "Automatic" }, { "disabled": true, "description": { "content": "Lower bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_to", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_from", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_to", "value": "" }, { "disabled": true, "description": { "content": "Lower bound on the public EUR price.", "type": "text/plain" }, "key": "price_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on the public EUR price.", "type": "text/plain" }, "key": "price_to", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of cars,suvs & trucks,suvs and trucks)", "type": "text/plain" }, "key": "vehicle_type", "value": "suvs and trucks" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "body_style", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to auctions ending within roughly two hours.", "type": "text/plain" }, "key": "ending_soon", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated source slugs from `/api/sites`, OR within the parameter.\nCase-insensitive; padding and empty members are ignored. An unknown slug\nis a `400` naming the offender.\n", "type": "text/plain" }, "key": "site", "value": "openlane,ecarstrade" }, { "disabled": true, "description": { "content": "Comma-separated source slugs to leave out. Same rules as `site`.", "type": "text/plain" }, "key": "site_exclude", "value": "copart" }, { "disabled": true, "description": { "content": "Which side the steering wheel is on. `left`/`lhd` and `right`/`rhd` are\nequivalent spellings; any other value is a 400.\n\nDerived rather than stored. `japanauction` is the only source that publishes a\nsteering field; for every other source the side is taken from the car's\nregistration market, so a car from an ISO country that drives on the left\n(GB, IE, JP, CY, MT, AU, NZ, ZA, IN, TH, HK, SG) is `right` and everything\nelse is `left`. Every listing resolves to one side or the other, so the\ntwo values partition the inventory and their totals sum to the unfiltered\ntotal. The same value is published on each result as `steering`.\n\nAccepted by `/api/search`, `/api/listVehicles`, `/api/top-offers` and\nevery facet endpoint, which narrow their option lists by it. Sending it\nto a facet endpoint takes that request off the precomputed facet table\nand onto a live aggregate, so it is slower than an unfiltered facet call.\n (This can only be one of left,lhd,right,rhd)", "type": "text/plain" }, "key": "steering", "value": "left" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54c06fed-d310-41fe-8857-ae4d0c59e7df", "name": "Auction sources with live inventory counts", "request": { "name": "Auction sources with live inventory counts", "description": { "content": "The discovery endpoint for source slugs. `name` is the value you pass to\n`/api/search?site=` and the slug in `/api/auction/{site_slug}/{auction_id}`.\n\nCounts respect every other filter on the request but ignore\n`site`/`site_exclude` themselves — a facet that filtered by its own\ndimension could only return the sources you already named. `country` is\naccepted and ignored here.\n", "type": "text/plain" }, "url": { "path": [ "api", "sites" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "`true` restricts to damaged/broken vehicles. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "damaged", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to Buy-Now listings. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "buy_now", "value": "" }, { "disabled": true, "description": { "content": "ISO country code from `/api/countries`, or the pseudo-country `europe`.\nAccepted and ignored by `/api/sites` and `/load-models`.\n", "type": "text/plain" }, "key": "country", "value": "DE" }, { "disabled": true, "description": { "content": "Brand display name, slug (from `/api/brands`), or numeric `brand_id`.", "type": "text/plain" }, "key": "brand", "value": "bmw" }, { "disabled": true, "description": { "content": "Model name or slug.", "type": "text/plain" }, "key": "model", "value": "320d" }, { "disabled": true, "description": { "content": "Lower bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_from", "value": "2018" }, { "disabled": true, "description": { "content": "Upper bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_to", "value": "2024" }, { "disabled": true, "description": { "content": "Canonical fuel group from `/api/fuels`.", "type": "text/plain" }, "key": "fuel", "value": "Diesel" }, { "disabled": true, "description": { "content": "Canonical gearbox group from `/api/gearboxes`.", "type": "text/plain" }, "key": "gearbox", "value": "Automatic" }, { "disabled": true, "description": { "content": "Lower bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_to", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_from", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_to", "value": "" }, { "disabled": true, "description": { "content": "Lower bound on the public EUR price.", "type": "text/plain" }, "key": "price_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on the public EUR price.", "type": "text/plain" }, "key": "price_to", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of cars,suvs & trucks,suvs and trucks)", "type": "text/plain" }, "key": "vehicle_type", "value": "suvs and trucks" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "body_style", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to auctions ending within roughly two hours.", "type": "text/plain" }, "key": "ending_soon", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated source slugs from `/api/sites`, OR within the parameter.\nCase-insensitive; padding and empty members are ignored. An unknown slug\nis a `400` naming the offender.\n", "type": "text/plain" }, "key": "site", "value": "openlane,ecarstrade" }, { "disabled": true, "description": { "content": "Comma-separated source slugs to leave out. Same rules as `site`.", "type": "text/plain" }, "key": "site_exclude", "value": "copart" }, { "disabled": true, "description": { "content": "Which side the steering wheel is on. `left`/`lhd` and `right`/`rhd` are\nequivalent spellings; any other value is a 400.\n\nDerived rather than stored. `japanauction` is the only source that publishes a\nsteering field; for every other source the side is taken from the car's\nregistration market, so a car from an ISO country that drives on the left\n(GB, IE, JP, CY, MT, AU, NZ, ZA, IN, TH, HK, SG) is `right` and everything\nelse is `left`. Every listing resolves to one side or the other, so the\ntwo values partition the inventory and their totals sum to the unfiltered\ntotal. The same value is published on each result as `steering`.\n\nAccepted by `/api/search`, `/api/listVehicles`, `/api/top-offers` and\nevery facet endpoint, which narrow their option lists by it. Sending it\nto a facet endpoint takes that request off the precomputed facet table\nand onto a live aggregate, so it is slower than an unfiltered facet call.\n (This can only be one of left,lhd,right,rhd)", "type": "text/plain" }, "key": "steering", "value": "left" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb18bc0e-943d-424e-90f2-e03780a422e2", "name": "Full brand to models map", "request": { "name": "Full brand to models map", "description": { "content": "The whole brand-to-models map in one call, for building a cascading\nfilter UI without a round trip per brand. Heavy — cache it. `country`\nis accepted and ignored here.\n\n**This response is shaped differently from every other facet route.**\nThe body *is* the brand map: every key is a brand name and every value is\nthat brand's model list. There is no wrapper object, no `success` field\nand no contract metadata on a successful response — the keys are data, so\nnothing else may share that namespace. The correlation id is on the\n`X-Request-ID` response header instead.\n\nAn error response *is* wrapped, and does carry `success: false`.\n", "type": "text/plain" }, "url": { "path": [ "load-models" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "`true` restricts to damaged/broken vehicles. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "damaged", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to Buy-Now listings. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "buy_now", "value": "" }, { "disabled": true, "description": { "content": "ISO country code from `/api/countries`, or the pseudo-country `europe`.\nAccepted and ignored by `/api/sites` and `/load-models`.\n", "type": "text/plain" }, "key": "country", "value": "DE" }, { "disabled": true, "description": { "content": "Brand display name, slug (from `/api/brands`), or numeric `brand_id`.", "type": "text/plain" }, "key": "brand", "value": "bmw" }, { "disabled": true, "description": { "content": "Model name or slug.", "type": "text/plain" }, "key": "model", "value": "320d" }, { "disabled": true, "description": { "content": "Lower bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_from", "value": "2018" }, { "disabled": true, "description": { "content": "Upper bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_to", "value": "2024" }, { "disabled": true, "description": { "content": "Canonical fuel group from `/api/fuels`.", "type": "text/plain" }, "key": "fuel", "value": "Diesel" }, { "disabled": true, "description": { "content": "Canonical gearbox group from `/api/gearboxes`.", "type": "text/plain" }, "key": "gearbox", "value": "Automatic" }, { "disabled": true, "description": { "content": "Lower bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_to", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_from", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_to", "value": "" }, { "disabled": true, "description": { "content": "Lower bound on the public EUR price.", "type": "text/plain" }, "key": "price_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on the public EUR price.", "type": "text/plain" }, "key": "price_to", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of cars,suvs & trucks,suvs and trucks)", "type": "text/plain" }, "key": "vehicle_type", "value": "suvs and trucks" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "body_style", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to auctions ending within roughly two hours.", "type": "text/plain" }, "key": "ending_soon", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated source slugs from `/api/sites`, OR within the parameter.\nCase-insensitive; padding and empty members are ignored. An unknown slug\nis a `400` naming the offender.\n", "type": "text/plain" }, "key": "site", "value": "openlane,ecarstrade" }, { "disabled": true, "description": { "content": "Comma-separated source slugs to leave out. Same rules as `site`.", "type": "text/plain" }, "key": "site_exclude", "value": "copart" }, { "disabled": true, "description": { "content": "Which side the steering wheel is on. `left`/`lhd` and `right`/`rhd` are\nequivalent spellings; any other value is a 400.\n\nDerived rather than stored. `japanauction` is the only source that publishes a\nsteering field; for every other source the side is taken from the car's\nregistration market, so a car from an ISO country that drives on the left\n(GB, IE, JP, CY, MT, AU, NZ, ZA, IN, TH, HK, SG) is `right` and everything\nelse is `left`. Every listing resolves to one side or the other, so the\ntwo values partition the inventory and their totals sum to the unfiltered\ntotal. The same value is published on each result as `steering`.\n\nAccepted by `/api/search`, `/api/listVehicles`, `/api/top-offers` and\nevery facet endpoint, which narrow their option lists by it. Sending it\nto a facet endpoint takes that request off the precomputed facet table\nand onto a live aggregate, so it is slower than an unfiltered facet call.\n (This can only be one of left,lhd,right,rhd)", "type": "text/plain" }, "key": "steering", "value": "left" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "414d4920-807c-4e66-83d8-84a17add21bb", "name": "Brand filter values with counts", "request": { "name": "Brand filter values with counts", "description": { "content": "The returned `slug` round-trips: send it back as `?brand=` to\n`/api/search` or `/api/models`.\n", "type": "text/plain" }, "url": { "path": [ "api", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "`true` restricts to damaged/broken vehicles. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "damaged", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to Buy-Now listings. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "buy_now", "value": "" }, { "disabled": true, "description": { "content": "ISO country code from `/api/countries`, or the pseudo-country `europe`.\nAccepted and ignored by `/api/sites` and `/load-models`.\n", "type": "text/plain" }, "key": "country", "value": "DE" }, { "disabled": true, "description": { "content": "Brand display name, slug (from `/api/brands`), or numeric `brand_id`.", "type": "text/plain" }, "key": "brand", "value": "bmw" }, { "disabled": true, "description": { "content": "Model name or slug.", "type": "text/plain" }, "key": "model", "value": "320d" }, { "disabled": true, "description": { "content": "Lower bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_from", "value": "2018" }, { "disabled": true, "description": { "content": "Upper bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_to", "value": "2024" }, { "disabled": true, "description": { "content": "Canonical fuel group from `/api/fuels`.", "type": "text/plain" }, "key": "fuel", "value": "Diesel" }, { "disabled": true, "description": { "content": "Canonical gearbox group from `/api/gearboxes`.", "type": "text/plain" }, "key": "gearbox", "value": "Automatic" }, { "disabled": true, "description": { "content": "Lower bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_to", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_from", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_to", "value": "" }, { "disabled": true, "description": { "content": "Lower bound on the public EUR price.", "type": "text/plain" }, "key": "price_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on the public EUR price.", "type": "text/plain" }, "key": "price_to", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of cars,suvs & trucks,suvs and trucks)", "type": "text/plain" }, "key": "vehicle_type", "value": "suvs and trucks" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "body_style", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to auctions ending within roughly two hours.", "type": "text/plain" }, "key": "ending_soon", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated source slugs from `/api/sites`, OR within the parameter.\nCase-insensitive; padding and empty members are ignored. An unknown slug\nis a `400` naming the offender.\n", "type": "text/plain" }, "key": "site", "value": "openlane,ecarstrade" }, { "disabled": true, "description": { "content": "Comma-separated source slugs to leave out. Same rules as `site`.", "type": "text/plain" }, "key": "site_exclude", "value": "copart" }, { "disabled": true, "description": { "content": "Substring filter on the facet value name.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of name,-name,count,-count)", "type": "text/plain" }, "key": "ordering", "value": "-name" }, { "disabled": true, "description": { "content": "Maximum facet values to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "Which side the steering wheel is on. `left`/`lhd` and `right`/`rhd` are\nequivalent spellings; any other value is a 400.\n\nDerived rather than stored. `japanauction` is the only source that publishes a\nsteering field; for every other source the side is taken from the car's\nregistration market, so a car from an ISO country that drives on the left\n(GB, IE, JP, CY, MT, AU, NZ, ZA, IN, TH, HK, SG) is `right` and everything\nelse is `left`. Every listing resolves to one side or the other, so the\ntwo values partition the inventory and their totals sum to the unfiltered\ntotal. The same value is published on each result as `steering`.\n\nAccepted by `/api/search`, `/api/listVehicles`, `/api/top-offers` and\nevery facet endpoint, which narrow their option lists by it. Sending it\nto a facet endpoint takes that request off the precomputed facet table\nand onto a live aggregate, so it is slower than an unfiltered facet call.\n (This can only be one of left,lhd,right,rhd)", "type": "text/plain" }, "key": "steering", "value": "left" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d85ced05-3008-49e9-8653-1ca1a672236b", "name": "Model filter values for one brand", "request": { "name": "Model filter values for one brand", "description": { "content": "`brand` is required here — omitting it is a `400`.", "type": "text/plain" }, "url": { "path": [ "api", "models" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "`true` restricts to damaged/broken vehicles. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "damaged", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to Buy-Now listings. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "buy_now", "value": "" }, { "disabled": true, "description": { "content": "ISO country code from `/api/countries`, or the pseudo-country `europe`.\nAccepted and ignored by `/api/sites` and `/load-models`.\n", "type": "text/plain" }, "key": "country", "value": "DE" }, { "disabled": false, "description": { "content": "(Required) Brand display name, slug (from `/api/brands`), or numeric `brand_id`.", "type": "text/plain" }, "key": "brand", "value": "bmw" }, { "disabled": true, "description": { "content": "Model name or slug.", "type": "text/plain" }, "key": "model", "value": "320d" }, { "disabled": true, "description": { "content": "Lower bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_from", "value": "2018" }, { "disabled": true, "description": { "content": "Upper bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_to", "value": "2024" }, { "disabled": true, "description": { "content": "Canonical fuel group from `/api/fuels`.", "type": "text/plain" }, "key": "fuel", "value": "Diesel" }, { "disabled": true, "description": { "content": "Canonical gearbox group from `/api/gearboxes`.", "type": "text/plain" }, "key": "gearbox", "value": "Automatic" }, { "disabled": true, "description": { "content": "Lower bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_to", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_from", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_to", "value": "" }, { "disabled": true, "description": { "content": "Lower bound on the public EUR price.", "type": "text/plain" }, "key": "price_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on the public EUR price.", "type": "text/plain" }, "key": "price_to", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of cars,suvs & trucks,suvs and trucks)", "type": "text/plain" }, "key": "vehicle_type", "value": "suvs and trucks" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "body_style", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to auctions ending within roughly two hours.", "type": "text/plain" }, "key": "ending_soon", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated source slugs from `/api/sites`, OR within the parameter.\nCase-insensitive; padding and empty members are ignored. An unknown slug\nis a `400` naming the offender.\n", "type": "text/plain" }, "key": "site", "value": "openlane,ecarstrade" }, { "disabled": true, "description": { "content": "Comma-separated source slugs to leave out. Same rules as `site`.", "type": "text/plain" }, "key": "site_exclude", "value": "copart" }, { "disabled": true, "description": { "content": "Substring filter on the facet value name.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of name,-name,count,-count)", "type": "text/plain" }, "key": "ordering", "value": "-name" }, { "disabled": true, "description": { "content": "Maximum facet values to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "Which side the steering wheel is on. `left`/`lhd` and `right`/`rhd` are\nequivalent spellings; any other value is a 400.\n\nDerived rather than stored. `japanauction` is the only source that publishes a\nsteering field; for every other source the side is taken from the car's\nregistration market, so a car from an ISO country that drives on the left\n(GB, IE, JP, CY, MT, AU, NZ, ZA, IN, TH, HK, SG) is `right` and everything\nelse is `left`. Every listing resolves to one side or the other, so the\ntwo values partition the inventory and their totals sum to the unfiltered\ntotal. The same value is published on each result as `steering`.\n\nAccepted by `/api/search`, `/api/listVehicles`, `/api/top-offers` and\nevery facet endpoint, which narrow their option lists by it. Sending it\nto a facet endpoint takes that request off the precomputed facet table\nand onto a live aggregate, so it is slower than an unfiltered facet call.\n (This can only be one of left,lhd,right,rhd)", "type": "text/plain" }, "key": "steering", "value": "left" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4832be00-62a3-4789-a11d-1f40104a68f9", "name": "Every flat facet dimension in one request", "request": { "name": "Every flat facet dimension in one request", "description": { "content": "A filter sidebar in one call instead of six. Each field's payload is the\nbody its own endpoint returns, merged verbatim — including\n`countries` shipping `country_details` alongside it. No field gains or\nloses counts by being requested here, and the per-dimension endpoints\nstay supported.\n\n`models` is **not** available here: it is scoped to a single brand and\nstays at `/api/models`.\n\nA field that fails does not fail the response. It is reported under\n`errors` and every other field is still returned, so one slow dimension\ncannot blank a sidebar.\n", "type": "text/plain" }, "url": { "path": [ "api", "facets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated subset of dimensions to return. Defaults to all of\nthem.\n", "type": "text/plain" }, "key": "fields", "value": "brands,fuels,gearboxes" }, { "disabled": true, "description": { "content": "`true` restricts to damaged/broken vehicles. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "damaged", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to Buy-Now listings. Also accepts `1`/`0`/`yes`/`no`.", "type": "text/plain" }, "key": "buy_now", "value": "" }, { "disabled": true, "description": { "content": "ISO country code from `/api/countries`, or the pseudo-country `europe`.\nAccepted and ignored by `/api/sites` and `/load-models`.\n", "type": "text/plain" }, "key": "country", "value": "DE" }, { "disabled": true, "description": { "content": "Brand display name, slug (from `/api/brands`), or numeric `brand_id`.", "type": "text/plain" }, "key": "brand", "value": "bmw" }, { "disabled": true, "description": { "content": "Model name or slug.", "type": "text/plain" }, "key": "model", "value": "320d" }, { "disabled": true, "description": { "content": "Lower bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_from", "value": "2018" }, { "disabled": true, "description": { "content": "Upper bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_to", "value": "2024" }, { "disabled": true, "description": { "content": "Canonical fuel group from `/api/fuels`.", "type": "text/plain" }, "key": "fuel", "value": "Diesel" }, { "disabled": true, "description": { "content": "Canonical gearbox group from `/api/gearboxes`.", "type": "text/plain" }, "key": "gearbox", "value": "Automatic" }, { "disabled": true, "description": { "content": "Lower bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_to", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_from", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "horsepower_to", "value": "" }, { "disabled": true, "description": { "content": "Lower bound on the public EUR price.", "type": "text/plain" }, "key": "price_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on the public EUR price.", "type": "text/plain" }, "key": "price_to", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of cars,suvs & trucks,suvs and trucks)", "type": "text/plain" }, "key": "vehicle_type", "value": "suvs and trucks" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "body_style", "value": "" }, { "disabled": true, "description": { "content": "`true` restricts to auctions ending within roughly two hours.", "type": "text/plain" }, "key": "ending_soon", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated source slugs from `/api/sites`, OR within the parameter.\nCase-insensitive; padding and empty members are ignored. An unknown slug\nis a `400` naming the offender.\n", "type": "text/plain" }, "key": "site", "value": "openlane,ecarstrade" }, { "disabled": true, "description": { "content": "Comma-separated source slugs to leave out. Same rules as `site`.", "type": "text/plain" }, "key": "site_exclude", "value": "copart" }, { "disabled": true, "description": { "content": "Which side the steering wheel is on. `left`/`lhd` and `right`/`rhd` are\nequivalent spellings; any other value is a 400.\n\nDerived rather than stored. `japanauction` is the only source that publishes a\nsteering field; for every other source the side is taken from the car's\nregistration market, so a car from an ISO country that drives on the left\n(GB, IE, JP, CY, MT, AU, NZ, ZA, IN, TH, HK, SG) is `right` and everything\nelse is `left`. Every listing resolves to one side or the other, so the\ntwo values partition the inventory and their totals sum to the unfiltered\ntotal. The same value is published on each result as `steering`.\n\nAccepted by `/api/search`, `/api/listVehicles`, `/api/top-offers` and\nevery facet endpoint, which narrow their option lists by it. Sending it\nto a facet endpoint takes that request off the precomputed facet table\nand onto a live aggregate, so it is slower than an unfiltered facet call.\n (This can only be one of left,lhd,right,rhd)", "type": "text/plain" }, "key": "steering", "value": "left" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "catalog", "description": "Slug-addressable manufacturer and model-group pages.", "item": [ { "id": "f6207c62-bca7-44c1-b18c-b823907f5800", "name": "Manufacturer catalog pages", "request": { "name": "Manufacturer catalog pages", "description": {}, "url": { "path": [ "api", "catalog", "manufacturers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Restrict counts to one country.", "type": "text/plain" }, "key": "country", "value": "DE" }, { "disabled": true, "description": { "content": "Page size. Capped at `pagination.max_limit` from `GET /api/contract`\n(100 by default); larger values are clamped down rather than rejected.\nDo not combine with `page_size` — that is a `400`.\n", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "0-based row offset. Do not combine with `page` — that is a `400`.\nBounded by `pagination.max_offset` (5000 by default) everywhere except\nan unfiltered `/api/search`.\n", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "1-based page number; maps to `offset = (page - 1) * limit`. Do not combine with `offset`.", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": true, "description": { "content": "Alias for `limit`. Do not combine with `limit`.", "type": "text/plain" }, "key": "page_size", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25812480-32be-4799-8b90-a63c0c992502", "name": "Aggregate manufacturer statistics", "request": { "name": "Aggregate manufacturer statistics", "description": {}, "url": { "path": [ "api", "catalog", "manufacturers", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Restrict counts to one country.", "type": "text/plain" }, "key": "country", "value": "DE" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25633dc2-dcc8-47fa-93e1-b337322663e7", "name": "One manufacturer by slug", "request": { "name": "One manufacturer by slug", "description": {}, "url": { "path": [ "api", "catalog", "manufacturers", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Restrict counts to one country.", "type": "text/plain" }, "key": "country", "value": "DE" } ], "variable": [ { "type": "any", "value": "", "key": "slug", "disabled": false, "description": { "content": "(Required) Manufacturer slug, e.g. from `/api/brands`.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ba60fde-ce63-4bda-88fb-16e6d3265989", "name": "Model-group catalog pages for a manufacturer", "request": { "name": "Model-group catalog pages for a manufacturer", "description": {}, "url": { "path": [ "api", "catalog", "model-groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Parent manufacturer slug. Omitting it is a `400`.", "type": "text/plain" }, "key": "manufacturer__slug", "value": "bmw" }, { "disabled": true, "description": { "content": "Substring filter on model name.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": true, "description": { "content": "Restrict counts to one country.", "type": "text/plain" }, "key": "country", "value": "DE" }, { "disabled": true, "description": { "content": "Page size. Capped at `pagination.max_limit` from `GET /api/contract`\n(100 by default); larger values are clamped down rather than rejected.\nDo not combine with `page_size` — that is a `400`.\n", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "0-based row offset. Do not combine with `page` — that is a `400`.\nBounded by `pagination.max_offset` (5000 by default) everywhere except\nan unfiltered `/api/search`.\n", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "1-based page number; maps to `offset = (page - 1) * limit`. Do not combine with `offset`.", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": true, "description": { "content": "Alias for `limit`. Do not combine with `limit`.", "type": "text/plain" }, "key": "page_size", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06506101-df77-479b-aa24-42eb2546710f", "name": "One model group by slug", "request": { "name": "One model group by slug", "description": {}, "url": { "path": [ "api", "catalog", "model-groups", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Parent manufacturer slug, to disambiguate a slug shared across brands.", "type": "text/plain" }, "key": "manufacturer__slug", "value": "bmw" }, { "disabled": true, "description": { "content": "Restrict counts to one country.", "type": "text/plain" }, "key": "country", "value": "DE" } ], "variable": [ { "type": "any", "value": "", "key": "slug", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "auctions", "description": "Single-auction detail, gallery images, price and VIN history.", "item": [ { "id": "7b484f56-c8bf-4614-b638-5420d7de20f8", "name": "Canonical auction detail", "request": { "name": "Canonical auction detail", "description": { "content": "Source-aware detail for one listing. Private bidder fields and\naccount-scoped commercial figures (our fees, our delivery quotes, our\nplatform identity) are stripped at the response boundary — see the\n\"Never exposed\" section of `docs/public-api-reference.md`.\n\n`vehicle_details` is the cross-source normalized condition and paperwork\nblock. Read it instead of branching on `site_name`. It is omitted\nentirely for a listing whose details have not been fetched yet.\n\n`vault_gallery` embeds the exact body of\n`/api/auction-images/{site_slug}/{auction_id}`, so a detail page is one\nrequest rather than two. Both read one cache entry and cannot disagree.\n\n**Live prices.** For a *running* `openlane` or `ecarstrade` auction this\nendpoint refreshes the bid from the source while serving the request and\nattaches a `live_price` block inside `auction`. Nothing has to be passed\nto enable it. See the `live_price` schema for how to read the three\npossible states.\n", "type": "text/plain" }, "url": { "path": [ "api", "auction", ":site_slug", ":auction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "auto1", "key": "site_slug", "disabled": false, "description": { "content": "(Required) A source slug from `/api/sites`. (This can only be one of schadeautos,auto1,openlane,copart,encar,ecarstrade,japanauction)", "type": "text/plain" } }, { "type": "any", "value": "", "key": "auction_id", "disabled": false, "description": { "content": "(Required) The integer database id of the auction.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c5a8088e-cebf-46c2-a63d-e80f55d36187", "name": "Price-change history for one listing", "request": { "name": "Price-change history for one listing", "description": { "content": "Chronological source-price and public-price snapshots.", "type": "text/plain" }, "url": { "path": [ "api", "auction", ":site_slug", ":auction_id", "price-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "auto1", "key": "site_slug", "disabled": false, "description": { "content": "(Required) A source slug from `/api/sites`. (This can only be one of schadeautos,auto1,openlane,copart,encar,ecarstrade,japanauction)", "type": "text/plain" } }, { "type": "any", "value": "", "key": "auction_id", "disabled": false, "description": { "content": "(Required) The integer database id of the auction.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "05f54ffc-01e2-4643-92b0-29949ed08866", "name": "Ordered gallery for one listing", "request": { "name": "Ordered gallery for one listing", "description": { "content": "Image-vault gallery metadata. **You usually do not need this call** —\n`/api/auction/{site_slug}/{auction_id}` embeds the same body as\n`vault_gallery`. This endpoint stays supported and is the right one when\nyou want the gallery on its own.\n\nEvery entry carries a URL that works right now: `served_url` once the\nvault has stored the photo, `remote_url` until then. Load `served_url`\ndirectly (same origin) and `remote_url` through an image proxy. Stored\nphotos are AVIF or WebP depending on what the source served — rely on\nthe URL and content type, not the extension.\n\n`pending` is how many photos the auction still owes, so you can show\nplaceholders instead of a silently short gallery. A non-zero `pending`\nalso promotes the outstanding rows to user-requested priority, and both\nthis and the detail response are served with `max-age=10` until it\nreaches zero.\n\nReturns `{\"success\": true, \"images\": []}` while nothing is stored yet.\n", "type": "text/plain" }, "url": { "path": [ "api", "auction-images", ":site_slug", ":auction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "auto1", "key": "site_slug", "disabled": false, "description": { "content": "(Required) A source slug from `/api/sites`. (This can only be one of schadeautos,auto1,openlane,copart,encar,ecarstrade,japanauction)", "type": "text/plain" } }, { "type": "any", "value": "", "key": "auction_id", "disabled": false, "description": { "content": "(Required) The integer database id of the auction.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "775c12b1-7066-491b-9724-21473af09401", "name": "Cross-source appearance history for a VIN", "request": { "name": "Cross-source appearance history for a VIN", "description": { "content": "Exact full-VIN lookup across current and archived auction records, up to\n100 matches, newest first.\n", "type": "text/plain" }, "url": { "path": [ "api", "vin", ":vin", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vin", "disabled": false, "description": { "content": "(Required) A valid 17-character VIN. Anything else is a `400`.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "details", "description": "Full vehicle detail payloads. Expensive; may fetch from the upstream source.", "item": [ { "id": "eb527c45-de36-4a6f-a259-5d3e90522220", "name": "Full detail payload by source and identifier", "request": { "name": "Full detail payload by source and identifier", "description": { "content": "**Expensive.** When the auction has no stored details this fetches from\nthe upstream source during the request and returns what it just stored,\ninstead of an empty shell.\n\nRead `details_pending` in the body and `X-Details-Fetch` in the headers\n(`fetched`, `pending`, or `miss`; absent when served from stored data).\nA fetch that exceeds the on-demand timeout keeps running in the\nbackground and the response comes back with `details_pending: true` —\npoll rather than retrying in a tight loop. Concurrent requests for the\nsame auction share a single upstream fetch, and a failure starts a short\nper-auction cooldown.\n\n**Response shape.** `vehicle_details` and the price fields are the parts\nof this response with a stable cross-source contract; everything else is\nsource-shaped. One trap worth naming: **the `auction` key here is not\nthe vehicle record.** For `openlane` it is\n`{\"extracted_fields\": {\"images\": [...]}}`, an image container that\nshares a name and nothing else. Read prices from the top level on this\nendpoint, and from inside `auction` on\n`/api/auction/{site_slug}/{auction_id}`.\n", "type": "text/plain" }, "url": { "path": [ "api", "car-details" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of schadeautos,auto1,openlane,copart,encar,ecarstrade,japanauction)", "type": "text/plain" }, "key": "site", "value": "auto1" }, { "disabled": true, "description": { "content": "Source id. Required unless `link` or `identifier` is given. For\n`auto1` and `japanauction` this is the offer id/UUID, not the numeric\nauction id.\n", "type": "text/plain" }, "key": "id", "value": "38112900" }, { "disabled": true, "description": { "content": "Listing URL. An alternative to `id`.", "type": "text/plain" }, "key": "link", "value": "" }, { "disabled": true, "description": { "content": "Source id or listing URL. An alternative to `id`.", "type": "text/plain" }, "key": "identifier", "value": "" }, { "disabled": true, "description": { "content": "Optional correlation id, echoed for your own tracing.", "type": "text/plain" }, "key": "search_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e2b67b2-3ebf-4bf1-82bb-5c0cc25d007e", "name": "Full detail payload by source and identifier (JSON body)", "request": { "name": "Full detail payload by source and identifier (JSON body)", "description": { "content": "Identical to the `GET` form, with the parameters in a JSON body.", "type": "text/plain" }, "url": { "path": [ "api", "car-details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"site\": \"copart\",\n \"id\": \"\",\n \"link\": \"\",\n \"identifier\": \"\",\n \"search_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d5082a60-8701-499c-8e7a-a7c38cbaa1c8", "name": "Catalog-shaped search alias", "request": { "name": "Catalog-shaped search alias", "description": { "content": "A compatibility alias for search with catalog-shaped parameter names.\nAlso served at `/listVehicles`.\n\nThis route is **not** granted by default: it bypasses the public\npagination caps, so it is a deliberate per-key grant.\n", "type": "text/plain" }, "url": { "path": [ "api", "listVehicles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "manufacturer_slug", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "manufacturer", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "model_group_slug", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "model_group", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "model", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fuel_type", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fuel", "value": "" }, { "disabled": true, "description": { "content": "Which side the steering wheel is on. `left`/`lhd` and `right`/`rhd` are\nequivalent spellings; any other value is a 400.\n\nDerived rather than stored. `japanauction` is the only source that publishes a\nsteering field; for every other source the side is taken from the car's\nregistration market, so a car from an ISO country that drives on the left\n(GB, IE, JP, CY, MT, AU, NZ, ZA, IN, TH, HK, SG) is `right` and everything\nelse is `left`. Every listing resolves to one side or the other, so the\ntwo values partition the inventory and their totals sum to the unfiltered\ntotal. The same value is published on each result as `steering`.\n\nAccepted by `/api/search`, `/api/listVehicles`, `/api/top-offers` and\nevery facet endpoint, which narrow their option lists by it. Sending it\nto a facet endpoint takes that request off the precomputed facet table\nand onto a live aggregate, so it is slower than an unfiltered facet call.\n (This can only be one of left,lhd,right,rhd)", "type": "text/plain" }, "key": "steering", "value": "left" }, { "disabled": true, "description": { "content": "e.g. `-created_at`, `price`, `-price`, `year`, `-year`.", "type": "text/plain" }, "key": "ordering", "value": "-created_at" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "min_year", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "max_year", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "max_mileage", "value": "" }, { "disabled": true, "description": { "content": "Page size. Capped at `pagination.max_limit` from `GET /api/contract`\n(100 by default); larger values are clamped down rather than rejected.\nDo not combine with `page_size` — that is a `400`.\n", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "0-based row offset. Do not combine with `page` — that is a `400`.\nBounded by `pagination.max_offset` (5000 by default) everywhere except\nan unfiltered `/api/search`.\n", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "1-based page number; maps to `offset = (page - 1) * limit`. Do not combine with `offset`.", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": true, "description": { "content": "Alias for `limit`. Do not combine with `limit`.", "type": "text/plain" }, "key": "page_size", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "50a77fdf-a940-43ce-b0b8-deb395bb912a", "name": "Catalog-shaped search alias (JSON body)", "request": { "name": "Catalog-shaped search alias (JSON body)", "description": {}, "url": { "path": [ "api", "listVehicles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manufacturer_slug\": \"\",\n \"manufacturer\": \"\",\n \"brand\": \"\",\n \"model_group_slug\": \"\",\n \"model_group\": \"\",\n \"model\": \"\",\n \"fuel_type\": \"\",\n \"fuel\": \"\",\n \"steering\": \"lhd\",\n \"ordering\": \"\",\n \"min_year\": \"\",\n \"max_year\": \"\",\n \"max_mileage\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\",\n \"page_size\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ac0936f-99d4-45b9-840e-bb62ceee50ac", "name": "Catalog-shaped search alias (unprefixed path)", "request": { "name": "Catalog-shaped search alias (unprefixed path)", "description": { "content": "Identical to `/api/listVehicles`. Kept for older integrations.", "type": "text/plain" }, "url": { "path": [ "listVehicles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "manufacturer_slug", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "manufacturer", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "model_group_slug", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "model_group", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "model", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fuel_type", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fuel", "value": "" }, { "disabled": true, "description": { "content": "Which side the steering wheel is on. `left`/`lhd` and `right`/`rhd` are\nequivalent spellings; any other value is a 400.\n\nDerived rather than stored. `japanauction` is the only source that publishes a\nsteering field; for every other source the side is taken from the car's\nregistration market, so a car from an ISO country that drives on the left\n(GB, IE, JP, CY, MT, AU, NZ, ZA, IN, TH, HK, SG) is `right` and everything\nelse is `left`. Every listing resolves to one side or the other, so the\ntwo values partition the inventory and their totals sum to the unfiltered\ntotal. The same value is published on each result as `steering`.\n\nAccepted by `/api/search`, `/api/listVehicles`, `/api/top-offers` and\nevery facet endpoint, which narrow their option lists by it. Sending it\nto a facet endpoint takes that request off the precomputed facet table\nand onto a live aggregate, so it is slower than an unfiltered facet call.\n (This can only be one of left,lhd,right,rhd)", "type": "text/plain" }, "key": "steering", "value": "left" }, { "disabled": true, "description": { "content": "e.g. `-created_at`, `price`, `-price`, `year`, `-year`.", "type": "text/plain" }, "key": "ordering", "value": "-created_at" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "min_year", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "max_year", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "max_mileage", "value": "" }, { "disabled": true, "description": { "content": "Page size. Capped at `pagination.max_limit` from `GET /api/contract`\n(100 by default); larger values are clamped down rather than rejected.\nDo not combine with `page_size` — that is a `400`.\n", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "0-based row offset. Do not combine with `page` — that is a `400`.\nBounded by `pagination.max_offset` (5000 by default) everywhere except\nan unfiltered `/api/search`.\n", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "1-based page number; maps to `offset = (page - 1) * limit`. Do not combine with `offset`.", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": true, "description": { "content": "Alias for `limit`. Do not combine with `limit`.", "type": "text/plain" }, "key": "page_size", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f5e9d8f-3ab6-4af5-8903-ee459a49f2f0", "name": "Catalog-shaped search alias (unprefixed path, JSON body)", "request": { "name": "Catalog-shaped search alias (unprefixed path, JSON body)", "description": {}, "url": { "path": [ "listVehicles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manufacturer_slug\": \"\",\n \"manufacturer\": \"\",\n \"brand\": \"\",\n \"model_group_slug\": \"\",\n \"model_group\": \"\",\n \"model\": \"\",\n \"fuel_type\": \"\",\n \"fuel\": \"\",\n \"steering\": \"lhd\",\n \"ordering\": \"\",\n \"min_year\": \"\",\n \"max_year\": \"\",\n \"max_mileage\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\",\n \"page_size\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "top-offers", "description": "Live auctions priced below their market reference.", "item": [ { "id": "587409c6-f6dc-4e7e-8806-feb31d7ef968", "name": "Live auctions priced below their market reference", "request": { "name": "Live auctions priced below their market reference", "description": { "content": "The same deals `/api/search?sort=top_offers` surfaces, as a feed of their\nown — and each card additionally carries the `market_reference` the\nverdict was made against, which search does not return.\n\nA car qualifies only when its saving clears a continuous,\nreference-quality-aware bar (wider price spread, thinner evidence and\nslower-selling models all raise it), so this is a shortlist, not\n\"everything below average\". Rows leave the feed the moment the auction\nends, so `total` shrinks through the day and grows again after each\ncomparison run.\n\nA non-numeric value on any numeric parameter is a `400`, not a dropped\nfilter. These are cycle prices, never live-refreshed.\n", "type": "text/plain" }, "url": { "path": [ "api", "top-offers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated source slugs from `/api/sites`, OR within the parameter.\nCase-insensitive; padding and empty members are ignored. An unknown slug\nis a `400` naming the offender.\n", "type": "text/plain" }, "key": "site", "value": "openlane,ecarstrade" }, { "disabled": true, "description": { "content": "Comma-separated source slugs to leave out. Same rules as `site`.", "type": "text/plain" }, "key": "site_exclude", "value": "copart" }, { "disabled": true, "description": { "content": "Exact `clean_make`, case-insensitive.", "type": "text/plain" }, "key": "brand", "value": "BMW" }, { "disabled": true, "description": { "content": "Exact `clean_model`, case-insensitive.", "type": "text/plain" }, "key": "model", "value": "3 Series" }, { "disabled": true, "description": { "content": "Vehicle country code, case-insensitive.", "type": "text/plain" }, "key": "country", "value": "DE" }, { "disabled": true, "description": { "content": "Lower bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_from", "value": "2018" }, { "disabled": true, "description": { "content": "Upper bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_to", "value": "2024" }, { "disabled": true, "description": { "content": "Lower bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_to", "value": "" }, { "disabled": true, "description": { "content": "Lower bound on the public EUR price.", "type": "text/plain" }, "key": "price_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on the public EUR price.", "type": "text/plain" }, "key": "price_to", "value": "" }, { "disabled": true, "description": { "content": "Only offers saving at least this percentage.", "type": "text/plain" }, "key": "min_savings_pct", "value": "20" }, { "disabled": true, "description": { "content": " (This can only be one of savings_pct,savings,price_low,price_high,newest)", "type": "text/plain" }, "key": "sort", "value": "savings_pct" }, { "disabled": true, "description": { "content": "Page size. Capped at `pagination.max_limit` from `GET /api/contract`\n(100 by default); larger values are clamped down rather than rejected.\nDo not combine with `page_size` — that is a `400`.\n", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "0-based row offset. Do not combine with `page` — that is a `400`.\nBounded by `pagination.max_offset` (5000 by default) everywhere except\nan unfiltered `/api/search`.\n", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "1-based page number; maps to `offset = (page - 1) * limit`. Do not combine with `offset`.", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": true, "description": { "content": "Alias for `limit`. Do not combine with `limit`.", "type": "text/plain" }, "key": "page_size", "value": "" }, { "disabled": true, "description": { "content": "Which side the steering wheel is on. `left`/`lhd` and `right`/`rhd` are\nequivalent spellings; any other value is a 400.\n\nDerived rather than stored. `japanauction` is the only source that publishes a\nsteering field; for every other source the side is taken from the car's\nregistration market, so a car from an ISO country that drives on the left\n(GB, IE, JP, CY, MT, AU, NZ, ZA, IN, TH, HK, SG) is `right` and everything\nelse is `left`. Every listing resolves to one side or the other, so the\ntwo values partition the inventory and their totals sum to the unfiltered\ntotal. The same value is published on each result as `steering`.\n\nAccepted by `/api/search`, `/api/listVehicles`, `/api/top-offers` and\nevery facet endpoint, which narrow their option lists by it. Sending it\nto a facet endpoint takes that request off the precomputed facet table\nand onto a live aggregate, so it is slower than an unfiltered facet call.\n (This can only be one of left,lhd,right,rhd)", "type": "text/plain" }, "key": "steering", "value": "left" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "theparking", "description": "theparking classifieds. Retail listings, not auction inventory.", "item": [ { "id": "f6278962-d97c-4d65-91ae-527f2779fe32", "name": "theparking classifieds feed", "request": { "name": "theparking classifieds feed", "description": { "content": "Retail classifieds aggregated from portals across Europe. **Not auction\ninventory**: no bidding, no auction end date, no detail payload and no\ngallery — a single remote thumbnail per listing. theparking is\ntherefore never a valid `site` value on `/api/search` and never appears\nin `/api/sites`.\n\nEnded and paid-placement (\"promoted\") rows are excluded from every\nresponse. Every multi-value filter is OR within the parameter and AND\nacross parameters. A non-numeric value on a numeric parameter is a `400`.\n\n**Selecting portals.** The vocabulary is ~680 origin portals wide, which\nis why `source_exclude` exists — it is the only practical way to say\n\"everything but\". Unlike `site` on the auction side, an unrecognised\nportal is **not** an error: the vocabulary is scraped rather than fixed,\nso an unknown value simply matches nothing (or excludes nothing). A\nlisting with no recorded portal survives an exclusion.\n\n**Reading `total`.** The feed holds ~9.7M listings, so counting is\nbounded rather than exhaustive — see `total_capped` and\n`total_unavailable`. When you do not need a count, `include_total=false`\nis always the fastest option.\n", "type": "text/plain" }, "url": { "path": [ "api", "theparking", "listings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated country codes, case-insensitive.", "type": "text/plain" }, "key": "country", "value": "de,at" }, { "disabled": true, "description": { "content": "Comma-separated brands, exact as published.", "type": "text/plain" }, "key": "brand", "value": "BMW" }, { "disabled": true, "description": { "content": "Comma-separated models.", "type": "text/plain" }, "key": "model", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated normalized fuels.", "type": "text/plain" }, "key": "fuel", "value": "diesel" }, { "disabled": true, "description": { "content": "Comma-separated normalized gearboxes.", "type": "text/plain" }, "key": "gearbox", "value": "automatic" }, { "disabled": true, "description": { "content": "Comma-separated seller types.", "type": "text/plain" }, "key": "seller", "value": "dealer" }, { "disabled": true, "description": { "content": "Comma-separated origin portals, case-insensitive.", "type": "text/plain" }, "key": "source", "value": "mobile.de" }, { "disabled": true, "description": { "content": "Comma-separated origin portals to leave out, case-insensitive.", "type": "text/plain" }, "key": "source_exclude", "value": "mobile.de" }, { "disabled": true, "description": { "content": "Lower bound on the public EUR price.", "type": "text/plain" }, "key": "price_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on the public EUR price.", "type": "text/plain" }, "key": "price_to", "value": "" }, { "disabled": true, "description": { "content": "Lower bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_from", "value": "2018" }, { "disabled": true, "description": { "content": "Upper bound on registration year, inclusive.", "type": "text/plain" }, "key": "year_to", "value": "2024" }, { "disabled": true, "description": { "content": "Lower bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_from", "value": "" }, { "disabled": true, "description": { "content": "Upper bound on mileage in kilometres.", "type": "text/plain" }, "key": "kilometers_to", "value": "" }, { "disabled": true, "description": { "content": "Substring match on title and description. Has no index behind it, so\nit is the filter most likely to set `total_unavailable`.\n", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": true, "description": { "content": "Only listings that carry a thumbnail.", "type": "text/plain" }, "key": "with_photo", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of newest,price_low,price_high,year_new,year_old,mileage_low)", "type": "text/plain" }, "key": "sort", "value": "newest" }, { "disabled": true, "description": { "content": "`false` returns `total: null` and skips the count.", "type": "text/plain" }, "key": "include_total", "value": "true" }, { "disabled": true, "description": { "content": "Page size. Capped at `pagination.max_limit` from `GET /api/contract`\n(100 by default); larger values are clamped down rather than rejected.\nDo not combine with `page_size` — that is a `400`.\n", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "0-based row offset. Do not combine with `page` — that is a `400`.\nBounded by `pagination.max_offset` (5000 by default) everywhere except\nan unfiltered `/api/search`.\n", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "1-based page number; maps to `offset = (page - 1) * limit`. Do not combine with `offset`.", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": true, "description": { "content": "Alias for `limit`. Do not combine with `limit`.", "type": "text/plain" }, "key": "page_size", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a954a65-4295-4ce5-a06c-31667dc46ae6", "name": "Counted filter vocabulary for the classifieds feed", "request": { "name": "Counted filter vocabulary for the classifieds feed", "description": { "content": "Precomputed by the nightly scrape and read back in ~10 ms, so it is warm\nas soon as the data changes and no request pays to compute it. Any\ndimension not yet precomputed is counted on demand and cached for an\nhour.\n\nThe default trim matters most for `sources`: there are ~680 origin\nportals, so the full list is useful as data but not as a picker.\n`value_counts.sources` tells you how many exist; `limit=0` returns them\nall.\n", "type": "text/plain" }, "url": { "path": [ "api", "theparking", "facets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Values returned **per dimension**. `0` returns all of them.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6c85cc5-d71b-4340-aae7-415235375e40", "name": "Models available for given classifieds brands", "request": { "name": "Models available for given classifieds brands", "description": { "content": "Most common first, capped at 400. Use it to narrow a model select after\na brand is picked.\n", "type": "text/plain" }, "url": { "path": [ "api", "theparking", "models" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Comma-separated brands. Omitting it is a `400`.", "type": "text/plain" }, "key": "brand", "value": "BMW,Audi" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "market", "description": "Precomputed Cars.bg and auction market price snapshots.", "item": [ { "id": "fe3ec68b-b5ca-42e8-a93a-c90eabca29d3", "name": "Cars.bg retail market snapshot", "request": { "name": "Cars.bg retail market snapshot", "description": { "content": "A precomputed price snapshot for a brand/model/year window on the\nBulgarian retail market. Cycle prices, never live-refreshed.\n", "type": "text/plain" }, "url": { "path": [ "api", "cars-bg-market" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Required, unless given as `make`.", "type": "text/plain" }, "key": "brand", "value": "BMW" }, { "disabled": true, "description": { "content": "Alias for `brand`.", "type": "text/plain" }, "key": "make", "value": "BMW" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "model", "value": "320d" }, { "disabled": false, "description": { "content": "(Required) Centre year of the window.", "type": "text/plain" }, "key": "year", "value": "2019" }, { "disabled": true, "description": { "content": "Year tolerance either side of `year`.", "type": "text/plain" }, "key": "flex", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac6bb406-47cd-4ba2-b939-9e2c461470a5", "name": "Auction market snapshot", "request": { "name": "Auction market snapshot", "description": { "content": "Same window as `/api/cars-bg-market`, measured across auction inventory.", "type": "text/plain" }, "url": { "path": [ "api", "auction-market" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Required, unless given as `make`.", "type": "text/plain" }, "key": "brand", "value": "BMW" }, { "disabled": true, "description": { "content": "Alias for `brand`.", "type": "text/plain" }, "key": "make", "value": "BMW" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "model", "value": "320d" }, { "disabled": false, "description": { "content": "(Required) Centre year of the window.", "type": "text/plain" }, "key": "year", "value": "2019" }, { "disabled": true, "description": { "content": "Year tolerance either side of `year`.", "type": "text/plain" }, "key": "flex", "value": "1" }, { "disabled": true, "description": { "content": "Which inventory the snapshot covers. (This can only be one of all,active,inactive)", "type": "text/plain" }, "key": "scope", "value": "all" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "calculator", "description": "Landed import-cost estimator.", "item": [ { "id": "02f080a0-f1eb-41ec-b4e2-958e308d73a7", "name": "Supported origin and destination countries", "request": { "name": "Supported origin and destination countries", "description": {}, "url": { "path": [ "api", "calculator", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89f486a4-9fdd-47ed-a3ce-df545c002985", "name": "Estimate the landed cost of importing a vehicle", "request": { "name": "Estimate the landed cost of importing a vehicle", "description": { "content": "Duty and VAT rates come back as **percentages**, not fractions. These\nare estimates, not a binding quote.\n\n`site_name` selects the fee model. Fees come from that source profile\nrather than from a caller-supplied `db_tax`: a stored tax is only as\nfresh as the last price-modifier run.\n", "type": "text/plain" }, "url": { "path": [ "api", "calculator", "calculate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"price\": \"\",\n \"origin\": \"KR\",\n \"destination\": \"BG\",\n \"car_type\": \"standard\",\n \"currency\": \"EUR\",\n \"site_name\": \"auto1\",\n \"is_margin\": \"\",\n \"db_tax\": \"\",\n \"db_delivery\": \"\",\n \"db_final\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "seo", "description": "Popular searches and slug lookups for landing pages.", "item": [ { "id": "1145d94c-cd09-4063-8231-47fc20455039", "name": "Most common brand/model pairs in current inventory", "request": { "name": "Most common brand/model pairs in current inventory", "description": {}, "url": { "path": [ "api", "seo", "popular-searches" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8284ac6f-55ed-440a-98b6-61a43572d3cb", "name": "Resolve a brand/model slug pair to canonical display names", "request": { "name": "Resolve a brand/model slug pair to canonical display names", "description": {}, "url": { "path": [ "api", "seo", "brand-model-from-slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "brand_slug", "value": "bmw" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "model_slug", "value": "320d" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Echo back the `ETag` from your last response for this URL. An unchanged\npage answers `304 Not Modified` with no body. ETags are weak, so the tag\nstays valid whether or not the body came back compressed.\n", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "ops", "description": "Health, contract and diagnostics.", "item": [ { "id": "6a73f403-62f5-4670-a169-2d0b6d82d702", "name": "Human-readable endpoint listing", "request": { "name": "Human-readable endpoint listing", "description": {}, "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c721d75-d770-4093-904b-78f55b8ea2ba", "name": "Process liveness", "request": { "name": "Process liveness", "description": { "content": "Unauthenticated. Always `200` while the process is up.", "type": "text/plain" }, "url": { "path": [ "api", "health", "live" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2ad001a-792b-44b1-8abf-8f02cbf1eced", "name": "Readiness (database reachable)", "request": { "name": "Readiness (database reachable)", "description": { "content": "Unauthenticated.", "type": "text/plain" }, "url": { "path": [ "api", "health", "ready" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "97803894-3432-40d6-b1e4-c880935bb1af", "name": "Dependency and schema health", "request": { "name": "Dependency and schema health", "description": { "content": "`status` is `healthy` or `degraded`. A degraded response carries\n`schema_findings` describing what failed; the HTTP status stays `200`.\n", "type": "text/plain" }, "url": { "path": [ "api", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c052148-f5de-472f-ae79-182542a01971", "name": "Machine-readable schema catalog and limits", "request": { "name": "Machine-readable schema catalog and limits", "description": { "content": "Read this once at startup. It is the authoritative source for the\npagination ceilings and for whether this deployment can refresh live\nprices at all — in a detail response, \"this deployment cannot refresh\nprices\" and \"this car has no live price right now\" look identical. The\n`live_prices` block is **absent** on a build from before the feature,\nwhich is the only way to tell those two apart.\n\nDo not hardcode `live_prices.sites`; read it from here.\n", "type": "text/plain" }, "url": { "path": [ "api", "contract" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "411d90be-3731-474b-b92b-4eba662ae1ac", "name": "Session-pool and executor state", "request": { "name": "Session-pool and executor state", "description": { "content": "Infrastructure only. Not granted to customer keys by default.", "type": "text/plain" }, "url": { "path": [ "api", "diagnostics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.thecarapi.com" }, { "key": "apiKey", "value": "", "type": "string", "description": "Your API key. Ask the operator to issue one." } ], "info": { "_postman_id": "d78dd9c6-294b-4444-8dd2-22667690c750", "name": "The Car API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Generated from openapi.yaml with scripts/build_postman_collection.py.\n\nSet the `apiKey` collection variable and every request is ready to send. Optional query parameters are present but disabled - tick the ones you want.\n\nResponse examples are not included; send a request to see real data." } }