censys.search.v1 package

Interact with the Censys Search v1 APIs.

class censys.search.v1.CensysCertificates(api_id: Optional[str] = None, api_secret: Optional[str] = None, **kwargs)[source]

Bases: censys.search.v1.api.CensysSearchAPIv1

Interacts with the Certificates index.

See CensysSearchAPIv1 for additional arguments.

Args:

*args: Variable length argument list. **kwargs: Arbitrary keyword arguments.

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

Default Search API base URL.

INDEX_NAME: Optional[str] = 'certificates'

Name of Censys Index.

MAX_PER_BULK_REQUEST = 50

Max number of bulk requests.

bulk(fingerprints: List[str]) dict[source]

Requests bulk certificates.

Args:

fingerprints (List[str]): List of certificate SHA256 fingerprints.

Returns:

dict: Search results from an API query.

bulk_path = '/bulk/certificates'
class censys.search.v1.CensysData(api_id: Optional[str] = None, api_secret: Optional[str] = None, **kwargs)[source]

Bases: censys.search.v1.api.CensysSearchAPIv1

Interacts with the Data index.

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

get_series() dict[source]

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

Returns:

dict: The result set returned.

view_result(series_id: str, result_id: str) dict[source]

View a specific result of a specific series.

Args:

series_id (str): The ID of the series. result_id (str): The ID of the result.

Returns:

dict: The result set returned.

view_series(series_id: str) dict[source]

Get data on a specific series.

Args:

series_id (str): The ID of the series.

Returns:

dict: The result set returned.

censys.search.v1.api module

Base for interacting with the Censys Search API.

class censys.search.v1.api.CensysSearchAPIv1(api_id: Optional[str] = None, api_secret: Optional[str] = None, **kwargs)[source]

Bases: censys.common.base.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: Optional[str] = None

Name of Censys Index.

account() dict[source]

Gets the current account information.

This includes email and quota.

Returns:

dict: Account response.

metadata(query: str) dict[source]

Returns metadata of a given search query.

Args:

query (str): The query to be executed.

Returns:

dict: The metadata of the result set returned.

quota() dict[source]

Gets the current account’s query quota.

Returns:

dict: Quota response.

report(query: str, field: str, buckets: int = 50) dict[source]

Creates a report on the breakdown of the values of a field in a result set.

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

Args:

query (str): The query to be executed. field (str): The field you are running a breakdown on. buckets (int): Optional; The maximum number of values. Defaults to 50.

Returns:

dict: The result set returned.

search(query: str, fields: Optional[List[str]] = None, page: int = 1, max_records: Optional[int] = None, flatten: bool = True) Iterator[dict][source]

Searches the given index for all records that match the given query.

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

Args:

query (str): The query to be executed. fields (Fields): Optional; Fields to be returned in the result set. page (int): Optional; The page of the result set. Defaults to 1. max_records (int): Optional; The maximum number of records. flatten (bool): Optional; Flattens fields to dot notation. Defaults to True.

Raises:

CensysException: Base Exception Class for the Censys API.

Yields:

dict: The result set returned.

view(document_id: str) dict[source]

View the current structured data we have on a specific document.

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

Args:

document_id (str): The ID of the document you are requesting.

Returns:

dict: The result set returned.