Account API

The Account API is a single endpoint, /api/v1/account, which fetches information about your Censys account. Most importantly, you can use this endpoint to check on your current query quota usage.

Account

Description

The account endpoint returns information about your Censys account.

Endpoint

GET /api/v1/account

URL Parameters

(none)

Data Parameters

(none)

Success Response

200 SUCCESS

Example:

{
  "login": "john_doe",
  "email": "john@example.com",
  "api_id": "CENSYS_API_ID",
  "api_secret": "CENSYS_API_SECRET",
  "first_login": "2018-01-22 15:04:05",
  "last_login": "2018-02-15 16:17:18",
  "quota": {
    "used": 10,
    "resets_at": "2018-02-22 15:05:04",
    "allowance": 250
  }
}

Error Responses

• 403 FORBIDDEN
  Your request did not include a valid Authorization header.
  Example:

  {
    "status": "error",
    "error_type": "unathorized",
    "error": "Unauthorized. You must authenticate with a valid API ID and secret."
  }

• 429 RATE LIMIT EXCEEDED
  You have exceeded the rate limit for API requests. Back off and try again later.
• 500 INTERNAL SERVER ERROR
  An unexpected error occurred when trying to execute your query. Try again later or contact us at support@censys.io if the problem persists.
  Example:

  {
    "error_code": 500,
    "error": "unknown error occurred"
  }