Quickstart

This guide will get you all set up and ready to use the CarsXE API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.

Choose your client

Before making your first API request, you need to pick which API client you will use. In addition to good ol' cURL HTTP requests, you can make an HTTP request using almost any programming language.

# cURL is most likely already installed on your machine
curl --version

Making your first API request

After picking your preferred client, you are ready to make your first call to the CarsXE API. Below, you can see how to send a GET request to the Specifications endpoint to get a list of a vehicle's specification from a VIN. This is also known as VIN decoding.

# cURL is most likely already installed on your machine
curl --version

curl -G https://api.carsxe.com/specs \
    -d key=CARSXE_API_KEY \
    -d vin=WBAFR7C57CC811956

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the CarsXE API:

• Grab your API key from the CarsXE dashboard
• Check out the Specifications endpoint
• Learn about the different error messages in CarsXE