https://github.com/achillean/shodan-python

The official Python library for Shodan
https://github.com/achillean/shodan-python

Last synced: 4 days ago
JSON representation

The official Python library for Shodan

• Host: GitHub
• URL: https://github.com/achillean/shodan-python
• Owner: achillean
• License: other
• Created: 2010-09-07T04:09:46.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2024-08-05T13:11:50.000Z (6 months ago)
• Last Synced: 2025-01-20T20:07:58.247Z (11 days ago)
• Language: Python
• Homepage: https://developer.shodan.io
• Size: 438 KB
• Stars: 2,543
• Watchers: 134
• Forks: 577
• Open Issues: 42
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

• awesome-starred - achillean/shodan-python - The official Python library for Shodan (others)
• awesome-ip-search-engines - Shodan Python Library

README

        
shodan: The official Python library and CLI for Shodan

======================================================

.. image:: https://img.shields.io/pypi/v/shodan.svg

    :target: https://pypi.org/project/shodan/

.. image:: https://img.shields.io/github/contributors/achillean/shodan-python.svg

    :target: https://github.com/achillean/shodan-python/graphs/contributors

Shodan is a search engine for Internet-connected devices. Google lets you search for websites,

Shodan lets you search for devices. This library provides developers easy access to all of the

data stored in Shodan in order to automate tasks and integrate into existing tools.

Features

--------

- Search Shodan

- `Fast/ bulk IP lookups `_

- Streaming API support for real-time consumption of Shodan firehose

- `Network alerts (aka private firehose) `_

- `Manage Email Notifications `_

- Exploit search API fully implemented

- Bulk data downloads

- Access the Shodan DNS DB to view domain information

- `Command-line interface `_

.. image:: https://cli.shodan.io/img/shodan-cli-preview.png

    :target: https://asciinema.org/~Shodan

    :width: 400px

    :align: center

Quick Start

-----------

.. code-block:: python

    from shodan import Shodan

    api = Shodan('MY API KEY')

    # Lookup an IP

    ipinfo = api.host('8.8.8.8')

    print(ipinfo)

    # Search for websites that have been "hacked"

    for banner in api.search_cursor('http.title:"hacked by"'):

        print(banner)

    # Get the total number of industrial control systems services on the Internet

    ics_services = api.count('tag:ics')

    print('Industrial Control Systems: {}'.format(ics_services['total']))

Grab your API key from https://account.shodan.io

Installation

------------

To install the Shodan library, simply:

.. code-block:: bash

    $ pip install shodan

Or if you don't have pip installed (which you should seriously install):

.. code-block:: bash

    $ easy_install shodan

Documentation

-------------

Documentation is available at https://shodan.readthedocs.org/ and https://help.shodan.io