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.
- Parameters
*args – Variable length argument list.
**kwargs – Arbitrary keyword arguments.
- MAX_PER_BULK_REQUEST = 50
Max number of bulk requests.
- 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
The result set returned.
- Return type
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.
- account() dict [source]
Gets the current account information.
This includes email and quota.
- Returns
Account response.
- Return type
- 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
- 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
- Parameters
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.