View API


The View API exposes a single endpoint, /api/v1/view, which can be used to fetch full document once its ID is known (e.g., IP address or domain). This endpoint is frequently used in conjunction with the Search API Endpoint, which allows you to find the IDs of hosts, websites, and certificates that match a query.

View Document


Description

The view endpoint returns the current structured data we have on a specific host, website, or certificate.

Endpoint
GET /api/v1/view/:index/:id
URL Parameters
  • index [required string]
    The search index the document is in. Must be one of ipv4, websites, or certificates.
  • id [required string]
    The ID of the document you are requesting. In the IPv4 index, this is IP address (e.g., 192.168.1.1), domain in the websites index (e.g., google.com) and SHA-256 fingerprint in the certificates index (e.g., 9d3b51a6b80daf76e074730f19dc01e643ca0c3127d8f48be64cf3302f6622cc).
Example: /api/v1/view/websites/google.com
Data Parameters
(none)
Success Response
200 SUCCESS
The record was successfully retrieved.
Example:
{
  "validation_timestamp": "2015-10-07T01:18:48+00:00",
  "updated_at": "2015-10-06T20:18:50",
  "raw": "MIIDQ...G9rw=",
  "validation.nss.valid": false,
  "parsed": {
    "fingerprint_sha1": "3704a663ed5db89f85c5377852d678b299389775",
    "subject_dn": "CN=ns1.google.com, emailAddress=ssl@ns1.google.com",
    "issuer": {
      "common_name": [
        "ns1.google.com"
      ]
    },
    "signature": {
      "self_signed": true,
      "valid": false,
      "value": "Leve...dvA==",
      "signature_algorithm": {
        "oid": "1.2.840.113549.1.1.11",
        "name": "SHA256WithRSA"
      }
    },
    "validity": {
      "start": "2015-09-10T06:49:19Z",
      "end": "2016-09-09T06:49:19Z"
    },
    "issuer_dn": "CN=ns1.google.com, emailAddress=ssl@ns1.google.com",
    "fingerprint_sha256": "fce621c0dc1c666d03d660472f636ce91e66e96460545f0da7eb1a24873e2f70",
    "version": 3,
    "extensions": {
      "authority_key_id": "dc3e2e3f49b126782f2dd4444c3cb5970be85979",
      "basic_constraints": {
        "is_ca": false
      },
      "subject_key_id": "3D4uP0mxJngvLdRETDy1lwvoWXk=",
      "certificate_policies": [

      ]
    },
    "signature_algorithm": {
      "oid": "1.2.840.113549.1.1.11",
      "name": "SHA256WithRSA"
    },
    "serial_number": "1952809538",
    "fingerprint_md5": "37ec912bf30802fd4ab3592f8713ef6f",
    "subject_key_info": {
      "key_algorithm": {
        "oid": "",
        "name": "RSA"
      },
      "rsa_public_key": {
        "length": 2048,
        "modulus": "vYjm5...PfLw==",
        "exponent": 65537
      }
    },
    "subject": {
      "common_name": [
        "ns1.google.com"
      ]
    }
  },
}
Error Responses
  • 404 NOT FOUND
    The requested record does not exist.
    Example:
    {"error_code":404, "error":"page not found"}
  • 429 RATE LIMIT EXCEEDED
    The requested record was not retrieved because you have exceeded your specified rate limit.
    Example:
    {"error_code":429, "error":"rate limit exceeded"}
  • 500 INTERNAL SERVER ERROR
    An unexpected error occurred when trying to execute your query. Try again at a later time or contact us at requests@censys.io if the problem persists.
    Example:
    {"error_code":500, "error":"unknown error occurred"}