---
title: "Domain WHOIS Facet Search"
method: GET
path: "/api/whois_domains_facet/"
tags: ["Domain WHOIS"]
---

# Domain WHOIS Facet Search

`GET /api/whois_domains_facet/`

Searches for `q` in the selected `indices` and groups results by the `facets` field.

## Query parameters

- `q` string, required — The query string used for searching. See [Query Syntax](/knowledge-base/query-language/) for more details.
- `facets` Field[], required — A list of fields to group search results by.
- `indices` IndiceLabel[] — A list of indice labels to search in. If not provided, the search will be performed in the default (most relevant index). Call [indices](#tag/Indices) endpoint to get the list of available indices.
- `size` integer — Number of search results to return for each facet.

## Response `200`

__Facet Search Results__

- FacetSearchResults
  - `aggregations` object[] — A list of aggregated search results.
    - `key` string[] — Aggregation key
    - `doc_count` integer — A number of document with the given key in the search results

## 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
- `403` — __Access Denied__: You are not allowed to perform this action Error details are included in the response body.
- `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)