Skip to main content
POST
/
api
/
carsensor
/
listings
/
search
/carsensor/listings/search
curl --request POST \
  --url https://api.anysite.io/api/carsensor/listings/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "keyword": "サンルーフ",
  "model": "S122",
  "color": [],
  "features": [],
  "price_body_min": 1,
  "price_body_max": 1,
  "monthly_payment_min": 1,
  "monthly_payment_max": 1,
  "down_payment_max": 1,
  "year_min": 1901,
  "year_max": 1901,
  "mileage_min": 1,
  "mileage_max": 1,
  "displacement_min": 1,
  "displacement_max": 1,
  "doors": 3,
  "seats": 6,
  "no_repair_history": false,
  "one_owner": false,
  "non_smoking": false,
  "unused": false,
  "certified": false,
  "maker_dealer": false,
  "has_total_price": false,
  "multiple_photos": false,
  "sort": "relevance"
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "CarsensorListingCard",
    "body_price": 123,
    "total_price": 123,
    "currency": "JPY",
    "year": 123,
    "mileage": 123,
    "inspection": "<string>",
    "repair_history": "<string>",
    "warranty": "<string>",
    "prefecture": "<string>",
    "city": "<string>",
    "dealer_id": "<string>",
    "dealer_pref": "<string>",
    "dealer_name": "<string>",
    "dealer_rating": 123,
    "dealer_review_count": 123,
    "image": "<string>"
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required

Max number of results to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
keyword
string | null

Free-text keyword

Minimum string length: 1
Example:

"サンルーフ"

maker
enum<string> | null

Car maker

Available options:
lexus,
toyota,
nissan,
honda,
mazda,
subaru,
suzuki,
mitsubishi,
daihatsu,
isuzu,
mitsuoka,
tommykaira,
hino,
ud_trucks,
fuso,
domestic_other,
mercedes_benz,
mercedes_amg,
mercedes_maybach,
amg,
maybach,
smart,
bmw,
alpina,
audi,
volkswagen,
opel,
porsche,
brabus,
artega,
mini,
cadillac,
chevrolet,
buick,
pontiac,
saturn,
hummer,
gmc,
ford,
lincoln,
mercury,
saleen,
chrysler,
dodge,
plymouth,
amc,
amc_jeep,
jeep,
oldsmobile,
winnebago,
dmc,
tesla,
us_lexus,
us_infiniti,
us_acura,
us_toyota,
scion,
us_nissan,
us_honda,
us_mazda,
us_subaru,
us_mitsubishi,
rolls_royce,
bentley,
jaguar,
daimler,
land_rover,
aston_martin,
lotus,
london_taxi,
mclaren,
mg,
rover,
austin,
morris,
bl,
moke,
marcos,
vanden_plas,
wolseley,
riley,
caterham,
westfield,
morgan,
panther,
triumph,
healey,
ginetta,
vauxhall,
volvo,
saab,
scania,
peugeot,
renault,
citroen,
ds,
bugatti,
alpine,
fiat,
alfa_romeo,
ferrari,
lamborghini,
maserati,
lancia,
autobianchi,
abarth,
innocenti,
de_tomaso,
ktm,
hooten,
lada,
byd,
hyundai,
thai_toyota,
td,
birkin,
import_other
model
string | null

CarSensor model code (requires maker), e.g. 'S122'

Minimum string length: 1
Example:

"S122"

body_type
enum<string> | null

Body type

Available options:
kei,
compact,
minivan,
station_wagon,
suv,
sedan,
coupe,
hatchback,
open_car,
pickup_truck,
truck,
other
fuel
enum<string> | null

Fuel type

Available options:
petrol,
diesel,
hybrid,
electric,
other
drive
enum<string> | null

Drive type

Available options:
2wd,
4wd
transmission
enum<string> | null

Transmission type

Available options:
at,
mt
steering
enum<string> | null

Steering wheel side

Available options:
right,
left
prefecture
enum<string> | null

Prefecture

Available options:
hokkaido,
aomori,
iwate,
miyagi,
akita,
yamagata,
fukushima,
ibaraki,
tochigi,
gunma,
saitama,
chiba,
tokyo,
kanagawa,
niigata,
toyama,
ishikawa,
fukui,
yamanashi,
nagano,
gifu,
shizuoka,
aichi,
mie,
shiga,
kyoto,
osaka,
hyogo,
nara,
wakayama,
tottori,
shimane,
okayama,
hiroshima,
yamaguchi,
tokushima,
kagawa,
ehime,
kouchi,
fukuoka,
saga,
nagasaki,
kumamoto,
ooita,
miyazaki,
kagoshima,
okinawa
color
enum<string>[] | null

Exterior colors

Available options:
white,
pearl,
black,
blue,
silver,
gray,
brown,
red,
green,
purple,
yellow,
pink,
orange,
gold,
other
warranty
enum<string> | null

Warranty type

Available options:
any,
dealer,
shop,
carsensor_after
inspection
enum<string> | null

Minimum remaining vehicle inspection

Available options:
half_year,
one_year,
two_years
sliding_door
enum<string> | null

Sliding door type

Available options:
both_power,
both_manual,
one_power,
one_manual,
both_one_power
audio
enum<string> | null

Audio equipment

Available options:
cd,
md,
cd_md,
music_server,
music_player_ready
nav_tv
enum<string> | null

Navigation/TV equipment

Available options:
car_navi,
cd_navi,
dvd_navi,
hdd_navi,
memory_navi,
tv,
one_seg_tv,
full_seg_tv,
navi_tv,
dvd_play,
bluray_play
features
enum<string>[] | null

Required equipment/condition features

Available options:
no_repair_history,
one_owner,
non_smoking,
registered_unused,
maintenance_record,
test_drive_car,
rental_up,
cold_weather_spec,
turbo,
keyless_entry,
smart_key,
power_window,
power_steering,
air_conditioner,
dual_air_conditioner,
hid_headlight,
fog_lamp,
auto_high_beam,
led_headlight,
adaptive_headlight,
etc,
anti_theft,
sunroof,
roof_rail,
rear_seat_monitor,
air_suspension,
power_supply_1500w,
drive_recorder,
power_tailgate,
display_audio,
abs,
support_car,
collision_brake,
cruise_control,
adaptive_cruise,
lane_keep_assist,
parking_assist,
pedal_misstep_prevention,
stability_control,
obstacle_sensor,
driver_airbag,
passenger_airbag,
side_airbag,
curtain_airbag,
active_headrest,
front_camera,
side_camera,
back_camera,
around_view_monitor,
blind_spot_monitor,
rear_traffic_monitor,
hill_descent_control,
idling_stop,
eco_car,
full_aero,
lowered,
alloy_wheels,
repainted,
lifted_up,
full_flat_seats,
third_row_seats,
walk_through,
seat_heater,
seat_air_conditioner,
leather_seats,
bench_seats,
electric_seats,
ottoman
price_body_min
integer | null

Minimum body price (JPY)

Required range: x >= 0
price_body_max
integer | null

Maximum body price (JPY)

Required range: x >= 0
monthly_payment_min
integer | null

Minimum monthly loan payment (JPY)

Required range: x >= 0
monthly_payment_max
integer | null

Maximum monthly loan payment (JPY)

Required range: x >= 0
down_payment_max
integer | null

Maximum loan down payment (JPY)

Required range: x >= 0
year_min
integer | null

Minimum production year

Required range: x >= 1900
year_max
integer | null

Maximum production year

Required range: x >= 1900
mileage_min
integer | null

Minimum mileage (km)

Required range: x >= 0
mileage_max
integer | null

Maximum mileage (km)

Required range: x >= 0
displacement_min
integer | null

Minimum engine displacement (cc)

Required range: x >= 0
displacement_max
integer | null

Maximum engine displacement (cc)

Required range: x >= 0
doors
integer | null

Number of doors

Required range: 2 <= x <= 5
seats
integer | null

Number of seats

Required range: 2 <= x <= 10
no_repair_history
boolean
default:false

Only listings with no repair history

one_owner
boolean
default:false

Only one-owner listings

non_smoking
boolean
default:false

Only non-smoking-car listings

unused
boolean
default:false

Only registered/unused (nearly new) listings

certified
boolean
default:false

Only CarSensor certified-quality listings

maker_dealer
boolean
default:false

Only maker-affiliated dealers

has_total_price
boolean
default:false

Only listings that disclose total price

multiple_photos
boolean
default:false

Only listings with multiple photos

sort
enum<string>
default:relevance

Sort order

Available options:
relevance,
total_price_asc,
total_price_desc,
body_price_asc,
body_price_desc,
year_asc,
year_desc,
mileage_asc,
mileage_desc

Response

Successful Response

id
string
required
url
string
required
@type
string
default:CarsensorListingCard
body_price
number | null
total_price
number | null
currency
string
default:JPY
year
integer | null
mileage
integer | null
inspection
string | null
repair_history
string | null
warranty
string | null
prefecture
string | null
city
string | null
dealer_id
string | null
dealer_pref
string | null
dealer_name
string | null
dealer_rating
number | null
dealer_review_count
integer | null
image
string | null