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).
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.
[!IMPORTANT] This library does not support the new Censys Platform, however a new set of SDKs that do support the platform are coming soon. Please refer to the platform API refrence docs in the mean time.
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
The examples located in the examples/ directory are a great place to start. You can also find more examples in the usage documentation.
All contributions (no matter how small) are always welcome. See Contributing to Censys Python
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
# Run tests
poetry run pytest
# With coverage report
poetry run pytest --cov-report html
This software is licensed under Apache License, Version 2.0
FAQs
An easy-to-use and lightweight API wrapper for Censys APIs (censys.io).
We found that censys demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Socket uncovered npm malware campaign mimicking popular Node.js libraries and packages from other ecosystems; packages steal data and execute remote code.
Research
Socket's research uncovers three dangerous Go modules that contain obfuscated disk-wiping malware, threatening complete data loss.
Research
Socket uncovers malicious packages on PyPI using Gmail's SMTP protocol for command and control (C2) to exfiltrate data and execute commands.