censys.search.v1 package

Interact with the Censys Search v1 APIs.

class censys.search.v1.CensysData(api_id: str | None = None, api_secret: str | None = None, **kwargs)

Bases: CensysSearchAPIv1

Interacts with the Data index.

For more details, see our documentation: https://search.censys.io/api

get_series() → dict

Get data on the types of scans we regularly perform (series).

Returns:

The result set returned.

Return type:

dict

view_result(series_id: str, result_id: str) → dict

View a specific result of a specific series.

Parameters:

• series_id (str) – The ID of the series.

• result_id (str) – The ID of the result.

Returns:

The result set returned.

Return type:

dict

view_series(series_id: str) → dict

Get data on a specific series.

Parameters:

series_id (str) – The ID of the series.

Returns:

The result set returned.

Return type:

dict

censys.search.v1.api module

Base for interacting with the Censys Search API.

class censys.search.v1.api.CensysSearchAPIv1(api_id: str | None = None, api_secret: str | None = None, **kwargs)

Bases: CensysAPIBase

This class is the base class for all v1 API indexes.

DEFAULT_URL: str = 'https://search.censys.io/api/v1'

Default Search API base URL.

INDEX_NAME: str | None = None

Name of Censys Index.

account() → dict

Gets the current account information.

This includes email and quota.

Returns:

Account response.

Return type:

dict

quota() → dict

Gets the current account’s query quota.

Returns:

Quota response.

Return type:

dict