v1

latestOpenAPI 3.0.02026-07-1441177156.0 KB

Bulk Search

IP bulk search download

Initiates the creation of the file with data about IPs that matched the search query. When the file is created, it will be available for download. On the successful call, returns the unique identifier that represents the file creation process. The file creation is an asynchronous process, because the amount of data that should be exported to the file and the export duration is hard to predict. The call to this endpoint just initiates the file creation. To check the file status and get the download link, send a GET request to the /v4/data/account/downloads/ API endpoint with the identifier returned by this endpoint. The number of rows available for download is determined by the subscription plan.

post/bulk-search/ip/download

Request body

column_liststring[] required

List of columns to download. Supported values: ip, ptr_record_value, spyse_score, country, as_number, as_organization, isp, osh, city, open_ports_count, open_ports, abuses_score

descriptionstring

An optional field with a short file description. Max length: 254 characters.

file_format'csv' | 'ndjson' required

The file format to use for the file creation. Supported values: ndjson, csv.

ip_liststring[] required

The list of valid IPv4 addresses to search for.

rows_countinteger

The number of rows the user wants to receive in the current download request.

Example request

{
  "column_list": [
    "ip",
    "ptr_record_value",
    "spyse_score",
    "country",
    "city",
    "as_number",
    "as_organization",
    "isp",
    "osh",
    "open_ports_count",
    "open_ports",
    "abuses_score"
  ],
  "description": "description",
  "ip_list": [
    "8.8.8.8",
    "8.8.8.7"
  ]
}

Response

Operation successful