General
All API requests use POST method. Data is sent in JSON format (raw body).
Response format
All responses follow a unified JSON structure:
{
"status": "OK | err",
"msg": "string (optional)",
"data": {}
}Success (HTTP 200)
{
"status": "OK",
"data": {}
}Error
{
"status": "err",
"msg": "Error description"
}User Registration
/api/user/create
- email * — User email
- password * — User password
User Authentication
/api/user/auth
- email * — User email
- password * — User password
On success API returns Token used for all authenticated requests.
Vehicle Category
/api/filter/category
No parameters required.
Car Brand
/api/filter/brand
- int id_category — Vehicle category ID
Car Model
/api/filter/model
- int id_brand * — Brand ID
Body Type
/api/filter/body
- int id_category * — Vehicle category ID
Generation
/api/filter/generation
- int id_model * — Car model ID
Modification
/api/filter/modification
- int id_generation * — Generation ID
Regions
/api/filter/state
No parameters required.
Cities
/api/filter/city
- id_state * — Region ID
Additional Filters
/api/filter/general
No parameters required.
Add car
/api/car/create
- int id_category * — Category ID
- int id_brand * — Brand ID
- int id_model * — Model ID
- int price * — Price $
- int mileage * — Mileage (kilometers)
- int year * — Year
Add image
/api/car/img
- int id_car * — Car ID
- array img * — image/images
Add car
/api/car/search
- int id_category — Category ID
- int id_generation — Generation ID
- int id_modification — Modification ID
- int id_body — Body type ID
- int id_state — State ID
- int id_city — City ID
- int id_brand — Brand ID (min 0)
- int id_model — Model ID (min 0)
- int year_from — Year from (min 1920)
- int year_to — Year to (min 1920, max current year)
- int id_air_conditioners — Air conditioners option ID
- int id_headlight_types — Headlight type ID
- int id_interior_colors — Interior color ID
- int id_interior_materials — Interior material ID
- int id_power_steering_types — Power steering type ID
- int id_power_windows — Power windows ID
- int id_seat_heating_options — Seat heating option ID
- int id_seat_height_adjustments — Seat height adjustment ID
- int id_seat_memory_options — Seat memory option ID
- int id_seat_ventilation_options — Seat ventilation option ID
- int id_spare_wheel_types — Spare wheel type ID
- int id_steering_adjustments — Steering adjustment ID
- int count_owner_from — Owner count from (min 1)
- int count_owner_to — Owner count to (max 50)
- int count_doors_from — Doors count from (min 1)
- int count_doors_to — Doors count to (max 10)
- int mileage_from — Mileage from (min 0)
- int mileage_to — Mileage to (max 10000)
- array id_fuels — Fuel types IDs
- array id_gearboxs — Gearbox types IDs
- array id_drives — Drive types IDs
- array id_colors — Color IDs
- array id_driven_froms — Driven-from IDs
- array car_group — Complex grouped filters (AND inside, OR between groups)
- string price_currency (uah, usd, eur) — Price currency
- int price_from — Minimum price
- int price_to — Maximum price
- string vin — VIN code (17 chars)
- int page — Page number (0–999)
Example request
{
"price_currency":"uah",
"id_model":3,
"id_brand":2,
"year_from":1990,
"year_to":2024,
"id_fuels":[1,2],
"id_gearboxs":[1,2],
"id_drives":[1,3],
"id_colors":[1],
"id_driven_froms":[4,1],
"car_group":[
{
"id_brand":1,
"id_model":2,
"id_body":4,
"year_from":1995,
"year_to":1999
},
{
"id_brand":1,
"id_model":2,
"id_body":4,
"year_from":2015,
"year_to":2025
}
]
}