Introduction
Welcome to the Cardog API documentation. Our API provides comprehensive access to vehicle data, market insights, and automotive services. Whether you're building a dealership platform, market analysis tool, or automotive application, Cardog API offers the data and functionality you need.
Getting Started
To start using the Cardog API:
- Create an account at cardog.app
- Create an API key in the API Keys section
- Use the API key in your requests:
curl "https://api.cardog.io/v1/vin/12345678901234567" \ -H "x-api-key: your-api-key"
API Principles
Our API is designed with these principles in mind:
- RESTful Design: Consistent resource-oriented URLs, proper HTTP methods, and standard status codes
- Comprehensive Data: Deep vehicle information from trusted sources
- Real-time Updates: Current market data and pricing information
Authentication
All API requests require authentication using an API key. Include your key in the Authorization header:
Request
curl "https://api.cardog.io/v1/vin/12345678901234567" \
-H "x-api-key: your-api-key"
Error Handling
The API uses conventional HTTP response codes:
200
: Success400
: Client errors (invalid requests)401
: Unauthorized403
: Forbidden404
: Not Found429
: Too Many Requests500
: Server errors
Error responses include detailed information:
{
"error": {
"code": "invalid_vin",
"message": "The provided VIN is invalid",
"details": {
"field": "vin",
"reason": "checksum_mismatch"
}
}
}
Guides
Vehicle Identification Numbers
Learn how to use Vehicle Identification Numbers (VINs) with the Cardog API.
Troubleshooting
If you're having trouble with the API, check out our API Status page. If you need further help, please contact us at support@cardog.ai.
Next Steps
- Follow our Quick Start Guide to make your first API call
- Learn about VIN decoding and vehicle identification
- Explore our API reference for detailed endpoint documentation
- Check out example applications built with Cardog API