# censys-sdk-python
Developer-friendly & type-safe Python SDK specifically catered to leverage *openapi* API.
<div align="left">
<a href="https://www.speakeasy.com/?utm_source=openapi&utm_campaign=python"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
</a>
</div>
<!-- Start Summary [summary] -->
## Summary
<!-- End Summary [summary] -->
<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [censys-sdk-python](https://github.com/censys/censys-sdk-python/blob/master/#censys-sdk-python)
* [SDK Installation](https://github.com/censys/censys-sdk-python/blob/master/#sdk-installation)
* [IDE Support](https://github.com/censys/censys-sdk-python/blob/master/#ide-support)
* [SDK Example Usage](https://github.com/censys/censys-sdk-python/blob/master/#sdk-example-usage)
* [Available Resources and Operations](https://github.com/censys/censys-sdk-python/blob/master/#available-resources-and-operations)
* [Global Parameters](https://github.com/censys/censys-sdk-python/blob/master/#global-parameters)
* [Retries](https://github.com/censys/censys-sdk-python/blob/master/#retries)
* [Error Handling](https://github.com/censys/censys-sdk-python/blob/master/#error-handling)
* [Server Selection](https://github.com/censys/censys-sdk-python/blob/master/#server-selection)
* [Custom HTTP Client](https://github.com/censys/censys-sdk-python/blob/master/#custom-http-client)
* [Authentication](https://github.com/censys/censys-sdk-python/blob/master/#authentication)
* [Resource Management](https://github.com/censys/censys-sdk-python/blob/master/#resource-management)
* [Debugging](https://github.com/censys/censys-sdk-python/blob/master/#debugging)
* [Development](https://github.com/censys/censys-sdk-python/blob/master/#development)
* [Maturity](https://github.com/censys/censys-sdk-python/blob/master/#maturity)
* [Contributions](https://github.com/censys/censys-sdk-python/blob/master/#contributions)
<!-- End Table of Contents [toc] -->
<!-- Start SDK Installation [installation] -->
## SDK Installation
> [!NOTE]
> **Python version upgrade policy**
>
> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), 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
*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
```bash
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.
```bash
poetry add censys-platform
```
### Shell and script usage with `uv`
You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:
```shell
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:
```python
#!/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.
<!-- End SDK Installation [installation] -->
<!-- Start IDE Support [idesupport] -->
## 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.
- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->
<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage
### Example
```python
# Synchronous Example
from censys_platform import SDK
with SDK(
organization_id="11111111-2222-3333-4444-555555555555",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
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 response
print(res)
```
</br>
The same SDK client can also be used to make asychronous requests by importing asyncio.
```python
# Asynchronous Example
import asyncio
from censys_platform import SDK
async def main():
async with SDK(
organization_id="11111111-2222-3333-4444-555555555555",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
res = await sdk.global_data.search_async(search_query_input_body={
"fields": [
"host.ip",
],
"page_size": 1,
"query": "host.services: (protocol=SSH and not port: 22)",
})
# Handle response
print(res)
asyncio.run(main())
```
<!-- End SDK Example Usage [usage] -->
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations
<details open>
<summary>Available methods</summary>
### [collections](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md)
* [list](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#list) - List collections
* [create](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#create) - Create a collection
* [delete](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#delete) - Delete a collection
* [get](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#get) - Get a collection
* [update](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#update) - Update a collection
* [list_events](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#list_events) - Get a collection's events
* [aggregate](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#aggregate) - Aggregate results for a search query within a collection
* [search](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#search) - Run a search query within a collection
### [global_data](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md)
* [get_certificates](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_certificates) - Get multiple certificates
* [get_certificate](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_certificate) - Get a certificate
* [get_hosts](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_hosts) - Get multiple hosts
* [get_host](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_host) - Get a host
* [get_host_timeline](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_host_timeline) - Get host event history
* [get_web_properties](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_web_properties) - Get multiple web properties
* [get_web_property](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_web_property) - Get a web property
* [create_tracked_scan](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#create_tracked_scan) - Create a tracked rescan
* [get_tracked_scan](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_tracked_scan) - Get tracked scan details
* [aggregate](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#aggregate) - Aggregate results for a search query
* [search](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#search) - Run a search query
* [get_tracked_scan_threat_hunting](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_tracked_scan_threat_hunting) - Get tracked scan details
### [threat_hunting](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/threathunting/README.md)
* [get_tracked_scan](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/threathunting/README.md#get_tracked_scan) - Get tracked scan details
* [get_host_observations_with_certificate](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/threathunting/README.md#get_host_observations_with_certificate) - Get Host Observations With Certificate
* [create_tracked_scan](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/threathunting/README.md#create_tracked_scan) - Create a tracked discovery scan
* [get_tracked_scan_threat_hunting](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/threathunting/README.md#get_tracked_scan_threat_hunting) - Get tracked scan details
* [value_counts](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/threathunting/README.md#value_counts) - CensEye: Retrieve value counts to discover pivots
</details>
<!-- End Available Resources and Operations [operations] -->
<!-- Start Global Parameters [global-parameters] -->
## 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 `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.
### Available Globals
The following global parameter is available.
| Name | Type | Description |
| --------------- | ---- | ------------------------------ |
| organization_id | str | The organization_id parameter. |
### Example
```python
from censys_platform import SDK
with SDK(
organization_id="11111111-2222-3333-4444-555555555555",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
res = sdk.collections.list(page_token="<next_page_token>", page_size=1)
# Handle response
print(res)
```
<!-- End Global Parameters [global-parameters] -->
<!-- Start Retries [retries] -->
## 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:
```python
from censys_platform import SDK
from censys_platform.utils import BackoffStrategy, RetryConfig
with SDK(
organization_id="11111111-2222-3333-4444-555555555555",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
res = sdk.collections.list(page_token="<next_page_token>", page_size=1,
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:
```python
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),
organization_id="11111111-2222-3333-4444-555555555555",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
res = sdk.collections.list(page_token="<next_page_token>", page_size=1)
# Handle response
print(res)
```
<!-- End Retries [retries] -->
<!-- Start Error Handling [errors] -->
## Error Handling
[`SDKBaseError`](https://github.com/censys/censys-sdk-python/blob/master/./src/censys_platform/models/sdkbaseerror.py) is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
| ------------------ | ---------------- | --------------------------------------------------------------------------------------- |
| `err.message` | `str` | Error message |
| `err.status_code` | `int` | HTTP response status code eg `404` |
| `err.headers` | `httpx.Headers` | HTTP response headers |
| `err.body` | `str` | HTTP body. Can be empty string if no body is returned. |
| `err.raw_response` | `httpx.Response` | Raw HTTP response |
| `err.data` | | Optional. Some errors may contain structured data. [See Error Classes](https://github.com/censys/censys-sdk-python/blob/master/#error-classes). |
### Example
```python
import censys_platform
from censys_platform import SDK, models
with SDK(
organization_id="11111111-2222-3333-4444-555555555555",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
res = None
try:
res = sdk.collections.list(page_token="<next_page_token>", page_size=1)
# Handle response
print(res)
except models.SDKBaseError as e:
# The base class for HTTP error responses
print(e.message)
print(e.status_code)
print(e.body)
print(e.headers)
print(e.raw_response)
# Depending on the method different errors may be thrown
if isinstance(e, models.ErrorModel):
print(e.data.detail) # Optional[str]
print(e.data.errors) # OptionalNullable[List[censys_platform.ErrorDetail]]
print(e.data.instance) # Optional[str]
print(e.data.status) # Optional[int]
print(e.data.title) # Optional[str]
```
### Error Classes
**Primary errors:**
* [`SDKBaseError`](https://github.com/censys/censys-sdk-python/blob/master/./src/censys_platform/models/sdkbaseerror.py): The base class for HTTP error responses.
* [`ErrorModel`](https://github.com/censys/censys-sdk-python/blob/master/./src/censys_platform/models/errormodel.py): Request does not contain a valid Authorization token. *
<details><summary>Less common errors (5)</summary>
<br />
**Network errors:**
* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.
* [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.
* [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.
**Inherit from [`SDKBaseError`](https://github.com/censys/censys-sdk-python/blob/master/./src/censys_platform/models/sdkbaseerror.py)**:
* [`ResponseValidationError`](https://github.com/censys/censys-sdk-python/blob/master/./src/censys_platform/models/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
</details>
\* Check [the method documentation](https://github.com/censys/censys-sdk-python/blob/master/#available-resources-and-operations) to see if the error is applicable.
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
## 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:
```python
from censys_platform import SDK
with SDK(
server_url="https://api.platform.censys.io",
organization_id="11111111-2222-3333-4444-555555555555",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
res = sdk.collections.list(page_token="<next_page_token>", page_size=1)
# Handle response
print(res)
```
<!-- End Server Selection [server] -->
<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client
The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) 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:
```python
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:
```python
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()))
```
<!-- End Custom HTTP Client [http-client] -->
<!-- Start Authentication [security] -->
## Authentication
### Per-Client Security Schemes
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:
```python
from censys_platform import SDK
with SDK(
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
organization_id="11111111-2222-3333-4444-555555555555",
) as sdk:
res = sdk.collections.list(page_token="<next_page_token>", page_size=1)
# Handle response
print(res)
```
<!-- End Authentication [security] -->
<!-- Start Resource Management [resource-management] -->
## 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][context-manager] and reuse it across the application.
[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
```python
from censys_platform import SDK
def main():
with SDK(
organization_id="11111111-2222-3333-4444-555555555555",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
# Rest of application here...
# Or when using async:
async def amain():
async with SDK(
organization_id="11111111-2222-3333-4444-555555555555",
personal_access_token="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:
# Rest of application here...
```
<!-- End Resource Management [resource-management] -->
<!-- Start Debugging [debug] -->
## 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.
```python
from censys_platform import SDK
import logging
logging.basicConfig(level=logging.DEBUG)
s = SDK(debug_logger=logging.getLogger("censys_platform"))
```
<!-- End Debugging [debug] -->
<!-- Placeholder for Future Speakeasy SDK Sections -->
# 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](https://www.speakeasy.com/?utm_source=openapi&utm_campaign=python)
Raw data
{
"_id": null,
"home_page": "https://github.com/censys/censys-sdk-python.git",
"name": "censys-platform",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.2",
"maintainer_email": null,
"keywords": null,
"author": "Speakeasy",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/cf/b0/8e2602c7a7ee332621c33eacf7540aa27a1072d1b374f7df936694db3ccf/censys_platform-0.7.1.tar.gz",
"platform": null,
"description": "# censys-sdk-python\n\nDeveloper-friendly & type-safe Python SDK specifically catered to leverage *openapi* API.\n\n<div align=\"left\">\n <a href=\"https://www.speakeasy.com/?utm_source=openapi&utm_campaign=python\"><img src=\"https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454\" /></a>\n <a href=\"https://opensource.org/licenses/MIT\">\n <img src=\"https://img.shields.io/badge/License-MIT-blue.svg\" style=\"width: 100px; height: 28px;\" />\n </a>\n</div>\n\n\n<!-- Start Summary [summary] -->\n## Summary\n\n\n<!-- End Summary [summary] -->\n\n<!-- Start Table of Contents [toc] -->\n## Table of Contents\n<!-- $toc-max-depth=2 -->\n* [censys-sdk-python](https://github.com/censys/censys-sdk-python/blob/master/#censys-sdk-python)\n * [SDK Installation](https://github.com/censys/censys-sdk-python/blob/master/#sdk-installation)\n * [IDE Support](https://github.com/censys/censys-sdk-python/blob/master/#ide-support)\n * [SDK Example Usage](https://github.com/censys/censys-sdk-python/blob/master/#sdk-example-usage)\n * [Available Resources and Operations](https://github.com/censys/censys-sdk-python/blob/master/#available-resources-and-operations)\n * [Global Parameters](https://github.com/censys/censys-sdk-python/blob/master/#global-parameters)\n * [Retries](https://github.com/censys/censys-sdk-python/blob/master/#retries)\n * [Error Handling](https://github.com/censys/censys-sdk-python/blob/master/#error-handling)\n * [Server Selection](https://github.com/censys/censys-sdk-python/blob/master/#server-selection)\n * [Custom HTTP Client](https://github.com/censys/censys-sdk-python/blob/master/#custom-http-client)\n * [Authentication](https://github.com/censys/censys-sdk-python/blob/master/#authentication)\n * [Resource Management](https://github.com/censys/censys-sdk-python/blob/master/#resource-management)\n * [Debugging](https://github.com/censys/censys-sdk-python/blob/master/#debugging)\n* [Development](https://github.com/censys/censys-sdk-python/blob/master/#development)\n * [Maturity](https://github.com/censys/censys-sdk-python/blob/master/#maturity)\n * [Contributions](https://github.com/censys/censys-sdk-python/blob/master/#contributions)\n\n<!-- End Table of Contents [toc] -->\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\n> [!NOTE]\n> **Python version upgrade policy**\n>\n> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), 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.\n\nThe SDK can be installed with either *pip* or *poetry* package managers.\n\n### PIP\n\n*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.\n\n```bash\npip install censys-platform\n```\n\n### Poetry\n\n*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.\n\n```bash\npoetry add censys-platform\n```\n\n### Shell and script usage with `uv`\n\nYou can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:\n\n```shell\nuvx --from censys-platform python\n```\n\nIt's also possible to write a standalone Python script without needing to set up a whole project like so:\n\n```python\n#!/usr/bin/env -S uv run --script\n# /// script\n# requires-python = \">=3.9\"\n# dependencies = [\n# \"censys-platform\",\n# ]\n# ///\n\nfrom censys_platform import SDK\n\nsdk = SDK(\n # SDK arguments\n)\n\n# Rest of script here...\n```\n\nOnce that is saved to a file, you can run it with `uv run script.py` where\n`script.py` can be replaced with the actual file name.\n<!-- End SDK Installation [installation] -->\n\n<!-- Start IDE Support [idesupport] -->\n## IDE Support\n\n### PyCharm\n\nGenerally, 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.\n\n- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)\n<!-- End IDE Support [idesupport] -->\n\n<!-- Start SDK Example Usage [usage] -->\n## SDK Example Usage\n\n### Example\n\n```python\n# Synchronous Example\nfrom censys_platform import SDK\n\n\nwith SDK(\n organization_id=\"11111111-2222-3333-4444-555555555555\",\n personal_access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n) as sdk:\n\n res = sdk.global_data.search(search_query_input_body={\n \"fields\": [\n \"host.ip\",\n ],\n \"page_size\": 1,\n \"query\": \"host.services: (protocol=SSH and not port: 22)\",\n })\n\n # Handle response\n print(res)\n```\n\n</br>\n\nThe same SDK client can also be used to make asychronous requests by importing asyncio.\n```python\n# Asynchronous Example\nimport asyncio\nfrom censys_platform import SDK\n\nasync def main():\n\n async with SDK(\n organization_id=\"11111111-2222-3333-4444-555555555555\",\n personal_access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n ) as sdk:\n\n res = await sdk.global_data.search_async(search_query_input_body={\n \"fields\": [\n \"host.ip\",\n ],\n \"page_size\": 1,\n \"query\": \"host.services: (protocol=SSH and not port: 22)\",\n })\n\n # Handle response\n print(res)\n\nasyncio.run(main())\n```\n<!-- End SDK Example Usage [usage] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n<details open>\n<summary>Available methods</summary>\n\n### [collections](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md)\n\n* [list](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#list) - List collections\n* [create](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#create) - Create a collection\n* [delete](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#delete) - Delete a collection\n* [get](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#get) - Get a collection\n* [update](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#update) - Update a collection\n* [list_events](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#list_events) - Get a collection's events\n* [aggregate](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#aggregate) - Aggregate results for a search query within a collection\n* [search](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/collections/README.md#search) - Run a search query within a collection\n\n### [global_data](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md)\n\n* [get_certificates](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_certificates) - Get multiple certificates\n* [get_certificate](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_certificate) - Get a certificate\n* [get_hosts](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_hosts) - Get multiple hosts\n* [get_host](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_host) - Get a host\n* [get_host_timeline](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_host_timeline) - Get host event history\n* [get_web_properties](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_web_properties) - Get multiple web properties\n* [get_web_property](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_web_property) - Get a web property\n* [create_tracked_scan](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#create_tracked_scan) - Create a tracked rescan\n* [get_tracked_scan](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_tracked_scan) - Get tracked scan details\n* [aggregate](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#aggregate) - Aggregate results for a search query\n* [search](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#search) - Run a search query\n* [get_tracked_scan_threat_hunting](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/globaldata/README.md#get_tracked_scan_threat_hunting) - Get tracked scan details\n\n\n### [threat_hunting](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/threathunting/README.md)\n\n* [get_tracked_scan](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/threathunting/README.md#get_tracked_scan) - Get tracked scan details\n* [get_host_observations_with_certificate](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/threathunting/README.md#get_host_observations_with_certificate) - Get Host Observations With Certificate\n* [create_tracked_scan](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/threathunting/README.md#create_tracked_scan) - Create a tracked discovery scan\n* [get_tracked_scan_threat_hunting](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/threathunting/README.md#get_tracked_scan_threat_hunting) - Get tracked scan details\n* [value_counts](https://github.com/censys/censys-sdk-python/blob/master/docs/sdks/threathunting/README.md#value_counts) - CensEye: Retrieve value counts to discover pivots\n\n</details>\n<!-- End Available Resources and Operations [operations] -->\n\n<!-- Start Global Parameters [global-parameters] -->\n## Global Parameters\n\nA 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.\n\nFor 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 `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.\n\n\n### Available Globals\n\nThe following global parameter is available.\n\n| Name | Type | Description |\n| --------------- | ---- | ------------------------------ |\n| organization_id | str | The organization_id parameter. |\n\n### Example\n\n```python\nfrom censys_platform import SDK\n\n\nwith SDK(\n organization_id=\"11111111-2222-3333-4444-555555555555\",\n personal_access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n) as sdk:\n\n res = sdk.collections.list(page_token=\"<next_page_token>\", page_size=1)\n\n # Handle response\n print(res)\n\n```\n<!-- End Global Parameters [global-parameters] -->\n\n<!-- Start Retries [retries] -->\n## Retries\n\nSome 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.\n\nTo change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:\n```python\nfrom censys_platform import SDK\nfrom censys_platform.utils import BackoffStrategy, RetryConfig\n\n\nwith SDK(\n organization_id=\"11111111-2222-3333-4444-555555555555\",\n personal_access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n) as sdk:\n\n res = sdk.collections.list(page_token=\"<next_page_token>\", page_size=1,\n RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False))\n\n # Handle response\n print(res)\n\n```\n\nIf 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:\n```python\nfrom censys_platform import SDK\nfrom censys_platform.utils import BackoffStrategy, RetryConfig\n\n\nwith SDK(\n retry_config=RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False),\n organization_id=\"11111111-2222-3333-4444-555555555555\",\n personal_access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n) as sdk:\n\n res = sdk.collections.list(page_token=\"<next_page_token>\", page_size=1)\n\n # Handle response\n print(res)\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\n[`SDKBaseError`](https://github.com/censys/censys-sdk-python/blob/master/./src/censys_platform/models/sdkbaseerror.py) is the base class for all HTTP error responses. It has the following properties:\n\n| Property | Type | Description |\n| ------------------ | ---------------- | --------------------------------------------------------------------------------------- |\n| `err.message` | `str` | Error message |\n| `err.status_code` | `int` | HTTP response status code eg `404` |\n| `err.headers` | `httpx.Headers` | HTTP response headers |\n| `err.body` | `str` | HTTP body. Can be empty string if no body is returned. |\n| `err.raw_response` | `httpx.Response` | Raw HTTP response |\n| `err.data` | | Optional. Some errors may contain structured data. [See Error Classes](https://github.com/censys/censys-sdk-python/blob/master/#error-classes). |\n\n### Example\n```python\nimport censys_platform\nfrom censys_platform import SDK, models\n\n\nwith SDK(\n organization_id=\"11111111-2222-3333-4444-555555555555\",\n personal_access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n) as sdk:\n res = None\n try:\n\n res = sdk.collections.list(page_token=\"<next_page_token>\", page_size=1)\n\n # Handle response\n print(res)\n\n\n except models.SDKBaseError as e:\n # The base class for HTTP error responses\n print(e.message)\n print(e.status_code)\n print(e.body)\n print(e.headers)\n print(e.raw_response)\n\n # Depending on the method different errors may be thrown\n if isinstance(e, models.ErrorModel):\n print(e.data.detail) # Optional[str]\n print(e.data.errors) # OptionalNullable[List[censys_platform.ErrorDetail]]\n print(e.data.instance) # Optional[str]\n print(e.data.status) # Optional[int]\n print(e.data.title) # Optional[str]\n```\n\n### Error Classes\n**Primary errors:**\n* [`SDKBaseError`](https://github.com/censys/censys-sdk-python/blob/master/./src/censys_platform/models/sdkbaseerror.py): The base class for HTTP error responses.\n * [`ErrorModel`](https://github.com/censys/censys-sdk-python/blob/master/./src/censys_platform/models/errormodel.py): Request does not contain a valid Authorization token. *\n\n<details><summary>Less common errors (5)</summary>\n\n<br />\n\n**Network errors:**\n* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.\n * [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.\n * [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.\n\n\n**Inherit from [`SDKBaseError`](https://github.com/censys/censys-sdk-python/blob/master/./src/censys_platform/models/sdkbaseerror.py)**:\n* [`ResponseValidationError`](https://github.com/censys/censys-sdk-python/blob/master/./src/censys_platform/models/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.\n\n</details>\n\n\\* Check [the method documentation](https://github.com/censys/censys-sdk-python/blob/master/#available-resources-and-operations) to see if the error is applicable.\n<!-- End Error Handling [errors] -->\n\n<!-- Start Server Selection [server] -->\n## Server Selection\n\n### Override Server URL Per-Client\n\nThe 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:\n```python\nfrom censys_platform import SDK\n\n\nwith SDK(\n server_url=\"https://api.platform.censys.io\",\n organization_id=\"11111111-2222-3333-4444-555555555555\",\n personal_access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n) as sdk:\n\n res = sdk.collections.list(page_token=\"<next_page_token>\", page_size=1)\n\n # Handle response\n print(res)\n\n```\n<!-- End Server Selection [server] -->\n\n<!-- Start Custom HTTP Client [http-client] -->\n## Custom HTTP Client\n\nThe Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) 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.\nDepending 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.\nThis 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.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nfrom censys_platform import SDK\nimport httpx\n\nhttp_client = httpx.Client(headers={\"x-custom-header\": \"someValue\"})\ns = SDK(client=http_client)\n```\n\nor you could wrap the client with your own custom logic:\n```python\nfrom censys_platform import SDK\nfrom censys_platform.httpclient import AsyncHttpClient\nimport httpx\n\nclass CustomClient(AsyncHttpClient):\n client: AsyncHttpClient\n\n def __init__(self, client: AsyncHttpClient):\n self.client = client\n\n async def send(\n self,\n request: httpx.Request,\n *,\n stream: bool = False,\n auth: Union[\n httpx._types.AuthTypes, httpx._client.UseClientDefault, None\n ] = httpx.USE_CLIENT_DEFAULT,\n follow_redirects: Union[\n bool, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n ) -> httpx.Response:\n request.headers[\"Client-Level-Header\"] = \"added by client\"\n\n return await self.client.send(\n request, stream=stream, auth=auth, follow_redirects=follow_redirects\n )\n\n def build_request(\n self,\n method: str,\n url: httpx._types.URLTypes,\n *,\n content: Optional[httpx._types.RequestContent] = None,\n data: Optional[httpx._types.RequestData] = None,\n files: Optional[httpx._types.RequestFiles] = None,\n json: Optional[Any] = None,\n params: Optional[httpx._types.QueryParamTypes] = None,\n headers: Optional[httpx._types.HeaderTypes] = None,\n cookies: Optional[httpx._types.CookieTypes] = None,\n timeout: Union[\n httpx._types.TimeoutTypes, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n extensions: Optional[httpx._types.RequestExtensions] = None,\n ) -> httpx.Request:\n return self.client.build_request(\n method,\n url,\n content=content,\n data=data,\n files=files,\n json=json,\n params=params,\n headers=headers,\n cookies=cookies,\n timeout=timeout,\n extensions=extensions,\n )\n\ns = SDK(async_client=CustomClient(httpx.AsyncClient()))\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name | Type | Scheme |\n| ----------------------- | ---- | ----------- |\n| `personal_access_token` | http | HTTP Bearer |\n\nTo authenticate with the API the `personal_access_token` parameter must be set when initializing the SDK client instance. For example:\n```python\nfrom censys_platform import SDK\n\n\nwith SDK(\n personal_access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n organization_id=\"11111111-2222-3333-4444-555555555555\",\n) as sdk:\n\n res = sdk.collections.list(page_token=\"<next_page_token>\", page_size=1)\n\n # Handle response\n print(res)\n\n```\n<!-- End Authentication [security] -->\n\n<!-- Start Resource Management [resource-management] -->\n## Resource Management\n\nThe `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][context-manager] and reuse it across the application.\n\n[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers\n\n```python\nfrom censys_platform import SDK\ndef main():\n\n with SDK(\n organization_id=\"11111111-2222-3333-4444-555555555555\",\n personal_access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n ) as sdk:\n # Rest of application here...\n\n\n# Or when using async:\nasync def amain():\n\n async with SDK(\n organization_id=\"11111111-2222-3333-4444-555555555555\",\n personal_access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n ) as sdk:\n # Rest of application here...\n```\n<!-- End Resource Management [resource-management] -->\n\n<!-- Start Debugging [debug] -->\n## Debugging\n\nYou can setup your SDK to emit debug logs for SDK requests and responses.\n\nYou can pass your own logger class directly into your SDK.\n```python\nfrom censys_platform import SDK\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\ns = SDK(debug_logger=logging.getLogger(\"censys_platform\"))\n```\n<!-- End Debugging [debug] -->\n\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile 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. \nWe 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. \n\n### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=openapi&utm_campaign=python)\n",
"bugtrack_url": null,
"license": null,
"summary": "Python Client SDK Generated by Speakeasy.",
"version": "0.7.1",
"project_urls": {
"Homepage": "https://github.com/censys/censys-sdk-python.git",
"Repository": "https://github.com/censys/censys-sdk-python.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e8ff20b508ce7049453b8548424d6a3d0a381c9c12890ac9f8bfcc05f45ef380",
"md5": "79eb3eaaa9cbff96a1a354e365daddeb",
"sha256": "c9f11b5e78e1ec84e7407476722dad1496cf8e4221f0e341df13f05b6ac7c69e"
},
"downloads": -1,
"filename": "censys_platform-0.7.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "79eb3eaaa9cbff96a1a354e365daddeb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.2",
"size": 421130,
"upload_time": "2025-08-05T16:16:45",
"upload_time_iso_8601": "2025-08-05T16:16:45.356834Z",
"url": "https://files.pythonhosted.org/packages/e8/ff/20b508ce7049453b8548424d6a3d0a381c9c12890ac9f8bfcc05f45ef380/censys_platform-0.7.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cfb08e2602c7a7ee332621c33eacf7540aa27a1072d1b374f7df936694db3ccf",
"md5": "74d3e39ea8d15537dc61d40dd8c5ae05",
"sha256": "23dbcabfe3725555b87ea1a944b25da80709f0f58b1c3ad54773f7d0fb264d40"
},
"downloads": -1,
"filename": "censys_platform-0.7.1.tar.gz",
"has_sig": false,
"md5_digest": "74d3e39ea8d15537dc61d40dd8c5ae05",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.2",
"size": 154240,
"upload_time": "2025-08-05T16:16:46",
"upload_time_iso_8601": "2025-08-05T16:16:46.694634Z",
"url": "https://files.pythonhosted.org/packages/cf/b0/8e2602c7a7ee332621c33eacf7540aa27a1072d1b374f7df936694db3ccf/censys_platform-0.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-05 16:16:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "censys",
"github_project": "censys-sdk-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "censys-platform"
}
JSON
