Shodan

Shodan Account API

Account, profile, and API plan information.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.shodan.io/api
📖
APIReference
https://developer.shodan.io/api
📖
Authentication
https://developer.shodan.io/api/requirements
📖
Documentation
https://developer.shodan.io/api/stream
📖
APIReference
https://developer.shodan.io/api/stream
📖
Documentation
https://developer.shodan.io/api/trends
📖
APIReference
https://developer.shodan.io/api/trends
📖
Documentation
https://internetdb.shodan.io/
📖
Documentation
https://cvedb.shodan.io/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/openapi/shodan-account-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/asyncapi/shodan-stream-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-rest-host-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-rest-search-result-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-rest-alert-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-rest-notifier-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-rest-scan-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-structure/shodan-rest-host-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-structure/shodan-rest-alert-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-stream-banner-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-structure/shodan-stream-banner-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-trends-result-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-internetdb-host-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-cvedb-cve-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-cvedb-cpe-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-ld/shodan-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-rest-host-lookup-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-rest-search-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-rest-scan-create-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-rest-alert-create-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-stream-banner-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-trends-search-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-internetdb-host-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-cvedb-cve-lookup-example.json
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/apis.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-account-overview-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-alert-with-notifier-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-cve-enrichment-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-domain-recon-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-internetdb-vuln-triage-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-network-alert-lifecycle-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-notifier-lifecycle-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-query-directory-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-resolve-and-host-info-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-reverse-dns-to-host-info-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-scan-then-inspect-host-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-search-builder-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-search-to-host-detail-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-submit-scan-and-poll-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/arazzo/shodan-trends-vs-live-workflow.yml

OpenAPI Specification

shodan-account-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Shodan CVEDB Account API
  description: Shodan's CVEDB is a free vulnerability database API that supports CVE lookups, CPE-keyed vulnerability search, KEV filtering, EPSS ordering, date-range queries, and product-name search. No API key required; updated daily.
  version: '1.0'
  contact:
    name: Shodan Support
    email: support@shodan.io
    url: https://cvedb.shodan.io/
  license:
    name: Shodan API Terms of Service
    url: https://www.shodan.io/legal/tos
servers:
- url: https://cvedb.shodan.io
  description: Production
tags:
- name: Account
  description: Account, profile, and API plan information.
paths:
  /account/profile:
    get:
      tags:
      - Account
      summary: Get Account Profile
      operationId: getAccountProfile
      description: Returns information about the Shodan account.
      responses:
        '200':
          description: Account profile.
          content:
            application/json:
              schema:
                type: object
                properties:
                  member:
                    type: boolean
                  credits:
                    type: integer
                  display_name:
                    type: string
                  created:
                    type: string
                    format: date-time
  /api-info:
    get:
      tags:
      - Account
      summary: Get API Plan Info
      operationId: getApiInfo
      description: Returns information about the API plan including remaining query and scan credits.
      responses:
        '200':
          description: API plan info.
          content:
            application/json:
              schema:
                type: object
                properties:
                  query_credits:
                    type: integer
                  scan_credits:
                    type: integer
                  telnet:
                    type: boolean
                  plan:
                    type: string
                  https:
                    type: boolean
                  unlocked:
                    type: boolean
                  monitored_ips:
                    type: integer
                  usage_limits:
                    type: object
                    additionalProperties:
                      type: integer