urlscan_submit: Submit a URL for scanning

In hrbrmstr/urlscan: Analyze Websites and Resources They Request

Description

urlscan offers API access to submit URLs for researchers and other institutions. Using the API requires an API key. If you'd like to start submitting URLs via the API, contact them at mailto:[e-mail] with a short description on how you're planning to use the API. Submissions via the API can be public or private, though they prefer public submissions so other users can benefit from the results of your scans.

The API key should be in the environment variable URLSCAN_API_KEY and the easiest way to do that is via the ~/.Renviron file. You can also manually pass it in as a parameter.

Usage

urlscan_submit(url, public = TRUE, custom_agent = NULL,
  referer = NULL, api_key = urlscan_api_key())

Arguments

url	URL to submit
public	Public or private results? TRUE (default) = public.
custom_agent	(character) Override User-Agent for this scan
referer	(character) Override HTTP referer for this scan
api_key	your API key. See urlscan_api_key()

Value

The response to the API call will give you the ID and API endpoint for t he scan, you can use it to retrieve the result after waiting for a short while.

References

https://urlscan.io/about-api/#submission

Examples

## Not run: 
urlscan_submit("https://r-project.org/")

## End(Not run)

hrbrmstr/urlscan documentation built on May 15, 2019, 3:30 p.m.