Skip to main content

Car Models is a simple tool for getting information on cars. It returns information on various car models including makes, models, trims, and specifications.

Project description

Car Models API

Car Models is a simple tool for getting information on cars. It returns information on various car models including makes, models, trims, and specifications.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Car Models API


Installation

Using pip:

pip install apiverve-carmodels

Using pip3:

pip3 install apiverve-carmodels

Configuration

Before using the carmodels API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_carmodels.apiClient import CarmodelsAPIClient

# Initialize the client with your APIVerve API key
api = CarmodelsAPIClient("[YOUR_API_KEY]")

query = {
    "make": "Toyota",
    "year": 2024
}

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Car Models API documentation is found here: https://docs.apiverve.com/ref/carmodels. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_carmodels.apiClient import CarmodelsAPIClient

# Initialize the client with your APIVerve API key
api = CarmodelsAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = {
    "make": "Toyota",
    "year": 2024
}
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "count": 4,
    "filteredOn": [
      "year",
      "make",
      "model"
    ],
    "cars": [
      {
        "Make": "Acura",
        "CityMPG": "30",
        "CityELEC": "0",
        "CombMPG": "33",
        "CombELEC": "0",
        "Cyl": "4",
        "Displace": "1.5",
        "Drive": "Front-Wheel Drive",
        "Fuel": "Premium",
        "HighwELEC": "0",
        "HighwMPG": "37",
        "Trans": "Automatic (AV-S7)",
        "Size": "Large Cars",
        "Year": "2024",
        "Trim": "Integra",
        "Model": "Integra"
      },
      {
        "Make": "Acura",
        "CityMPG": "21",
        "CityELEC": "0",
        "CombMPG": "24",
        "CombELEC": "0",
        "Cyl": "4",
        "Displace": "2",
        "Drive": "Front-Wheel Drive",
        "Fuel": "Premium",
        "HighwELEC": "0",
        "HighwMPG": "28",
        "Trans": "Manual 6-spd",
        "Size": "Large Cars",
        "Year": "2024",
        "Trim": "Integra",
        "Model": "Integra"
      },
      {
        "Make": "Acura",
        "CityMPG": "26",
        "CityELEC": "0",
        "CombMPG": "30",
        "CombELEC": "0",
        "Cyl": "4",
        "Displace": "1.5",
        "Drive": "Front-Wheel Drive",
        "Fuel": "Premium",
        "HighwELEC": "0",
        "HighwMPG": "36",
        "Trans": "Manual 6-spd",
        "Size": "Large Cars",
        "Year": "2024",
        "Trim": "Integra A-Spec",
        "Model": "Integra"
      },
      {
        "Make": "Acura",
        "CityMPG": "29",
        "CityELEC": "0",
        "CombMPG": "32",
        "CombELEC": "0",
        "Cyl": "4",
        "Displace": "1.5",
        "Drive": "Front-Wheel Drive",
        "Fuel": "Premium",
        "HighwELEC": "0",
        "HighwMPG": "36",
        "Trans": "Automatic (AV-S7)",
        "Size": "Large Cars",
        "Year": "2024",
        "Trim": "Integra A-Spec",
        "Model": "Integra"
      }
    ]
  }
}

Error Handling

The API client provides comprehensive error handling through the CarmodelsAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_carmodels.apiClient import CarmodelsAPIClient, CarmodelsAPIClientError

api = CarmodelsAPIClient("[YOUR_API_KEY]")

query = {
    "make": "Toyota",
    "year": 2024
}

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except CarmodelsAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_carmodels.apiClient import CarmodelsAPIClient, CarmodelsAPIClientError

api = CarmodelsAPIClient("[YOUR_API_KEY]")

query = {
    "make": "Toyota",
    "year": 2024
}

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except CarmodelsAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_carmodels.apiClient import CarmodelsAPIClient, CarmodelsAPIClientError

query = {
    "make": "Toyota",
    "year": 2024
}

# Using context manager ensures proper cleanup
with CarmodelsAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except CarmodelsAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_carmodels.apiClient import CarmodelsAPIClient

# Enable debug mode
api = CarmodelsAPIClient("[YOUR_API_KEY]", debug=True)

query = {
    "make": "Toyota",
    "year": 2024
}

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_carmodels.apiClient import CarmodelsAPIClient

api = CarmodelsAPIClient("[YOUR_API_KEY]")

query = {
    "make": "Toyota",
    "year": 2024
}

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_carmodels-1.1.14.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_carmodels-1.1.14-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_carmodels-1.1.14.tar.gz.

File metadata

  • Download URL: apiverve_carmodels-1.1.14.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for apiverve_carmodels-1.1.14.tar.gz
Algorithm Hash digest
SHA256 41e0ed3fba43389ab5ee0e248ceea7f91938875df0c20cdcf7d6c475beaf5da4
MD5 9cc07df429d64e6d4dfda13c375532be
BLAKE2b-256 1535afe8e429794e73bbeb96631609bb5bda30d5b896e76c9070ddf935fabad3

See more details on using hashes here.

File details

Details for the file apiverve_carmodels-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_carmodels-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 9866ffa99eaf2e0c25605d8bf172e68636a06a9afdf86daf61a964356d0077bc
MD5 02354bd547610ad2e9d174ffaeac69b0
BLAKE2b-256 9ee11f196a682a90a47eb47d25e9cf165cb28bbaa03df0733203339c7b184e7a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page