API Documentation
Complete guide to Vehicle Safety API
API Testing
Required to test API endpoints
Getting Started
Get up and running with the Vehicle Safety API in minutes
1
Sign Up
Create your developer account
2
Get API Key
Generate your API key from dashboard
3
Make Requests
Start calling our APIs
Quick Example
curl -X GET "https://ridesafety.app/api/v1/recalls?vin=1HGBH41JXMN109186" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json"
Authentication
Secure your API requests with proper authentication
API Key Authentication
All API requests must include your API key in the Authorization header using Bearer token format.
Header Format
Authorization: Bearer YOUR_API_KEY
JavaScript Example
const response = await fetch('https://ridesafety.app/api/v1/recalls', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
}
});API Endpoints
Complete reference for all available endpoints with live testing
GET
/api/v1/recallsRetrieve recall information for vehicles using VIN, make, model, or year parameters.
Try this API
Query Parameters
Parameter
Type
Description
vinstringVehicle Identification Number (17 characters)makestringVehicle manufacturer (e.g., Honda, Toyota)modelstringVehicle model (e.g., Civic, Camry)yearintegerModel year (e.g., 2021)Example Request
curl -X GET "https://ridesafety.app/api/v1/recalls?make=Honda&model=Civic&year=2021" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"vehicle": {
"make": "Honda",
"model": "Civic",
"year": 2021
},
"recalls": [
{
"id": "NHTSA-2023-001",
"title": "Airbag Inflator Recall",
"description": "Takata airbag inflators may rupture",
"severity": "High",
"date_issued": "2023-03-15",
"status": "Open"
}
],
"total_recalls": 1
}Rate Limits
Understanding API rate limits and best practices
Rate Limit Headers
All API responses include rate limit headers to help you track your usage.
Response Headers
X-RateLimit-LimitRequest limit per windowX-RateLimit-RemainingRequests remainingX-RateLimit-ResetWindow reset timePlan Limits
Free1,000/day
Basic10,000/day
Pro100,000/day
Enterprise1M+/day
Error Handling
Understanding API error responses and status codes
HTTP Status Codes
200
Success400
Bad Request401
Unauthorized429
Rate Limited500
Server ErrorError Response Format
{
"error": {
"code": "INVALID_VIN",
"message": "The provided VIN is invalid",
"details": "VIN must be 17 characters"
}
}SDKs & Libraries
Official SDKs and community libraries for popular languages
JS
JavaScript/Node.js
Official SDK for JavaScript and Node.js
npm install @vehiclesafety/sdk
PY
Python
Official Python SDK
pip install vehiclesafety
RB
Ruby
Official Ruby gem
gem install vehiclesafety