---
title: "Host Summary"
method: GET
path: "/api/host/{host}/"
tags: ["Host Info"]
---

# Host Summary

`GET /api/host/{host}/`

Retrieve the latest available data for `{host}`.

## Path parameters

- `host` union, required
  - string — A valid IPv4 address.
  - string, hostname — A domain name

## Query parameters

- `fields` Field[] — You can control the amount of output data by specifying which fields to include or exclude in the response. Use the `source_type` parameter to select between `include` and `exclude` options.
- `source_type` 'include' | 'exclude' — Specify `fields` and use `source_type` to choose between: - `include` to return only the specified fields - `exclude` to return all fields except the specified ones
- `public_indices_only` boolean — By default, data is requested from both [private and public indices](#tag/Indices), returning the most recent results. Use this query parameter to restrict the search to public indices only.

## Response `200`

__Host Summary__

- union
  - HostResponseByIP
    - `type` 'ip', required
    - `ip` string, required — A valid IPv4 address.
    - `ptr` string[] — A list of reverse DNS (PTR) records associated with the IP address.
    - `geo` Geo — Estimated geolocation and timezone information for the host.
    - `privacy` Privacy — Indicates if this IP hosts a VPN, proxy, or Tor exit node.
    - `organization` string — The organization associated with the host.
    - `domains` string[] — The first 10 domains associated with the IP address via DNS records.
    - `domains_count` integer — Total number of domains associated with the IP address
    - `whois` IpWhoisDocument — WHOIS information for an IP address
    - `ports` object[] — A list of open ports detected during the scan.
    - `software` object[] — A list of software and technologies identified on the host.
    - `ioc` object[] — Indicators of compromise (IoCs) provided by third-party sources.
    - `source` object[] — A list of data sources where the information was retrieved.
  - HostResponseByDomain
    - `type` 'domain', required
    - `domain` string, hostname, required — A domain name
    - `related_domains` string[] — The first 10 related domains associated with this domain.
    - `related_domains_count` integer — Total number of associated domains
    - `related_domains_query` string — Query to find related domains in [DNS Search](#tag/Domains).
    - `dns` DomainsDocument — An object representing a set of DNS records for a domain
    - `whois` DomainWhoisHostEndpoint — WHOIS information for domain
    - `ports` object[] — A list of open ports detected during the scan.
    - `software` object[] — A list of software and technologies identified on the host.
    - `ioc` object[] — Indicators of compromise (IoCs) provided by third-party sources.
    - `source` object[] — A list of data sources where the information was retrieved.

## Other responses

- `400` — __Bad Request__: Some required parameters were not passed or were not validated
- `402` — __Not Enough Coins__: You are out of your current subscription plan limits
- `429` — __Daily request limit exceeded__ or __Request throttled__. Additional error details are provided in the response body
- `500` — __Internal Server Error__: Details are included in the response body
- `504` — __Timeout__: The request took too long to process

---

[API](https://skmtc.net/netlas/apis/netlas-api.md) · [All operations](https://skmtc.net/netlas/apis/netlas-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netlas/netlas-api/revisions/2b1f84425791/schema)