v1.0.0

API Documentation

Learn how to use the Car Price Predictor API

Navigation

Open Swagger UI

Interactive API documentation with live testing

Open Swagger UI

API Reference

Complete API endpoint documentation

Open ReDoc

Base URL

https://api.carwiseiq.com

Checking...

Authentication

Currently, the API does not require authentication for development use. All endpoints are publicly accessible. In production, authentication may be required.

Example with Authorization Header:

headers: {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer YOUR_API_KEY'
}

Rate Limits

Requests per minuteUnlimited

API is currently unlimited for development. Production limits may apply.

Try the API

Test endpoints directly from the documentation

Method

Endpoint

Endpoints

Available API endpoints and their usage

Response Example

200

1{
2  "status": "healthy",
3  "message": "API is running",
4  "model_loaded": true,
5  "timestamp": "2025-01-01T00:00:00Z"
6}

Example Usage

Code examples in multiple programming languages

1const response = await fetch('https://api.carwiseiq.com/api/predict', {
2  method: 'POST',
3  headers: {
4    'Content-Type': 'application/json',
5  },
6  body: JSON.stringify({
7    features: {
8      year: 2020,
9      mileage: 30000,
10      engine_size: 2.5,
11      cylinders: 4,
12      make: 'Toyota',
13      model: 'Camry',
14      condition: 'Good',
15      fuel_type: 'Gasoline',
16      location: 'California',
17    },
18  }),
19});
20 
21const data = await response.json();
22console.log('Predicted price:', data.predicted_price);

1import requests
2 
3response = requests.post(
4    'https://api.carwiseiq.com/api/predict',
5    json={
6        'features': {
7            'year': 2020,
8            'mileage': 30000,
9            'engine_size': 2.5,
10            'cylinders': 4,
11            'make': 'Toyota',
12            'model': 'Camry',
13            'condition': 'Good',
14            'fuel_type': 'Gasoline',
15            'location': 'California',
16        }
17    }
18)
19 
20data = response.json()
21print(f"Predicted price: {data['predicted_price']}")

1curl -X POST "https://api.carwiseiq.com/api/predict" \
2  -H "Content-Type: application/json" \
3  -d '{
4    "features": {
5      "year": 2020,
6      "mileage": 30000,
7      "engine_size": 2.5,
8      "cylinders": 4,
9      "make": "Toyota",
10      "model": "Camry",
11      "condition": "Good",
12      "fuel_type": "Gasoline",
13      "location": "California"
14    }
15  }'

1package main
2 
3import (
4    "bytes"
5    "encoding/json"
6    "fmt"
7    "net/http"
8)
9 
10func main() {
11    url := "https://api.carwiseiq.com/api/predict"
12 
13    data := map[string]interface{}{
14        "features": map[string]interface{}{
15            "year": 2020,
16            "mileage": 30000,
17            "engine_size": 2.5,
18            "cylinders": 4,
19            "make": "Toyota",
20            "model": "Camry",
21            "condition": "Good",
22            "fuel_type": "Gasoline",
23            "location": "California",
24        },
25    }
26 
27    jsonData, _ := json.Marshal(data)
28    req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
29    req.Header.Set("Content-Type", "application/json")
30 
31    client := &http.Client{}
32    resp, _ := client.Do(req)
33    defer resp.Body.Close()
34 
35    var result map[string]interface{}
36    json.NewDecoder(resp.Body).Decode(&result)
37    fmt.Println("Predicted price:", result["predicted_price"])
38}

1require 'net/http'
2require 'json'
3 
4uri = URI('https://api.carwiseiq.com/api/predict')
5http = Net::HTTP.new(uri.host, uri.port)
6 
7request = Net::HTTP::Post.new(uri.path)
8request['Content-Type'] = 'application/json'
9request.body = {
10  features: {
11    year: 2020,
12    mileage: 30000,
13    engine_size: 2.5,
14    cylinders: 4,
15    make: 'Toyota',
16    model: 'Camry',
17    condition: 'Good',
18    fuel_type: 'Gasoline',
19    location: 'California'
20  }
21}.to_json
22 
23response = http.request(request)
24data = JSON.parse(response.body)
25puts "Predicted price: #{data['predicted_price']}"

HTTP Response Codes

Standard HTTP status codes returned by the API

Code	Name	Description
200	OK	Request succeeded
201	Created	Resource created successfully
400	Bad Request	Invalid request parameters
401	Unauthorized	Authentication required
403	Forbidden	Access denied
404	Not Found	Resource not found
422	Unprocessable Entity	Validation error
500	Internal Server Error	Server error occurred
503	Service Unavailable	Service temporarily unavailable