API Docs | Automotive Avenue NJ

REST API

v1.0

Access vehicle inventory data programmatically. All endpoints return JSON.

Base URL: /api Format: JSON Auth: None

Endpoints

GET /api/vehicles List all vehicles GET /api/vehicles/:vin Get single vehicle GET /api/vehicles/stats Inventory statistics GET /api/search Search vehicles

GET /api/vehicles

Retrieve a paginated list of vehicles with optional filtering and sorting.

Query Parameters

Parameter	Type	Default	Description
`page`	integer	1	Page number
`limit`	integer	20	Items per page (max 100)
`sort`	string	price	Sort field: price, mileage, name
`order`	string	asc	Sort order: asc, desc
`minPrice`	integer	—	Minimum price filter
`maxPrice`	integer	—	Maximum price filter
`make`	string	—	Filter by vehicle make
`location`	string	—	Filter by location
`search`	string	—	Full-text search

GET /api/vehicles/:vin

Retrieve a single vehicle by its VIN (Vehicle Identification Number).

Path Parameters

Parameter	Type	Description
`vin`	string	17-character Vehicle Identification Number

GET /api/vehicles/stats

Get aggregated statistics: total count, price ranges, average price, makes distribution, and location breakdown.

GET /api/search

Full-text search across vehicle name, VIN, color, and location fields.

Query Parameters

Parameter	Type	Description
`q`	string	Search query (required)
`page`	integer	Page number (default: 1)
`limit`	integer	Items per page (default: 20)

Response Format

All endpoints return a consistent JSON structure:

{
  "success": true,
  "data": [...],           // Array or object
  "pagination": {          // Only for list endpoints
    "page": 1,
    "limit": 20,
    "total": 1000,
    "totalPages": 50,
    "hasNext": true,
    "hasPrev": false
  }
}

Error Response (404):

{
  "success": false,
  "error": "Vehicle not found"
}

Vehicle Object

Field	Type	Description
`name`	string	Full vehicle name (year, make, model, trim)
`vin`	string	17-character VIN
`price`	string	Listing price (e.g. "$15,995")
`retailAvg`	string	Average retail price
`savings`	string	Savings vs retail average
`mileage`	string	Odometer reading (e.g. "61,438")
`exterior`	string	Exterior color
`interior`	string	Interior color
`location`	string	Dealership location
`link`	string	URL to original listing
`img`	string	Vehicle image URL