Get User Limits Information

GET /api/user/limits

Retrieve the current usage limits and remaining quota for the authenticated user. This endpoint provides real-time information about daily request limits, remaining reports for the day, and available credits.

Use this endpoint to check quota availability before making report requests.

Path Parameters

None.

Query Parameters

None.

Headers

Key	Value
x-api-key	Your API Key

Response

Status Code: 200 OK

Response Fields

Field	Type	Description
daily_limit	number	Maximum number of API requests allowed per day
carfax_reports_left_today	number	Remaining Carfax report requests available today
autocheck_reports_left_today	number	Remaining Autocheck report requests available today
credits	number	Total credits available in your account balance

INFO

Daily limits reset at midnight UTC. Credits are consumed when requesting full HTML reports.

Example Response

{
  "daily_limit": 20,
  "carfax_reports_left_today": 15,
  "autocheck_reports_left_today": 19,
  "credits": 5
}

Error Responses

401 Unauthorized

Returned when the API key is missing or invalid.

{
  "message": "Unauthorized"
}

Examples

Python

import requests
response = requests.get('https://panel.cheapcarfax.net/api/user/limits', headers={'x-api-key': 'YOUR_API_KEY'})
print(response.json())

cURL

curl -X GET 'https://panel.cheapcarfax.net/api/user/limits' \
-H 'x-api-key: YOUR_API_KEY'