Skip to content

Get user quota information

GET
/api/quota

Retrieve current quota information including current usage and maximum allowed quota for the authenticated user.

Quota information retrieved successfully

object
success

Request status

boolean
Example
true
data
object
current_quota

Current available quota (aggregate + update)

integer
Example
850
max_quota

Maximum allowed quota (aggregate limit)

integer
Example
1000
usage_percentage

Percentage of quota used ((max - current) / max * 100)

number format: float
Example
15

Unauthorized - Invalid or missing API credentials

object
success

Public API Controller for Quota Management

Handles public-facing quota-related API requests.

boolean
message
string
Example
Unauthorized - User not authenticated

User not found or has no quota configured

object
success
boolean
message
string
Example
User quota not found

Too many requests - Rate limit exceeded

object
success
boolean
message
string
Example
Too many requests
Retry-After
integer

Seconds until rate limit resets

X-RateLimit-Limit
integer

Maximum requests per minute

X-RateLimit-Remaining
integer

Remaining requests in current window

Internal server error

object
success
boolean
message
string
Example
Internal server error