ZoomEye SDK

Use the official Python SDK and CLI for Python applications, scripts, and command-line workflows.

Install

python -m pip install zoomeye

Python example

import os
from zoomeye.sdk import ZoomEye

client = ZoomEye(api_key=os.environ["ZOOMEYE_API_KEY"])
client.search_api = "https://api.zoomeye.ai/v2/search"
client.userinfo_api = "https://api.zoomeye.ai/v2/userinfo"

account = client.userinfo()
results = client.search(
    'country="US" && service="redis"',
    page=1,
    pagesize=20,
    sub_type="all",
    fields="ip,port,domain,service",
    facets="country,service,port",
)

CLI workflow

The CLI can initialize an API key, display account and quota information, search assets, select fields, paginate, choose an asset subtype, and request facets.

Integration guidance

• Pin dependency versions in production

• Review release notes before upgrading

• Use the current OpenAPI specification when SDK behavior conflicts with website documentation

• Read API keys from environment variables or a secret manager