Censys Python Library
October 16, 2025 · View on GitHub
Warning
DEPRECATION NOTICE: The Censys Search v1 and v2 APIs will be deprecated soon. Please migrate to the new Censys Platform.
- 📖 New API Documentation: https://docs.censys.com/reference/get-started#/
- 📦 New Python SDK: Install with
pip install censys-platform- https://pypi.org/project/censys-platform/ - 🖥️ New CLI Tool (
cencli): https://docs.censys.com/docs/platform-cli- ⚠️ If you plan to use the new CLI, you will need to uninstall this package's CLI first as both use the
censyscommand name
- ⚠️ If you plan to use the new CLI, you will need to uninstall this package's CLI first as both use the
The Censys ASM APIs in this library are NOT deprecated and will continue to be supported.
An easy-to-use and lightweight API wrapper for Censys APIs (censys.io). Python 3.8+ is currently supported. This library has been tested on Python 3.8 and 3.x (Currently version 3.10).
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
Alternatively, you can install the library using poetry.
git clone https://github.com/censys/censys-python.git
cd censys-python/
poetry install
Optionally, you can enable tab completion for the CLI by adding this line to your ~/.bashrc, ~/.zshrc, or equivalent.
Please note that autocomplete is supported for field names in the
searchcommand.
eval "$(register-python-argcomplete 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
Do you want color output? [y/n]: y
Successfully authenticated for your@email.com
If you have a Censys ASM account, you can configure your ASM credentials by running censys asm config or set both CENSYS_ASM_API_KEY environment variables.
$ censys asm config
Censys ASM API Key: XXX
Do you want color output? [y/n]: y
Successfully authenticated
Examples
The examples located in the examples/ directory are a great place to start. You can also find more examples in the usage documentation.
Documentation
Resources
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 git@github.com:censys/censys-python.git
cd censys-python/
poetry install
Testing
# Run tests
poetry run pytest
# With coverage report
poetry run pytest --cov-report html
License
This software is licensed under Apache License, Version 2.0
- Copyright (C) 2024 Censys, Inc.