# Netlas Docs

> Official documentation for Netlas, an internet intelligence platform for host enrichment, internet-wide search, discovery, private scanning, and dataset access.

Netlas Docs is the canonical documentation portal for the Netlas web app, API, CLI, and Python SDK.

Base URL: https://docs.netlas.io/

## Start Here

- https://docs.netlas.io/quick-start/ : Quick start guide for the main Netlas workflows.
- https://docs.netlas.io/api-reference/ : Full Netlas API v1 reference with authentication, rate limits, endpoints, and code samples.
- https://cdn.netlas.io/netlas-openapi.json : Bundled OpenAPI JSON specification for the Netlas API.
- https://docs.netlas.io/faq/ : Support, API key, download limits, and common operational issues.

## Quick Start

- https://docs.netlas.io/quick-start/account/ : Accounts, plans, usage limits, and subscription basics.
- https://docs.netlas.io/quick-start/host/ : IP/Domain Info tool overview and host enrichment workflow.
- https://docs.netlas.io/quick-start/search-tools/ : Search tools overview and how to work with Netlas search results.
- https://docs.netlas.io/quick-start/discovery/ : Attack Surface Discovery tool concepts and usage.
- https://docs.netlas.io/quick-start/scanner/ : Private Scanner modes, behavior, and usage.
- https://docs.netlas.io/quick-start/datastore/ : Netlas Datastore overview and dataset access.
- https://docs.netlas.io/quick-start/payment/ : Billing, subscription, and payment guidance.

## Search And Data Model

- https://docs.netlas.io/knowledge-base/ : Knowledge base index for technical reference material.
- https://docs.netlas.io/knowledge-base/query-language/ : Netlas query language syntax, operators, and examples.
- https://docs.netlas.io/knowledge-base/data-collection/ : Data update cycles, freshness, and collection structure.
- https://docs.netlas.io/knowledge-base/scanning-technology/ : Public scanning coverage, ports, protocols, and collection methods.
- https://docs.netlas.io/knowledge-base/software-and-vulnerabilities/ : Software detection and vulnerability mapping.

## Netlas Data

Netlas provides several main datasets accessible through search and API endpoints.

- **Responses** — Internet scan results for hosts and services. Contains banners, protocols, software detection, and vulnerability mappings.
- **Domains** — DNS records including A, AAAA, MX, NS, TXT and related domain infrastructure data.
- **IP WHOIS** — Ownership and allocation information for IP addresses and networks.
- **Domain WHOIS** — Domain registration metadata including registrar, creation date, and contacts.
- **Certificates** — SSL/TLS certificate data including issuer, subject, fingerprints, and validity periods.

Each dataset has a machine-readable schema listed below.

## Field Reference

- https://docs.netlas.io/knowledge-base/field-reference/responses/ : Fields for internet scan response documents.
- https://docs.netlas.io/knowledge-base/field-reference/domains/ : Fields for DNS data.
- https://docs.netlas.io/knowledge-base/field-reference/whois_ip/ : Fields for IP WHOIS data.
- https://docs.netlas.io/knowledge-base/field-reference/whois_domains/ : Fields for domain WHOIS data.
- https://docs.netlas.io/knowledge-base/field-reference/certs/ : Fields for SSL/TLS certificate data.

## Machine-Readable Field Specifications with Examples

- https://cdn.netlas.io/mapping/responses.json : JSON field specification for Responses.
- https://cdn.netlas.io/mapping/domains.json : JSON field specification for DNS.
- https://cdn.netlas.io/mapping/whois_ip.json : JSON field specification for IP WHOIS.
- https://cdn.netlas.io/mapping/whois_domains.json : JSON field specification for Domain WHOIS.
- https://cdn.netlas.io/mapping/certs.json : JSON field specification for Certificates.

## Key API Guidance

- Prefer the API reference for endpoint details and request/response formats: https://docs.netlas.io/api-reference/
- Use Bearer authentication with the `Authorization` header. The legacy `X-API-Key` header is deprecated.
- Netlas provides code samples for `curl`, the Netlas CLI, and the Python SDK throughout the API reference.
- For search construction and field semantics, combine the query language guide with the relevant field reference pages.

## Product Updates

- https://docs.netlas.io/changelog/ : Product and API release notes, changes, and breaking changes.

## MCP Server

Netlas provides a free, publicly available MCP server for AI assistants and other MCP-compatible clients.

MCP endpoint: https://docs.netlas.io/mcp

Use the MCP server when an assistant needs current Netlas documentation, exact query fields, API endpoint schemas, CLI command metadata, subscription plan information, or machine-readable field mappings. The server exposes tools for searching docs, reading documentation pages, browsing field mappings, inspecting API operations, and checking public plan data.
When the Netlas CLI is also available, use MCP first to verify query syntax, field paths, endpoint details, and command shape, then use the CLI to run searches, inspect results, count matches, fetch host details, or download data according to the user's Netlas account and plan.