This API provides access to a database of Electric Vehicle (EV) specifications. It allows you to search for EV models, retrieve detailed specifications for a specific vehicle, and get a list of all available EV brands.

API Endpoints

1. Search EV Models

This endpoint allows you to search for EV models using a keyword. You can refine the search with an optional brand filter and control the output with pagination.

• Functionality: Search for EV models.
• Method: GET
• Endpoint: /ev-spec/v1/search

Query Parameters

Responses

A successful response returns a paginated list of EV models matching the search criteria.

Successful Response (Code 200)

{
  "code": "200",
  "msg": "Success",
  "data": {
    "total_results": 1,
    "page": 1,
    "limit": 10,
    "results": [
      {
        "id": "nio-es7-2022",
        "fullmodelname": "Nio ES7",
        "brand_name": "Nio",
        "main_image": "https://www.nio.com/es7.jpg",
        "quick_summary": "A premium electric SUV from Nio."
      }
    ]
  }
}

An error response will be returned for invalid requests or server issues.

2. Get EV Model Details

Retrieve a complete set of specifications for a single EV model using its unique ID.

• Functionality: Get detailed specifications for one EV model.
• Method: GET
• Endpoint: /ev-spec/v1/detail

Query Parameters

Responses

A successful response returns a detailed JSON object with all specifications for the requested EV.

Successful Response (Code 200)

{
  "code": "200",
  "msg": "Success",
  "data": {
    "id": "tesla-model-y-lr-awd-2024",
    "fullmodelname": "Tesla Model Y Long Range AWD",
    "brand_name": "Tesla",
    "comment": "One of the best-selling electric SUVs globally...",
    "specs": [
      {
        "category": "Performance",
        "name": "0-60 mph",
        "value": "4.8 seconds"
      },
      {
        "category": "Battery & Charging",
        "name": "Usable Battery Capacity",
        "value": "81.0 kWh (estimated)"
      }
    ]
  }
}

An error response indicates that the request failed.

3. List All EV Brands

Retrieve a complete list of all unique EV brand names available in the database.

• Functionality: Get a list of all EV brands.
• Method: GET
• Endpoint: /ev-spec/v1/brands

Query Parameters

Responses

A successful response returns a JSON object containing an array of brand names.

Successful Response (Code 200)

{
  "code": "200",
  "msg": "Success",
  "data": {
    "brands": [
      "Audi",
      "BMW",
      "BYD",
      "Ford",
      "Hyundai",
      "Kia",
      "Nio",
      "Tesla"
    ]
  }
}

An error response indicates that the request failed.

Usage Notes

1. An apikey is required for all endpoints. Ensure it is included in every request.
2. A common workflow is to first use the /search or /brands endpoint to find an EV and its id, and then use that id with the /detail endpoint to fetch its full specifications.
3. When using the /search endpoint, the keyword parameter is required.