Skip to main content

User Quota API

This endpoint returns the authenticated user's remaining data-collection quota. The quota decreases according to the amount of data successfully collected through scraping.

Get user quota

GET /api/user-quota

Authentication: Bearer token

Authorization: Bearer <access_token>

Parameters: None

Success response — 200 OK:

{
"id": "user_id",
"kuota": 1000
}
FieldTypeDescription
idstringAuthenticated user ID
kuotaintegerRemaining data-collection quota

The wire field is named kuota; clients must preserve that spelling.

Other responses:

StatusMeaning
401Unauthorized
404User quota not found
500Internal server error
curl \
"$SOCIOVITE_API_URL/api/user-quota" \
-H 'accept: application/json' \
-H 'Authorization: Bearer <access_token>'

Error shape

{
"success": false,
"error": "Quota not found",
"message": "No quota record exists for this user"
}