Developer-friendly & type-safe Python SDK specifically catered to leverage openapi API.
Note
Python version upgrade policy
Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
The SDK can be installed with either pip or poetry package managers.
PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
pip install censys-platformPoetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.
poetry add censys-platformYou can use this SDK in a Python shell with uv and the uvx command that comes with it like so:
uvx --from censys-platform pythonIt's also possible to write a standalone Python script without needing to set up a whole project like so:
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
# "censys-platform",
# ]
# ///
from censys_platform import SDK
sdk = SDK(
# SDK arguments
)
# Rest of script here...Once that is saved to a file, you can run it with uv run script.py where
script.py can be replaced with the actual file name.
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
# Synchronous Example
from censys_platform import SDK
with SDK(
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
res = sdk.global_data.search(search_query_input_body={
"query": "<value>",
}, organization_id="<id>")
# Handle response
print(res)The same SDK client can also be used to make asychronous requests by importing asyncio.
# Asynchronous Example
import asyncio
from censys_platform import SDK
async def main():
async with SDK(
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
res = await sdk.global_data.search_async(search_query_input_body={
"query": "<value>",
}, organization_id="<id>")
# Handle response
print(res)
asyncio.run(main())Available methods
- list - List Collections
- create - Create a Collection
- delete - Delete a Collection
- get - Get a Collection
- update - Update a Collection
- list_events - List a Collection's events
- aggregate - Search / Aggregate
- search - Search / Query
- get_certificates - Asset / Certificate Bulk
- get_certificate - Asset / Certificate
- get_hosts - Asset / Host Bulk
- get_host - Asset / Host
- get_host_timeline - Asset / Host Timeline
- get_web_properties - Asset / WebProperty Bulk
- get_web_property - Asset / WebProperty
- aggregate - Search / Aggregate
- search - Search / Query
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set organization_id to "<id>" at SDK initialization and then you do not have to pass the same value on calls to operations like list. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
The following global parameter is available.
| Name | Type | Description |
|---|---|---|
| organization_id | str | The organization_id parameter. |
from censys_platform import SDK
with SDK(
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
res = sdk.collections.list(organization_id="<id>")
# Handle response
print(res)Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:
from censys_platform import SDK
from censys_platform.utils import BackoffStrategy, RetryConfig
with SDK(
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
res = sdk.collections.list(organization_id="<id>",
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
# Handle response
print(res)If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:
from censys_platform import SDK
from censys_platform.utils import BackoffStrategy, RetryConfig
with SDK(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
res = sdk.collections.list(organization_id="<id>")
# Handle response
print(res)Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
By default, an API error will raise a models.SDKError exception, which has the following properties:
| Property | Type | Description |
|---|---|---|
.status_code |
int | The HTTP status code |
.message |
str | The error message |
.raw_response |
httpx.Response | The raw HTTP response |
.body |
str | The response content |
When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the list_async method may raise the following exceptions:
| Error Type | Status Code | Content Type |
|---|---|---|
| models.ErrorModel | 401, 403 | application/problem+json |
| models.SDKError | 4XX, 5XX | */* |
from censys_platform import SDK, models
with SDK(
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
res = None
try:
res = sdk.collections.list(organization_id="<id>")
# Handle response
print(res)
except models.ErrorModel as e:
# handle e.data: models.ErrorModelData
raise(e)
except models.SDKError as e:
# handle exception
raise(e)The default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
from censys_platform import SDK
with SDK(
server_url="https://api.platform.censys.io",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
res = sdk.collections.list(organization_id="<id>")
# Handle response
print(res)The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.
For example, you could specify a header for every request that this sdk makes as follows:
from censys_platform import SDK
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = SDK(client=http_client)or you could wrap the client with your own custom logic:
from censys_platform import SDK
from censys_platform.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = SDK(async_client=CustomClient(httpx.AsyncClient()))This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
personal_access_token |
http | HTTP Bearer |
To authenticate with the API the personal_access_token parameter must be set when initializing the SDK client instance. For example:
from censys_platform import SDK
with SDK(
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
res = sdk.collections.list(organization_id="<id>")
# Handle response
print(res)The SDK class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.
from censys_platform import SDK
def main():
with SDK(
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
# Rest of application here...
# Or when using async:
async def amain():
async with SDK(
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
# Rest of application here...You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass your own logger class directly into your SDK.
from censys_platform import SDK
import logging
logging.basicConfig(level=logging.DEBUG)
s = SDK(debug_logger=logging.getLogger("censys_platform"))This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.