CheapVHR LogoCheapVHR

User Endpoints

Manage user information, view reports, and check usage limits.

GET/user
Retrieve authenticated user information

Authentication

x-api-key header required

Code Examples

bash
curl -X GET \
  https://api.cheapvhr.com/v1/user \
  -H "x-api-key: YOUR_API_KEY"

Example Response

JSON
{
  "id": "user-id",
  "email": "your@email.com",
  "name": "John Doe",
  "createdAt": "2025-06-08T13:44:31.881Z",
  "updatedAt": "2025-06-08T13:44:31.881Z"
}
GET/user/reports
List reports belonging to the authenticated user

Authentication

x-api-key header required

Code Examples

bash
curl -X GET \
  https://api.cheapvhr.com/v1/user/reports \
  -H "x-api-key: YOUR_API_KEY"

Example Response

JSON
{
  "carfaxReports": [
    {
      "id": "1",
      "VIN": "1G1PG5SC3C7167133",
      "yearMakeModel": "2012 CHEVROLET CRUZE LT",
      "createdAt": "2025-06-10T08:06:31.402Z",
      "updatedAt": "2025-06-10T08:06:31.402Z"
    },
    {
      "id": "2",
      "VIN": "1FMDU34X7PUD75574",
      "yearMakeModel": "1993 FORD EXPLORER XLT",
      "createdAt": "2025-06-10T08:09:55.155Z",
      "updatedAt": "2025-06-10T08:09:55.155Z"
    }
  ],
  "autoCheckReports": [
    {
      "id": "1",
      "VIN": "1FMDU34X7PUD75574",
      "yearMakeModel": "1993 FORD EXPLORER XLT",
      "createdAt": "2025-06-10T08:58:06.185Z",
      "updatedAt": "2025-06-10T08:58:06.185Z"
    },
    {
      "id": "2",
      "VIN": "1FMDU34X7PUD75574",
      "yearMakeModel": "1993 FORD EXPLORER XLT",
      "createdAt": "2025-06-10T09:23:18.474Z",
      "updatedAt": "2025-06-10T09:23:18.474Z"
    }
  ]
}
GET/user/limits
Get usage limits and current consumption

Authentication

x-api-key header required

Code Examples

bash
curl -X GET \
  https://api.cheapvhr.com/v1/user/limits \
  -H "x-api-key: YOUR_API_KEY"

Example Response

JSON
{
  "dailyLimit": 20,
  "carfaxReportsLeftToday": 20,
  "autocheckReportsLeftToday": 20,
  "credits": 48
}