The io.github.OpenOSINT/openosint server provides an AI-powered OSINT agent & MCP server with a natural-language interface. It exposes 16 investigation tools for security research and analysis, including email, breach, IP, WHOIS, DNS, and Shodan. It can be used as a REPL, CLI, MCP server, or browser Web UI.
π οΈ Key Features
MCP server for OSINT tool access
Natural-language interface for investigation
16 tools covering email, breach, IP, WHOIS, DNS, and Shodan
π Use Cases
Security research and analyst investigations
OSINT workflows using an MCP integration
Interactive use via REPL, CLI, or browser Web UI
β‘ Developer Benefits
Tool calls are issued by the AI, while the real binaries execute in code
βHallucinated findingsβ are described as structurally impossible
β οΈ Limitations
Tool availability and scope depend on the provided 16 investigation tools
An OSINT (Open Source Intelligence) agent for security researchers and analysts: 20 investigation tools behind a natural-language interface, plus an MCP (Model Context Protocol) server so any MCP-compatible AI client can drive them directly.
Use it as a REPL, CLI, MCP server, or browser Web UI.
The AI issues hard-stop tool calls; your code executes the real binary β hallucinated findings are structurally impossible.
Self-host (free, MIT)
bash
pip install openosint
bash
# Interactive AI REPL (default)
openosint
# Web interface
openosint web
# Direct tool (no AI)
openosint email target@example.com
Try the live demo β β bring your own Anthropic / OpenRouter / Ollama key, no signup.
βοΈ OpenOSINT Cloud β no install, pay per use
Run OpenOSINT tools with zero install as pay-per-use Apify Actors, in your browser or as MCP tools in Claude, Cursor, and Windsurf.
All three are also available as MCP tools with no server to run: https://mcp.apify.com?tools=complete_analogy/openosint-email-recon,complete_analogy/openosint-username-recon,complete_analogy/openosint-domain-recon
Cloud or self-host? Cloud: zero setup, pay per call, hosted by us β cloud usage funds ongoing development of the self-hosted project. Self-host: free forever, your own API keys, full control.
π¬ Agents & OSINT β the newsletter
One AI-OSINT workflow you can run + a ruthless roundup of what's new, every week.
Subscribe β
OpenOSINT globe view: an agent investigation triggered from a chat prompt lands as a point on an interactive 3D globe, clicking the point pivots into a follow-up investigation, and the new entity appears in the entity graphInvestigation results land live on the globe β click a point to pivot. Watch the sharper MP4.
Deterministic, synthetic-data demo β every entity shown is fictional; regenerate with demo/web_demo.py.
The entities are seeded at the statement layer, not produced by today's mappers β see demo/README.md.
TestMu AI (formerly LambdaTest) is an AI-native testing cloud platform built for modern engineering teams. It covers everything from autonomous test creation and fast execution to testing AI agents, chatbots and voice assistants.
Open: Breach / Compromised-Credential Data Β· Email / Identity Lookup β see SPONSORSHIP.md.
Usage
Start the REPL and investigate any target β the agent decides which tools to run and chains them on findings:
Anthropic Claude (default), local Ollama, or any OpenAI-compatible endpoint (LiteLLM, vLLM, LM Studio, ...)
Native MCP server
All 20 tools exposed to Claude Code, Claude Desktop, and any MCP-compatible client β no extra config
Parallel execution
--parallel runs complementary tools concurrently via asyncio.gather()
Reports
PDF + Markdown auto-saved after every investigation (reportlab optional)
Session history
All REPL sessions saved to ~/.openosint/history/; browse with openosint history
Web UI
Browser-based AI chat with streaming output, tool cards, light/dark theme
Legal Disclaimer: OpenOSINT is intended for legal and authorized use only.
Users are solely responsible for ensuring their use complies with all applicable laws and regulations.
The authors accept no liability for misuse. See DISCLAIMER.md.
Tools
Tool
Powered by
What it investigates
search_email
holehe
Social accounts linked to an email address
search_username
sherlock
Username presence across 400+ platforms
search_breach
HaveIBeenPwned v3 API
Data breach exposure
search_whois
python-whois
Domain registrant and DNS info
search_ip
ipinfo.io
Geolocation, ASN, hostname
search_domain
sublist3r
Subdomain enumeration
generate_dorks
built-in
12 targeted Google dork URLs (no network calls)
search_paste
psbdmp.ws
Pastebin dump mentions
search_phone
phoneinfoga
Carrier, country, line type
search_shodan
Shodan API
Open ports, banners, CVEs
search_virustotal
VirusTotal API v3
Verdict from 70+ antivirus engines
search_ip2location
IP2Location.io API
Enhanced IP intel: VPN/Proxy/Tor/datacenter flags (sponsored)
search_censys
Censys Search API
Internet-facing infrastructure, certificates
search_abuseipdb
AbuseIPDB v2 API
IP abuse reputation: confidence score, reports, country, ISP
Queries IP2Location.io for enhanced IP intelligence: geolocation, ISP, ASN, and β on the Security Plan β VPN/Proxy/Tor/datacenter detection. Sponsored integration. Requires IP2LOCATION_API_KEY.
bash
openosint ip2location 8.8.8.8
text
[IP2Location] City: Mountain View, CA, US | ISP: Google LLC
[IP2Location] VPN: No | Proxy: No | TOR: No | Datacenter: Yes
[Censys] Open Ports: 53, 443, 853 | ASN: AS15169 Google LLC
search_abuseipdb
Checks an IP against AbuseIPDB v2. Returns abuse confidence score, total reports, country, ISP, and last reported timestamp. Requires ABUSEIPDB_API_KEY.
bash
openosint abuseipdb 198.51.100.1
text
[AbuseIPDB] Abuse Confidence Score: 87% | Total Reports: 143
β οΈ HIGH ABUSE CONFIDENCE β flagged by AbuseIPDB
Warning appears when abuseConfidenceScore exceeds 50%.
Executes live Google dork queries through the Bright Data SERP APIΒΉ, returning structured results (title, URL, snippet). Defaults to 5 dorks per run; each is a separate billable API call. Requires BRIGHTDATA_API_KEY and BRIGHTDATA_SERP_ZONE.
[+] Dork: "john doe" site:linkedin.com
Title: John Doe | LinkedIn
URL: https://www.linkedin.com/in/john-doe-12345
scrape_url
Fetches any public URL through Bright Data Web UnlockerΒΉ, bypassing Cloudflare/CAPTCHA. Returns clean Markdown. Requires BRIGHTDATA_API_KEY and BRIGHTDATA_UNLOCKER_ZONE.
bash
openosint scrape https://example.com
text
[Web Unlocker] Remote status: 200
# Example Domain
This domain is for use in illustrative examples in documents.
search_footprint
Collects a target's public search-engine footprint via Bright Data SERP APIΒΉ. Detects entity type (email, username, domain, phone, or full name) and runs entity-type-aware Google queries, returning structured results plus Entity Correlation Graph nodes/edges for discovered domains and profiles. Requires BRIGHTDATA_API_KEY and BRIGHTDATA_SERP_ZONE.
bash
openosint footprint johndoe99
Graph module (optional)
An additive FollowTheMoney entity graph β
statement-level provenance, an append-only store, non-destructive same_as
deduplication, and a human review queue β sits alongside the tools above
without changing anything about them. Opt in with pip install "openosint[graph]" (Python 3.10+) or "openosint[graph-dedup]" (adds
same_as scoring, needs Python 3.11+), then use it via three MCP tools:
graph_export, graph_neighbors, graph_review_candidates. See
docs/graph.md for the full guide and a worked example.
The same workflow is shown end to end β including the .ftm export that
passes ftm validate β in the terminal demo in
docs/graph.md; the web UI walkthrough is the demo at the top
of this README.
Browser-based AI chat with streaming tool output, inline result cards, light/dark theme toggle. Supports local inference via Ollama or any OpenAI-compatible endpoint β no Anthropic API key required.
Which hosts and sites may talk to the server. On a loopback bind the server only answers requests whose Host is 127.0.0.1, localhost or ::1. Every /api/* request from a browser must come from the UI's own origin; cross-site requests are refused (scripts and curl, which send no Origin, are unaffected).
Variable
Use it when
OPENOSINT_ALLOWED_HOSTS
You reach the UI by another name (LAN name, Docker hostname, reverse proxy), e.g. OPENOSINT_ALLOWED_HOSTS=osint.lan,localhost. Comma-separated; host or host:port. On a non-loopback bind (--allow-remote, Docker) the Host check only runs when this is set, so set it there.
OPENOSINT_ALLOWED_ORIGINS
A separate front end on another origin calls the API, e.g. OPENOSINT_ALLOWED_ORIGINS=http://localhost:3000. Comma-separated.
Try the live demo β β bring your own Anthropic / OpenRouter / Ollama key, no signup.
bash
# Fully local (no API key) β requires Ollama runtime: https://ollama.com
ollama pull llama3.2
openosint web
# Settings -> Ollama (local) -> model: llama3.2# OpenAI-compatible endpoint (LiteLLM, vLLM, LM Studio, ...)export OPENAI_BASE_URL="http://localhost:4000/v1"
openosint web
# Settings -> OpenAI API
Breaking change (v2.28+): key usage now follows bind address, not an env var.
Bound to 127.0.0.1/localhost (the default) β no change: keys in your .env
work as before. Bound to any other interface (--host 0.0.0.0, which already
requires --allow-remote) β the web UI never uses a key from your environment
to serve a request; every caller must supply their own, and breach lookups
(search_breach) are disabled outright. This applies regardless of any env
var, including OPENOSINT_DEMO_MODE, which can only add restriction, never
remove it. If you were exposing the web UI on a LAN with your own keys and no
per-caller auth in front of it, that access pattern no longer works.
Running behind a reverse proxy? A loopback bind (127.0.0.1) only means
the OS accepted the connection from this machine β it says nothing about
who can reach it if something in front (nginx, Caddy, a Docker/K8s sidecar,
a tunnel) forwards requests to it from elsewhere. By default, a request that
carries proxy-forwarding headers (X-Forwarded-For, X-Forwarded-Proto,
X-Forwarded-Host, Forwarded, CF-Connecting-IP) is treated exactly like
a non-loopback bind: your local keys are never used, breach lookups are
blocked, and the caller is told why. If you deliberately serve this
through a reverse proxy and want it to behave like a normal local
instance for requests relayed by that proxy, set OPENOSINT_TRUSTED_PROXY=true.
This is a separate variable from the existing TRUSTED_PROXY (which only
affects which IP a rate-limit bucket is attributed to β a low-stakes,
already-loosely-scoped setting some self-hosters already have on).
Reusing that flag here would have silently upgraded an existing
rate-limit-only configuration into one that also permits credentialed
access, without asking. OPENOSINT_TRUSTED_PROXY gets its own explicit
opt-in for that reason. Setting it does not blindly trust the
forwarded headers' content β internally inconsistent values (e.g. two
disagreeing X-Forwarded-Proto values on one request) are still treated
as public regardless. Setting OPENOSINT_TRUSTED_PROXY=true means you
are choosing to serve credentialed lookups to whoever your reverse proxy
relays to this instance β you are the controller for their queries, the
same way OpenOSINT Cloud is for its customers. Put real authentication in
front of it if "whoever the proxy relays" is broader than you intend.
Interactive REPL
Run openosint with no arguments to start the AI-powered REPL:
REPL commands:
Command
Description
<target>
Investigate any target β email, username, domain, IP, name
clear
Reset conversation memory
save
Save last report to reports/
tools
List available tools and their status
config
Show current configuration
history
Browse saved sessions
help
Show all commands
exit / Ctrl-D
Exit
All sessions are auto-saved to ~/.openosint/history/. Browse with openosint history.
For the REPL/CLI with an OpenAI-compatible backend:
MCP hosts launch this server with a cwd that has nothing to do with your
.env (often your home directory, or wherever the host itself runs from).
The server falls back to a repo-root .env for a source checkout, then an
upward search from that arbitrary cwd β but for a pip installed
openosint, neither is reliable. Setting OPENOSINT_ENV_FILE in the
client's own env block above, as shown, is the one option guaranteed to
work regardless of how the host launches the process.
Agentic use via Claude Code:
text
$ claude
> Investigate target@example.com. Trace any username found
across other platforms and compile a full report.
Installation
Quickstart β web UI in one command
Install uv once. It runs OpenOSINT in its own isolated environment, so there is no Python setup:
bash
# macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
Then start OpenOSINT (open a new terminal first if uvx is not found):
bash
uvx openosint web
You should see:
text
[*] OpenOSINT x.y.z web server
[*] App β http://127.0.0.1:8080/
[*] Data β /home/you/.openosint
Your browser opens automatically; if it doesn't, open http://127.0.0.1:8080/. No .env file and no API keys are needed to start β keyless tools work immediately, and AI chat needs a provider key (ANTHROPIC_API_KEY) or a local Ollama.
Want toβ¦
Do this
Use another port
uvx openosint web --port 8081 (if 8080 is busy, OpenOSINT exits and tells you this)
Keep the browser closed
uvx openosint web --no-browser
Find your data
Graph database and session history live in ~/.openosint/ (%USERPROFILE%\.openosint on Windows). Move it with OPENOSINT_HOME=/path; OPENOSINT_GRAPH_DB still overrides just graph.db.
Find reports
CLI and REPL reports are written to ./reports/ in the directory you ran openosint from. The web UI writes none.
Use the entity graph view
Needs the graph extra, which builds PyICU and so needs libicu and a C++ compiler first (Python 3.11+). Ubuntu: sudo apt install libicu-dev pkg-config g++. macOS: brew install icu4c pkg-config and export PKG_CONFIG_PATH="$(brew --prefix icu4c)/lib/pkgconfig". Then uvx --from "openosint[graph]" openosint web. On Windows, or to skip the build, use Docker, which includes it.
Alternatives
bash
# pip (Python 3.10+)
pip install openosint
openosint web
# Updating
pip install --upgrade openosint
# From source
git clone https://github.com/OpenOSINT/OpenOSINT.git
cd OpenOSINT
pip install -e .
Copy .env.example to .env and fill in your keys. .env is read from the
directory you run openosint from (searched upward, like git finds
.git) β it does not need to be at any particular "project root", and a
regular pip install works the same way as running from a source checkout.
Set OPENOSINT_ENV_FILE=/path/to/.env to point at an explicit file instead
(useful for the MCP server, which is launched by its host with an arbitrary
working directory). A real environment variable always takes priority over
a value in .env.
Required below means required for that specific tool to run, not for openosint
itself β the app starts and every key-less tool works with zero configuration.
Variable
Tool
Required
Purpose
ANTHROPIC_API_KEY
AI agent (REPL/Web UI)
Yes, unless using Ollama or an OpenAI-compatible endpoint
Anthropic API key
ANTHROPIC_MODEL
AI agent
Optional
Model name to request (default: claude-sonnet-5). Replaces the deprecated OPENOSINT_MODEL.
OPENAI_BASE_URL
AI agent
Optional
Base URL of an OpenAI-compatible endpoint (e.g. http://localhost:4000/v1)
OPENAI_API_KEY
AI agent
Optional
API key for the endpoint (local servers may ignore it)
OPENAI_MODEL
AI agent
Optional
Model name to request (default: gpt-4o-mini)
OPENOSINT_ENV_FILE
All
Optional
Explicit path to a .env file, overriding the directory search above
Works without it (60 req/h); raises the limit to 5000 req/h β get one
BRIGHTDATA_API_KEY
search_dorks_live, scrape_url, search_footprint
Required for these tools
Bright Data β get oneΒΉ (free tier: 5,000 req/month)
BRIGHTDATA_SERP_ZONE
search_dorks_live, search_footprint
Required for these tools
Your Bright Data SERP zone name (e.g. serp_api1)
BRIGHTDATA_UNLOCKER_ZONE
scrape_url
Required for this tool
Your Bright Data Web Unlocker zone name (e.g. web_unlocker1)
On a fresh install with no keys at all, these still work: generate_dorks,
search_dns, search_whois, search_domain, search_email, search_username,
search_paste, search_phone, search_ip (rate-limited), search_github
(rate-limited), and search_gdelt_geo.
Run a deterministic investigation playbook (no AI)
openosint history [--all] [open N] [clear]
View/manage REPL session history
openosint proxy-test
Verify the configured upstream proxy
openosint sponsors
List current sponsors and featured integrations
openosint prompts
Show info about the AI OSINT Prompt Pack
openosint shell
Explicit alias for the default REPL
-v, --verbose
Enable debug logging to stderr
-t, --timeout N
Override subprocess timeout (seconds)
--api-key KEY
Anthropic API key (overrides env var)
--parallel
Run complementary tools concurrently
--json
Output results as structured JSON
--provider {anthropic,ollama,openai}
AI provider (default: anthropic)
--ollama-model MODEL
Ollama model name (default: llama3.2)
--ollama-host URL
Ollama server URL (default: http://localhost:11434)
--openai-base-url URL
OpenAI-compatible endpoint base URL (env: OPENAI_BASE_URL)
--openai-model MODEL
Model to request from the endpoint (default: gpt-4o-mini; env: OPENAI_MODEL)
--openai-api-key KEY
API key for the endpoint (env: OPENAI_API_KEY)
--no-pdf
Disable automatic PDF generation
Docker
bash
# Build and run
docker compose up --build
# One-off command
docker compose run --rm openosint email target@example.com --json
.env is optional: with no keys the web UI still starts at http://localhost:8080. To provide keys today, list them under environment: in docker-compose.yml (or in a .env next to it), or put a .env in the data volume (/data/.env). Reports are persisted to ./reports/; the graph database and session history live in the openosint-data volume (/data in the container, via OPENOSINT_HOME). The image includes the graph view.
The port is published on 127.0.0.1 only, and the Host check is on (OPENOSINT_ALLOWED_HOSTS defaults to localhost,127.0.0.1 in the compose file; extend it if you reach the UI by another name). To reach it from other machines on purpose, run OPENOSINT_BIND=0.0.0.0 docker compose up: the instance then runs in restricted mode (it never spends keys held on the server). Security note: the UI's setup endpoint accepts and stores API keys, so only do this on a network and behind a firewall or reverse proxy you trust.
Warning: OPENOSINT_PUBLISHED_BIND.docker-compose.yml sets this to the same value as OPENOSINT_BIND to tell the server which address the port is published on; an exact loopback value (127.0.0.1, localhost, ::1) lifts the restriction that a container's 0.0.0.0 bind otherwise gets. Never set it to a loopback value yourself, or edit the compose port mapping away from it, when the port is published on any other interface.
Authorized use only. OpenOSINT queries public and semi-public sources.
It does not bypass authentication, exploit systems, or access anything you
aren't already entitled to see. You are responsible for complying with the
law and the terms of service of every source you query. See
DISCLAIMER.md.
No aggregation guarantees. Each tool reports what its upstream source
currently returns. A negative result (no breach found, no accounts found)
means the source didn't report a match β not that no exposure exists.
Most tools depend on third-party services you don't control. Nine of
the 20 tools hard-require an API key and are subject to that provider's
uptime, rate limits, and pricing (Shodan, VirusTotal, Censys, AbuseIPDB,
IP2Location, HaveIBeenPwned, and the three Bright Dataβbacked tools). Free
tiers are small; heavy use requires a paid plan with the provider, not with
OpenOSINT.
Local binaries are unsandboxed subprocesses.holehe, sherlock,
sublist3r, and phoneinfoga run as external processes on your machine.
Keep them updated yourself; OpenOSINT does not patch or vet them.
The entity graph module (openosint[graph]) is additive, not
authoritative.same_as links are scored candidates for human review,
not verified identity matches β see docs/graph.md.
The AI agent can only call the 20 tools above. It cannot browse the
open web freely, run arbitrary code, or invent data β every finding comes
from a real tool call, but the agent's tool selection can still be wrong
or incomplete for a given target.
OpenOSINT is used by OSINT practitioners, security researchers, and developers actively evaluating intelligence APIs. Every time a user configures an integration, the docs route them to that provider's sign-up page β high-intent exposure at the moment of adoption.
Featured Integration ($2,000/year or $220/month): recommended/default provider for one tool category, exclusive. Logo + badge across README, docs, CLI banner, and Web UI. One vendor per category.
Current sponsors and open categories are listed in the sponsor block at the top of this README. Full media kit, pricing, and the referral funnel: SPONSORSHIP.md.
Earn 30β45% commission promoting the AI OSINT Prompt Pack, Operator's Playbook, and Complete Kit.
Good fit for OSINT/infosec newsletter authors, security YouTube channels, and tool-directory maintainers.
OpenOSINT is free and MIT-licensed for everyone β personal projects, commercial products, SaaS, and closed-source are all covered with no purchase required. Organizations that additionally need a vendor contract, written warranty, indemnification, SLA, or priority support for procurement and compliance can purchase a commercial plan. Three tiers available from β¬300/year β see COMMERCIAL.md for full details and pricing. Contact: commercial@openosint.tech.
Contributing
Issues and pull requests are welcome. See CONTRIBUTING.md for the development workflow, integration registration checklist, and coding conventions. Please read DISCLAIMER.md before contributing.
Regenerating the demo GIF/MP4
bash
export OPENOSINT_DEMO_KEY=sk-ant-... # your Anthropic key β never committed
openosint web & # start the web server on :8080
make demo # record -> encode -> write docs/assets/demo-web-graph.*
git add docs/assets/demo-web-graph.*
venv/uv-tool binary resolution fix β co-installed tools are now found without a separate activation step (#6)
License
OpenOSINT is open source under the MIT License β free for any use, including personal, commercial, academic, and closed-source.
ΒΉ Bright Data links in this README are affiliate/referral links β OpenOSINT earns a commission if you sign up through them, at no extra cost to you.
For authorized security research only. See DISCLAIMER.md.