Base URL
All API requests should be made to:Authentication
Most endpoints require authentication using Bearer tokens. See the Authentication guide for details.Response Format
All API responses follow a consistent JSON structure:Success Response
Error Response
Endpoint Categories
Health Check
Monitor API and service health
Cars Data
Access vehicle registration statistics
COE Data
Get Certificate of Entitlement results
Workflows
Manage data update workflows
Rate Limits
Authentication | Rate Limit | Window |
---|---|---|
Authenticated | 100 requests | 1 minute |
Unauthenticated | 10 requests | 1 minute |
Common Query Parameters
Pagination
Parameter | Type | Description | Default |
---|---|---|---|
page | integer | Page number (1-based) | 1 |
limit | integer | Results per page (max 100) | 50 |
Filtering
Parameter | Type | Description | Example |
---|---|---|---|
month | string | Filter by month (YYYY-MM) | 2024-01 |
make | string | Filter by car manufacturer | Toyota |
fuel_type | string | Filter by fuel type | Electric |
vehicle_type | string | Filter by vehicle type | Passenger Cars |
Date Range
Parameter | Type | Description | Example |
---|---|---|---|
from | string | Start date (YYYY-MM) | 2024-01 |
to | string | End date (YYYY-MM) | 2024-12 |
HTTP Status Codes
Code | Status | Description |
---|---|---|
200 | OK | Request successful |
400 | Bad Request | Invalid request parameters |
401 | Unauthorized | Authentication required or invalid |
404 | Not Found | Resource not found |
429 | Too Many Requests | Rate limit exceeded |
500 | Internal Server Error | Server error |
Data Types
Car Registration Data
COE Bidding Data
COE PQP Data
OpenAPI Specification
The complete OpenAPI specification is available at:SDKs and Libraries
Currently, the API is accessed via standard HTTP requests. We recommend using your preferred HTTP client library:- JavaScript:
fetch()
,axios
- Python:
requests
,httpx
- PHP:
cURL
,Guzzle
- Java:
OkHttp
,HttpClient
- Go:
net/http