Guides
Start typing to search…

Get Started

About the Censys Platform API

The Censys Platform API provides programmatic access to the data available in the Censys Platform. Our API is organized around RESTful principles and follows a predictable, resource-oriented URL structure, supports application/JSON request bodies, returns JSON-encoded responses, and adheres to standard HTTP methods, authentication, and response codes.

API access is governed by our Terms of Service and all scripted access should use this API. Your API rate limits are shown on the Censys Platform Personal Access Tokens page.

Base URL

Global Data

The base URL for the Global Data endpoints:

https://api.platform.censys.io/v3/global/

Get a Personal Access Token (PAT)

The Censys Platform API uses Personal Access Tokens to authenticate requests. Users can generate multiple PATs as needed. The API is available for Starter and Enterprise tiers, but not for Free tier users.

  1. Go to My Account > Personal Access Tokens tab.

  2. Click Create New Token.

  3. Name your PAT in the Token Name field (Required) and add a description (Optional).

  4. Click Create.

  5. A confirmation dialog appears when the token is successfully created. Click Copy to clipboard and store your token in a secure location for future use. The token value is found at the bottom of the dialog.

🚧

Your API keys grant significant access, so keep them secure. Never expose API keys in public areas like GitHub or client-side code.

Set your Organization ID

The Censys Platform API identifies the entitlements and billing details for your request based on the provided Organization ID. Your Organization ID can be found in the URL:

The Organization ID can be set via query parameter or header. If values are provided for both, the query parameter takes precedence. An Organization ID must be provided for each request to the API.

Header

X-Organization-ID: c486f89f-8e4d-4c7a-830d-8d1d5b822c20

Query Parameter

?org=c486f89f-8e4d-4c7a-830d-8d1d5b822c20

Make API Calls

After you create a PAT, you can start making API calls using cURL or Postman.

The Censys Platform API typically follows standard HTTP response codes to indicate whether a request was successful or failed.

API Rate Limits

Rate limits are associated with your account tier.

Free tier

No API access.

Starter tier

1 concurrent action

Enterprise tier

10 concurrent actions