censys_start_export {censys}R Documentation

Export large datasets and structured records from Censys to JSON or CSV files

Description

The Export API allows exporting large datasets and structured records from Censys to JSON or CSV files. Unlike the query endpoint, there are no limits on the type or amount of data returned.

Usage

censys_start_export(query, format = c("csv", "json"), flatten = TRUE,
  compress = FALSE, delimiter = ",", headers = TRUE)

Arguments

query

the SQL query to be executed

format

the format data should be output in. Must be csv or json. Default: csv.

flatten

should nested and repeated fields in the query results be flattened. Default: true.

compress

should data files be gzipped. Default: false.

delimiter

delimiter to use between fields in the exported data. Default: ",".

headers

should a header row be included in results files. Default: true.

Details

Exports are executed as asynchronous jobs. You must first start a job. If the query is parsed successfully, the call will return a job ID, which is used in subsequent calls to get job. Once a job executes successfully, the get job endpoint will provide a list of 128MB JSON files that are available for download for 24 hours. Jobs typically require 15-30 seconds to execute.

You must have both CENSYS_API_ID and CENSYS_API_SECRET present in the R environment for the functions in this package to work. It is highly suggested that you place those in ~/.Renviron at least for interactive work.

Value

API call result (invisibly)

References

Censys SQL query syntax: https://censys.io/query; API doc: https://censys.io/api/v1/docs/export

Examples

## Not run: 
q <- censys_start_export("
SELECT location.country, count(ip) FROM ipv4.20161206 GROUP BY location.country
")
censys_export_job_status(q$job_id)
censys_export_download(q$job_id, "~/Data")

## End(Not run)

[Package censys version 0.1.0 Index]