README.md

Censys Python Library

An easy-to-use and lightweight API wrapper for Censys APIs (censys.io). Python 3.6.2+ is currently supported.

Notice: The Censys Search v1 endpoints are deprecated as of Nov. 30, 2021. Please begin using v2 endpoints to query hosts and certificates and check out our support center for resources.

Features

• Search Censys data
• Bulk Certificate lookups
• Download Bulk Data
• Manage assets, events, and seeds in Censys ASM
• Command-line interface

Getting Started

The library can be installed using pip.

pip install censys

To upgraded using pip.

pip install --upgrade censys

To configure your search credentials run censys config or set both CENSYS_API_ID and CENSYS_API_SECRET environment variables.

$ censys config

Censys API ID: XXX
Censys API Secret: XXX

Successfully authenticated for [email protected]

To configure your ASM credentials run censys asm config or set the CENSYS_ASM_API_KEY environment variables.

$ censys asm config

Censys ASM API Key: XXX

Successfully authenticated

API Reference and User Guide available on Read the Docs

Resources

• Source
• Issue Tracker
• Changelog
• Documentation
• Discussions
• Censys Homepage
• Censys Search

Contributing

All contributions (no matter how small) are always welcome. See Contributing to Censys Python

Development

This project uses poetry for dependency management. Please ensure you have installed the latest version.

git clone [email protected]:censys/censys-python.git
cd censys-python/
poetry install

Testing

# Run tests
pytest
# With coverage report
pytest --cov-report html

License

This software is licensed under Apache License, Version 2.0

• Copyright (C) 2022 Censys, Inc.