Skip to content
BranchesTags

Repository files navigation

censys-sdk-python

Developer-friendly & type-safe Python SDK specifically catered to leverage openapi API.

Summary

Table of Contents

SDK Installation

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 uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add censys-platform

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install censys-platform

Poetry

Poetry 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-platform

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from censys-platform python

It'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.10"# dependencies = [# "censys-platform",# ]# ///fromcensys_platformimportSDKsdk=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.

IDE Support

PyCharm

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.

SDK Example Usage

Example

# Synchronous Examplefromcensys_platformimportSDKwithSDK(
organization_id="11111111-2222-3333-4444-555555555555",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) assdk:
res=sdk.global_data.search(search_query_input_body={
"fields": [
"host.ip",
],
"page_size": 1,
"query": "host.services: (protocol=SSH and not port: 22)",
})
# Handle responseprint(res)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Exampleimportasynciofromcensys_platformimportSDKasyncdefmain():
asyncwithSDK(
organization_id="11111111-2222-3333-4444-555555555555",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) assdk:
res=awaitsdk.global_data.search_async(search_query_input_body={
"fields": [
"host.ip",
],
"page_size": 1,
"query": "host.services: (protocol=SSH and not port: 22)",
})
# Handle responseprint(res)
asyncio.run(main())

Available Resources and Operations

Available methods

AccountManagement

AdversaryInvestigation

Collections

  • list - List collections
  • create - Create a collection
  • delete - Delete a collection
  • get - Get a collection
  • update - Update a collection
  • list_events - Get a collection's events
  • aggregate - Aggregate results for a search query within a collection
  • search - Run a search query within a collection

GlobalData

TagsAndComments

ThreatHunting

Global Parameters

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 `` at SDK initialization and then you do not have to pass the same value on calls to operations like get_organization_details. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

Available Globals

The following global parameter is available.

NameTypeDescription
organization_idstrThe organization_id parameter.

Example

fromcensys_platformimportSDKwithSDK(
organization_id="11111111-2222-3333-4444-555555555555",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) assdk:
res=sdk.account_management.get_organization_details(organization_id="11111111-2222-3333-4444-555555555555", include_member_counts=False)
# Handle responseprint(res)

Retries

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:

fromcensys_platformimportSDKfromcensys_platform.utilsimportBackoffStrategy, RetryConfigwithSDK(
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) assdk:
res=sdk.account_management.get_organization_details(organization_id="11111111-2222-3333-4444-555555555555", include_member_counts=False,
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
# Handle responseprint(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:

fromcensys_platformimportSDKfromcensys_platform.utilsimportBackoffStrategy, RetryConfigwithSDK(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) assdk:
res=sdk.account_management.get_organization_details(organization_id="11111111-2222-3333-4444-555555555555", include_member_counts=False)
# Handle responseprint(res)

Error Handling

SDKBaseError is the base class for all HTTP error responses. It has the following properties:

PropertyTypeDescription
err.messagestrError message
err.status_codeintHTTP response status code eg 404
err.headershttpx.HeadersHTTP response headers
err.bodystrHTTP body. Can be empty string if no body is returned.
err.raw_responsehttpx.ResponseRaw HTTP response
err.dataOptional. Some errors may contain structured data. See Error Classes.

Example

importcensys_platformfromcensys_platformimportSDK, modelswithSDK(
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) assdk:
res=Nonetry:
res=sdk.account_management.get_organization_details(organization_id="11111111-2222-3333-4444-555555555555", include_member_counts=False)
# Handle responseprint(res)
exceptmodels.SDKBaseErrorase:
# The base class for HTTP error responsesprint(e.message)
print(e.status_code)
print(e.body)
print(e.headers)
print(e.raw_response)
# Depending on the method different errors may be thrownifisinstance(e, models.AuthenticationError):
print(e.data.error) # Optional[censys_platform.AuthenticationErrorDetail]

Error Classes

Primary errors:

Less common errors (5)

Network errors:

Inherit from SDKBaseError:

  • ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

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:

fromcensys_platformimportSDKwithSDK(
server_url="https://api.platform.censys.io",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) assdk:
res=sdk.account_management.get_organization_details(organization_id="11111111-2222-3333-4444-555555555555", include_member_counts=False)
# Handle responseprint(res)

Custom HTTP Client

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:

fromcensys_platformimportSDKimporthttpxhttp_client=httpx.Client(headers={"x-custom-header": "someValue"})
s=SDK(client=http_client)

or you could wrap the client with your own custom logic:

fromcensys_platformimportSDKfromcensys_platform.httpclientimportAsyncHttpClientimporthttpxclassCustomClient(AsyncHttpClient):
client: AsyncHttpClientdef__init__(self, client: AsyncHttpClient):
self.client=clientasyncdefsend(
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"returnawaitself.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
defbuild_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:
returnself.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()))

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

NameTypeScheme
personal_access_tokenhttpHTTP Bearer

To authenticate with the API the personal_access_token parameter must be set when initializing the SDK client instance. For example:

fromcensys_platformimportSDKwithSDK(
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) assdk:
res=sdk.account_management.get_organization_details(organization_id="11111111-2222-3333-4444-555555555555", include_member_counts=False)
# Handle responseprint(res)

Resource Management

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.

fromcensys_platformimportSDKdefmain():
withSDK(
organization_id="11111111-2222-3333-4444-555555555555",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) assdk:
# Rest of application here...# Or when using async:asyncdefamain():
asyncwithSDK(
organization_id="11111111-2222-3333-4444-555555555555",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) assdk:
# Rest of application here...

Debugging

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.

fromcensys_platformimportSDKimportlogginglogging.basicConfig(level=logging.DEBUG)
s=SDK(debug_logger=logging.getLogger("censys_platform"))

Development

Maturity

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.

Contributions

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.

SDK Created by Speakeasy

About

No description, website, or topics provided.

Resources

Readme
MIT license

Contributing

Contributing
Activity
Custom properties

Stars

10 stars

Watchers

8 watching

Forks

1 fork
Report repository

Releases

Packages

Used by

Contributors

Languages