Pricing Documentation Sign up Log in

API Reference

Status Endpoint

The status endpoint returns your account details, plan information, and current API usage for the billing period.

Endpoint

GET /status

Request Example

curl -X GET "https://api.usercheck.com/status" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Success Response (200)

{
  "status": "success",
  "account": {
    "plan": {
      "name": "Pro 200K",
      "requests": 200000,
      "rate_limit": 15
    },
    "user": {
      "name": "Jane Doe",
      "email": "[email protected]"
    }
  },
  "usage": {
    "limit": 200000,
    "current": 48320,
    "remaining": 151680,
    "reset_at": "2026-04-01T00:00:00.000000Z"
  }
}

Response Fields

Field Type Description
status string Status of the request. Returns "success" on a successful request.
account.plan.name string The name of your current plan (e.g., "Pro 1.5M").
account.plan.requests integer Total number of API requests included in your plan per billing period.
account.plan.rate_limit integer Maximum number of requests per second allowed by your plan.
account.user.name string The name of the account holder.
account.user.email string The email address of the account holder.
usage.limit integer Total usage limit for the current billing period.
usage.current integer Number of API requests used so far in the current billing period.
usage.remaining integer Number of API requests remaining in the current billing period.
usage.reset_at string ISO 8601 timestamp indicating when the usage counter resets for the next billing period.

Error Responses

Unauthorized (401)

{
  "status": 401,
  "error": "Unauthorized"
}

Rate Limit Exceeded (429)

{
  "status": 429,
  "error": "Too many requests"
}
Previous
Blocklist Endpoint