# shodan

> Shodan API client

Latest version **0.1.0** (published 2012-02-11) · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install shodan
pnpm add shodan
yarn add shodan
bun add shodan
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2012-02-11 |
| First published | 2012-02-11 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Danny Amey |
| Maintainers | dannyamey |

## Links

- npm: https://www.npmjs.com/package/shodan
- Repository: https://github.com/dannyamey/node-shodan
- Homepage: http://github.com/dannyamey/node-shodan
- npm.io page: https://npm.io/package/shodan

## Dependencies (1)

- [request](https://npm.io/package/request.md) 2.9.100

## Recent versions

- 0.1.0 (latest) — 2012-02-11

## README

shodan - a node.js Shodan API client
====================================

## Usage

Get an API key from http://www.shodanhq.com/api_doc, then use the client as 
follows:

    var shodan = require('shodan'),
        client = shodan.createClient({ key: "<shodan api key>" });
    
    // search Shodan
    client.search("cisco-ios", function(err, res) {
      console.log(err, res);
    });
    
    // lookup a host
    client.host("217.140.75.46", function(err, res) {
      console.log(err, res);
    })
    
    // search exploitdb
    client.exploitdbSearch("PHP", function(err, res) {
      console.log(err, res);
    });
    
    // download code from exploitdb
    client.exploitdbDownload(9939, function(err, res) {
      console.log(err, res);
    });
    
    // search metasploit
    client.msfSearch("microsoft", function(err, res) {
      console.log(err, res);
    });
    
    // download code from metasploit
    client.msfDownload("exploit/windows/smb/smb_relay", function(err, res) {
      console.log(err, res);
    });

---
_Source: https://npm.io/package/shodan · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
