Sign in
latestOpenAPI 3.0.3Netlas API & Data License Agreement2026-08-104487309.0 KB

2b1f84425791

Domains

Domains Download

Retrieves size search results matching the query q in the selected indices.

The Netlas SDK and CLI tool additionally include a download_all() method and an --all key that allow you to query all available results.

post/api/domains/download/

Request body

qstring required

The query string used for searching. See Query Syntax for more details.

sizeinteger required

Number of documents to download. Call corresponding Count endpoint to get a number of available documents.

indicesIndiceLabel[]

A list of indice labels to search in. If not provided, the search will be performed in the default (most relevant index).

Call indices endpoint to get the list of available indices.

fieldsField[] required

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' required

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
type'json' | 'csv'

Download output format.

  • json: JSON array output.
  • csv: CSV text output in the response body.

Note: the API may still respond with Content-Type: application/json for CSV output, and Accept: text/csv may return 406. Use request field type: csv to request CSV.

Example request

{
  "q": "domain:example.com",
  "size": 1000,
  "indices": [
    "2025-09-24",
    "2025-09-02"
  ],
  "fields": [
    "*"
  ]
}

Response

Search Results

OR
string required

CSV text content returned by download endpoints when type: csv is requested.

Example response

[
  {
    "data": {
      "txt": [
        "_k2n1y4vw3qtb4skdx9e7dxt97qrmmq9",
        "v=spf1 -all"
      ],
      "a": [
        "23.192.228.80",
        "23.192.228.84",
        "23.215.0.136",
        "96.7.128.175",
        "23.215.0.138",
        "96.7.128.198"
      ],
      "last_updated": "2025-02-18T20:14:08.642Z",
      "@timestamp": "2025-02-18T20:14:08.642Z",
      "level": 2,
      "zone": "com",
      "ns": [
        "a.iana-servers.net",
        "b.iana-servers.net"
      ],
      "domain": "example.com",
      "aaaa": [
        "2600:1408:ec00:36::1736:7f24",
        "2600:1406:bc00:53::b81e:94ce",
        "2600:1406:3a00:21::173e:2e66",
        "2600:1406:bc00:53::b81e:94c8",
        "2600:1408:ec00:36::1736:7f31",
        "2600:1406:3a00:21::173e:2e65"
      ]
    }
  }
]