Skip to content

Zapfmeister/Shodan_API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Shodan_API

Shodan API requests

The different folders contain the most common Shodan API requests in the respective format.

Here the Markdown version with Curl requests:

API

Requests

GET - /shodan/host/1.1.1.1

Description

Returns all services that have been found on the given host IP

CURL

curl -X GET "https://api.shodan.io/shodan/host/1.1.1.1\
?key=your_api_key"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}

GET - /shodan/host/count

Description

This method behaves identical to "/shodan/host/search" with the only difference that this method does not return any host results, it only returns the total number of results that matched the query and any facet information that was requested. As a result this method does not consume query credits.

Parameters query: [String] Shodan search query. The provided string is used to search the database of banners in Shodan, with the additional option to provide filters inside the search query using a "filter:value" format. For example, the following search query would find Apache Web servers located in Germany: "apache country:DE". https://beta.shodan.io/search/filters

facets (optional): [String] A comma-separated list of properties to get summary information on. Property names can also be in the format of "property:count", where "count" is the number of facets that will be returned for a property (i.e. "country:100" to get the top 100 countries for a search query). Visit the Shodan website's Facet Analysis page for an up-to-date list of available facets: https://beta.shodan.io/search/facet

CURL

curl -X GET "https://api.shodan.io/shodan/host/count\
?query=port%3A22&facets=org%2C%20os&key=your_api_key"

Query Parameters

  • query should respect the following schema:
{
  "type": "string",
  "x-sequence": [
    {
      "type": "string",
      "enum": [
        "port:"
      ],
      "default": "port:"
    },
    {
      "type": "string",
      "default": "22"
    }
  ]
}
  • facets should respect the following schema:
{
  "type": "string",
  "default": "org, os"
}
  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}

GET - /shodan/host/search

Description

Search Shodan using the same query syntax as the website and use facets to get summary information for different properties.

Parameters query: [String] Shodan search query. The provided string is used to search the database of banners in Shodan, with the additional option to provide filters inside the search query using a "filter:value" format. For example, the following search query would find Apache Web servers located in Germany: "apache country:DE". https://beta.shodan.io/search/filters

facets (optional): [String] A comma-separated list of properties to get summary information on. Property names can also be in the format of "property:count", where "count" is the number of facets that will be returned for a property (i.e. "country:100" to get the top 100 countries for a search query). Visit the Shodan website's Facet Analysis page for an up-to-date list of available facets: https://beta.shodan.io/search/facet

CURL

curl -X GET "https://api.shodan.io/shodan/host/search\
?query=product%3Anginx&facets=org%2C%20os&key=your_api_key"

Query Parameters

  • query should respect the following schema:
{
  "type": "string",
  "x-sequence": [
    {
      "type": "string",
      "enum": [
        "product:"
      ],
      "default": "product:"
    },
    {
      "type": "string",
      "default": "nginx"
    }
  ]
}
  • facets should respect the following schema:
{
  "type": "string",
  "default": "org, os"
}
  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

GET - /shodan/host/search/facets

Description

This method returns a list of facets that can be used to get a breakdown of the top values for a property.

CURL

curl -X GET "https://api.shodan.io/shodan/host/search/facets\
?key=your_api_key"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}

GET - /shodan/host/search/filters

Description

This method returns a list of search filters that can be used in the search query.

CURL

curl -X GET "https://api.shodan.io/shodan/host/search/filters\
?key=your_api_key"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}

GET - /shodan/host/search/tokens

Description

This method lets you determine which filters are being used by the query string and what parameters were provided to the filters.

Parameters query: [String] Shodan search query. The provided string is used to search the database of banners in Shodan, with the additional option to provide filters inside the search query using a "filter:value" format. For example, the following search query would find Apache Web servers located in Germany: "apache country:DE". https://beta.shodan.io/search/filters

CURL

curl -X GET "https://api.shodan.io/shodan/host/search/tokens\
?key=your_api_key&query=product%3Anginx"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}
  • query should respect the following schema:
{
  "type": "string",
  "x-sequence": [
    {
      "type": "string",
      "enum": [
        "product:"
      ],
      "default": "product:"
    },
    {
      "type": "string",
      "default": "nginx"
    }
  ]
}

GET - /shodan/ports

Description

This method returns a list of port numbers that the crawlers are looking for.

CURL

curl -X GET "https://api.shodan.io/shodan/ports\
?query=product%3Anginx&facets=org%2C%20os&key=your_api_key"

Query Parameters

  • query should respect the following schema:
{
  "type": "string",
  "x-sequence": [
    {
      "type": "string",
      "enum": [
        "product:"
      ],
      "default": "product:"
    },
    {
      "type": "string",
      "default": "nginx"
    }
  ]
}
  • facets should respect the following schema:
{
  "type": "string",
  "default": "org, os"
}
  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

GET - /shodan/protocols

Description

This method returns a list of port numbers that the crawlers are looking for.

CURL

curl -X GET "https://api.shodan.io/shodan/protocols\
?query=product%3Anginx&facets=org%2C%20os&key=your_api_key"

Query Parameters

  • query should respect the following schema:
{
  "type": "string",
  "x-sequence": [
    {
      "type": "string",
      "enum": [
        "product:"
      ],
      "default": "product:"
    },
    {
      "type": "string",
      "default": "nginx"
    }
  ]
}
  • facets should respect the following schema:
{
  "type": "string",
  "default": "org, os"
}
  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

POST - /shodan/scan

Description

Use this method to request Shodan to crawl a network.

Requirements This method uses API scan credits: 1 IP consumes 1 scan credit. You must have a paid API plan (either one-time payment or subscription) in order to use this method.

Parameters ips: [String] A comma-separated list of IPs or netblocks (in CIDR notation) that should get crawled. service: [Array] A list of services that should get scanned, where a service is defined as a [port, protocol].

CURL

curl -X POST "https://api.shodan.io/shodan/scan\
?key=your_api_key" \
    -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
    --data-raw "ips"="1.1.1.1,8.8.8.8"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/x-www-form-urlencoded; charset=utf-8"
  ],
  "default": "application/x-www-form-urlencoded; charset=utf-8"
}

Body Parameters

  • ips should respect the following schema:
{
  "type": "string",
  "enum": [
    "1.1.1.1,8.8.8.8"
  ],
  "default": "1.1.1.1,8.8.8.8"
}

POST - /shodan/scan/internet

Description

Use this method to request Shodan to crawl the Internet for a specific port.

Requirements This method is restricted to security researchers and companies with a Shodan Enterprise Data license. To apply for access to this method as a researcher, please email [email protected] with information about your project. Access is restricted to prevent abuse.

Parameters port: [Integer] The port that Shodan should crawl the Internet for. protocol: [String] The name of the protocol that should be used to interrogate the port. See /shodan/protocols for a list of supported protocols.

CURL

curl -X POST "https://api.shodan.io/shodan/scan/internet\
?key=your_api_key" \
    -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
    --data-raw "port"="22" \
    --data-raw "protocol"="http"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/x-www-form-urlencoded; charset=utf-8"
  ],
  "default": "application/x-www-form-urlencoded; charset=utf-8"
}

Body Parameters

  • port should respect the following schema:
{
  "type": "string",
  "enum": [
    "22"
  ],
  "default": "22"
}
  • protocol should respect the following schema:
{
  "type": "string",
  "default": "http"
}

GET - /shodan/scans

Description

Returns a listing of all the on-demand scans that are currently active on the account.

CURL

curl -X GET "https://api.shodan.io/shodan/scans\
?key=your_api_key"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

GET - /shodan/scan/Lxu8uAEahnlMEm9r

Description

Check the progress of a previously submitted scan request. Possible values for the status are: SUBMITTING QUEUE PROCESSING DONE

CURL

curl -X GET "https://api.shodan.io/shodan/scan/Lxu8uAEahnlMEm9r\
?key=your_api_key"

Path Parameters

  • ResponseBodyPath should respect the following schema:
{
  "type": "string",
  "default": "Lxu8uAEahnlMEm9r"
}

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

POST - /shodan/alert

Description

Use this method to create a network alert for a defined IP/ netblock which can be used to subscribe to changes/ events that are discovered within that range.

Parameters The alert is created by sending a JSON encoded object that has the structure:

{ "name": {name}, "filters": { "ip": {ip}, }, "expires": {expires}, }

name: [String] The name to describe the network alert. filters: [Object] An object specifying the criteria that an alert should trigger. The only supported option at the moment is the "ip" filter. filters.ip: [String] A list of IPs or network ranges defined using CIDR notation. expires (optional): [Integer] Number of seconds that the alert should be active.

CURL

curl -X POST "https://api.shodan.io/shodan/alert\
?key=your_api_key" \
    -H "Content-Type: application/json" \
    --data-raw "$body"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/json"
  ],
  "default": "application/json"
}

Body Parameters

  • body should respect the following schema:
{
  "type": "string",
  "default": "{\"name\":\"DNS Alert\",\"filters\":{\"ip\":[\"8.8.8.8\",\"1.1.1.1\"]},\"expires\":\"0\"}"
}

GET - /shodan/alert/info

Description

Returns a listing of all the network alerts that are currently active on the account.

CURL

curl -X GET "https://api.shodan.io/shodan/alert/info\
?key=your_api_key" \
    -H "Content-Type: application/json" \
    --data-raw "$body"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/json"
  ],
  "default": "application/json"
}

Body Parameters

  • body should respect the following schema:
{
  "type": "string",
  "default": "{\"name\":\"DNS Alert\",\"filters\":{\"ip\":[\"8.8.8.8\",\"1.1.1.1\"]},\"expires\":\"0\"}"
}

GET - /shodan/alert/JRH1XDBUA72I9UA3/info

Description

Returns the information about a specific network alert.

Parameters id: [String] Alert ID

CURL

curl -X GET "https://api.shodan.io/shodan/alert/JRH1XDBUA72I9UA3/info\
?key=your_api_key" \
    -H "Content-Type: application/json"

Path Parameters

  • ResponseBodyPath should respect the following schema:
{
  "type": "string",
  "default": "JRH1XDBUA72I9UA3"
}

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/json"
  ],
  "default": "application/json"
}

DELETE - /shodan/alert/JRH1XDBUA72I9UA3

Description

Remove the specified network alert.

Parameters id: [String] Alert ID

CURL

curl -X DELETE "https://api.shodan.io/shodan/alert/JRH1XDBUA72I9UA3\
?key=your_api_key" \
    -H "Content-Type: application/json"

Path Parameters

  • ResponseBodyPath should respect the following schema:
{
  "type": "string",
  "default": "JRH1XDBUA72I9UA3"
}

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/json"
  ],
  "default": "application/json"
}

POST - /shodan/alert/JRH1XDBUA72I9UA3

Description

Use this method to edit a network alert with a new list of IPs/ networks to keep track of.

Parameters The alert is edited by sending a JSON encoded object that has the structure:

{ "filters": { "ip": {ip}, }, }

filters: [Object] An object specifying the criteria that an alert should trigger. The only supported option at the moment is the "ip" filter. filters.ip: [String] A list of IPs or network ranges defined using CIDR notation.

CURL

curl -X POST "https://api.shodan.io/shodan/alert/JRH1XDBUA72I9UA3\
?key=your_api_key" \
    -H "Content-Type: application/json" \
    --data-raw "$body"

Path Parameters

  • ResponseBodyPath should respect the following schema:
{
  "type": "string",
  "default": "JRH1XDBUA72I9UA3"
}

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/json"
  ],
  "default": "application/json"
}

Body Parameters

  • body should respect the following schema:
{
  "type": "string",
  "default": "{\"filters\":{\"ip\":\"1.1.1.1\"}}"
}

GET - /shodan/alert/triggers

Description

Returns a list of all the triggers that can be enabled on network alerts.

CURL

curl -X GET "https://api.shodan.io/shodan/alert/triggers\
?key=your_api_key" \
    -H "Content-Type: application/json"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/json"
  ],
  "default": "application/json"
}

PUT - /shodan/alert/JRH1XDBUA72I9UA3/trigger/malware

Description

Get notifications when the specified trigger is met.

Parameters id: [String] Alert ID trigger: [String] Comma-separated list of trigger names

CURL

curl -X PUT "https://api.shodan.io/shodan/alert/JRH1XDBUA72I9UA3/trigger/malware\
?key=your_api_key" \
    -H "Content-Type: application/json"

Path Parameters

  • ResponseBodyPath should respect the following schema:
{
  "type": "string",
  "default": "JRH1XDBUA72I9UA3"
}
  • ResponseBodyPath_2 should respect the following schema:
{
  "type": "string",
  "default": "malware"
}

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/json"
  ],
  "default": "application/json"
}

PUT - /shodan/alert/JRH1XDBUA72I9UA3/trigger/malware

Description

Stop getting notifications for the specified trigger.

Parameters id: [String] Alert ID trigger: [String] Comma-separated list of trigger names

CURL

curl -X PUT "https://api.shodan.io/shodan/alert/JRH1XDBUA72I9UA3/trigger/malware\
?key=your_api_key" \
    -H "Content-Type: application/json"

Path Parameters

  • ResponseBodyPath should respect the following schema:
{
  "type": "string",
  "default": "JRH1XDBUA72I9UA3"
}
  • ResponseBodyPath_2 should respect the following schema:
{
  "type": "string",
  "default": "malware"
}

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/json"
  ],
  "default": "application/json"
}

PUT - /shodan/alert/JRH1XDBUA72I9UA3/trigger/malware/ignore/1.1.1.1:53

Description

Ignore the specified service when it is matched for the trigger.

Parameters id: [String] Alert ID trigger: [String] Comma-separated list of trigger names service: [String] Service specified in the format "ip:port" (ex. "1.1.1.1:80"

CURL

curl -X PUT "https://api.shodan.io/shodan/alert/JRH1XDBUA72I9UA3/trigger/malware/ignore/1.1.1.1:53\
?key=your_api_key" \
    -H "Content-Type: application/json"

Path Parameters

  • ResponseBodyPath should respect the following schema:
{
  "type": "string",
  "default": "JRH1XDBUA72I9UA3"
}
  • ResponseBodyPath_2 should respect the following schema:
{
  "type": "string",
  "default": "malware"
}

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/json"
  ],
  "default": "application/json"
}

DELETE - /shodan/alert/JRH1XDBUA72I9UA3/trigger/malware/ignore/1.1.1.1:53

Description

Start getting notifications again for the specified trigger.

Parameters id: [String] Alert ID trigger: [String] Comma-separated list of trigger names service: [String] Service specified in the format "ip:port" (ex. "1.1.1.1:80"

CURL

curl -X DELETE "https://api.shodan.io/shodan/alert/JRH1XDBUA72I9UA3/trigger/malware/ignore/1.1.1.1:53\
?key=your_api_key" \
    -H "Content-Type: application/json"

Path Parameters

  • ResponseBodyPath should respect the following schema:
{
  "type": "string",
  "default": "JRH1XDBUA72I9UA3"
}
  • ResponseBodyPath_2 should respect the following schema:
{
  "type": "string",
  "default": "malware"
}

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/json"
  ],
  "default": "application/json"
}

PUT - /shodan/alert/JRH1XDBUA72I9UA3/notifier/default

Description

Add the specified notifier to the network alert. Notifications are only sent if triggers have also been enabled. For each created user, there is a default notifier which will sent via email.

Parameters id: [String] Alert ID notifier_id: [String] Notifier ID

CURL

curl -X PUT "https://api.shodan.io/shodan/alert/JRH1XDBUA72I9UA3/notifier/default\
?key=your_api_key" \
    -H "Content-Type: application/json"

Path Parameters

  • ResponseBodyPath should respect the following schema:
{
  "type": "string",
  "default": "JRH1XDBUA72I9UA3"
}

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/json"
  ],
  "default": "application/json"
}

DELETE - /shodan/alert/JRH1XDBUA72I9UA3/notifier/default

Description

Remove the notification service from the alert. Notifications are only sent if triggers have also been enabled.

Parameters id: [String] Alert ID notifier_id: [String] Notifier ID

CURL

curl -X DELETE "https://api.shodan.io/shodan/alert/JRH1XDBUA72I9UA3/notifier/default\
?key=your_api_key" \
    -H "Content-Type: application/json"

Path Parameters

  • ResponseBodyPath should respect the following schema:
{
  "type": "string",
  "default": "JRH1XDBUA72I9UA3"
}

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "enum": [
    "your_api_key"
  ],
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/json"
  ],
  "default": "application/json"
}

GET - /notifier

Description

Get a list of all the notifiers that the user has created.

CURL

curl -X GET "https://api.shodan.io/notifier\
?key=your_api_key"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}

GET - /notifier/provider

Description

Get a list of all the notification providers that are available and the parameters to submit when creating them.

CURL

curl -X GET "https://api.shodan.io/notifier/provider\
?key=your_api_key"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}

POST - /notifier

Description

Use this method to create a new notification service endpoint that Shodan services can send notifications through.

Parameters The parameters depend on the type of notification service that is being created. To get a list of parameters for a provider us the /notifier/provider endpoint. The following parameters always need to be provided: provider: [String] Provider name as returned by /notifier/provider description: [String] Description of the notifier **args: [String] Arguments required by the provider

CURL

curl -X POST "https://api.shodan.io/notifier\
?key=your_api_key" \
    -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
    --data-raw "provider"="email" \
    --data-raw "to"="[email protected]" \
    --data-raw "description"=""email notification""

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/x-www-form-urlencoded; charset=utf-8"
  ],
  "default": "application/x-www-form-urlencoded; charset=utf-8"
}

Body Parameters

  • provider should respect the following schema:
{
  "type": "string",
  "enum": [
    "email"
  ],
  "default": "email"
}
  • to should respect the following schema:
{
  "type": "string",
  "enum": [
    "[email protected]"
  ],
  "default": "[email protected]"
}
  • description should respect the following schema:
{
  "type": "string",
  "enum": [
    "\"email notification\""
  ],
  "default": "\"email notification\""
}

DELETE - /notifier/ZKJpffUnarJushBf

Description

Remove the notification service created for the user.

Parameters id: [String] Notifier ID

CURL

curl -X DELETE "https://api.shodan.io/notifier/ZKJpffUnarJushBf\
?key=your_api_key" \
    -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
    --data-raw "$body"

Path Parameters

  • ResponseBodyPath should respect the following schema:
{
  "type": "string",
  "default": "ZKJpffUnarJushBf"
}

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/x-www-form-urlencoded; charset=utf-8"
  ],
  "default": "application/x-www-form-urlencoded; charset=utf-8"
}

Body Parameters

  • body should respect the following schema:
{
  "type": "string",
  "default": ""
}

GET - /notifier/ZKJpffUnarJushBf

Description

Use this method to create a new notification service endpoint that Shodan services can send notifications through.

Parameters id: [String] Notifier ID

CURL

curl -X GET "https://api.shodan.io/notifier/ZKJpffUnarJushBf\
?key=your_api_key" \
    -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
    --data-raw "$body"

Path Parameters

  • ResponseBodyPath should respect the following schema:
{
  "type": "string",
  "default": "ZKJpffUnarJushBf"
}

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/x-www-form-urlencoded; charset=utf-8"
  ],
  "default": "application/x-www-form-urlencoded; charset=utf-8"
}

Body Parameters

  • body should respect the following schema:
{
  "type": "string",
  "default": ""
}

GET - /notifier/ZKJpffUnarJushBf

Description

Use this method to update the parameters of a notifier.

Parameters The parameters depend on the type of notification service that is being created. To get a list of parameters for a provider us the /notifier/provider endpoint.

id: [String] Notifier ID **args: [String] Arguments required by the provider

CURL

curl -X GET "https://api.shodan.io/notifier/ZKJpffUnarJushBf\
?key=your_api_key" \
    -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
    --data-raw "to"="[email protected]"

Path Parameters

  • ResponseBodyPath should respect the following schema:
{
  "type": "string",
  "default": "ZKJpffUnarJushBf"
}

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}

Header Parameters

  • Content-Type should respect the following schema:
{
  "type": "string",
  "enum": [
    "application/x-www-form-urlencoded; charset=utf-8"
  ],
  "default": "application/x-www-form-urlencoded; charset=utf-8"
}

Body Parameters

  • to should respect the following schema:
{
  "type": "string",
  "enum": [
    "[email protected]"
  ],
  "default": "[email protected]"
}

GET - /dns/domain/google.de

Description

Get all the subdomains and other DNS entries for the given domain. Uses 1 query credit per lookup.

Parameters domain: [String] Domain name to lookup; example "cnn.com" history (optional): [Boolean] True if historical DNS data should be included in the results (default: False) type (optional): [String] DNS type, possible values are: A, AAAA, CNAME, NS, SOA, MX, TXT page (optional): [Integer] The page number to page through results 100 at a time (default: 1)

CURL

curl -X GET "https://api.shodan.io/dns/domain/google.de\
?key=your_api_key&history=False&page=1"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}
  • history should respect the following schema:
{
  "type": "string",
  "enum": [
    "False"
  ],
  "default": "False"
}
  • page should respect the following schema:
{
  "type": "string",
  "enum": [
    "1"
  ],
  "default": "1"
}

GET - /dns/resolve

Description

Look up the IP address for the provided list of hostnames.

Parameters hostnames: [String] Comma-separated list of hostnames; example "google.com,bing.com"

CURL

curl -X GET "https://api.shodan.io/dns/resolve\
?key=your_api_key&hostnames=google.com%2Cbing.com"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}
  • hostnames should respect the following schema:
{
  "type": "string",
  "enum": [
    "google.com,bing.com"
  ],
  "default": "google.com,bing.com"
}

GET - /dns/reverse

Description

Look up the hostnames that have been defined for the given list of IP addresses.

Parameters ips: [String] Comma-separated list of IP addresses; example "74.125.227.230,204.79.197.200"

CURL

curl -X GET "https://api.shodan.io/dns/reverse\
?key=your_api_key&ips=1.1.1.1%2C8.8.8.8"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}
  • ips should respect the following schema:
{
  "type": "string",
  "default": "1.1.1.1,8.8.8.8"
}

GET - /tools/httpheaders

Description

Shows the HTTP headers that your client sends when connecting to a webserver.

CURL

curl -X GET "https://api.shodan.io/tools/httpheaders\
?key=your_api_key"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}

GET - /tools/myip

Description

Get your current IP address as seen from the Internet.

CURL

curl -X GET "https://api.shodan.io/tools/myip\
?key=your_api_key"

Query Parameters

  • key should respect the following schema:
{
  "type": "string",
  "default": "your_api_key"
}

References

About

Shodan API requests

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published