Project

urlscan

0.0
No release in over a year
Ruby API client for urlscan.io
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 13.0
~> 6.0
~> 2.2
~> 3.10
~> 3.14

Runtime

~> 1.1
 Project Readme

urlscan

Gem Version Ruby CI Maintainability Coverage Status

Description

urlscan.io API wrapper for Ruby.

Installation

gem install urlscan

API usage

require "urlscan"

# when given nothing, it tries to load your API key from ENV["URLSCAN_API_KEY"]
api = UrlScan::API.new
# or you can set it manually
api = UrlScan::API.new(api_key)

# Submit a URL to scan
res = api.submit("https://wikipedia.org")

# Get a scan result
res = api.result("ac04bc14-4efe-439d-b356-8384843daf75")

# Get a DOM
res = api.dom("ac04bc14-4efe-439d-b356-8384843daf75")

# Search
res = api.search("wikipedia.org")

Supported API endpoints

HTTP Method URI API method
POST /scan UrlScan::Clients::Community#submit(url, customagent: nil, referer: nil, visibility: nil, tags: nil, override_safety: nil, country: nil))
GET /result/uuid/ UrlScan::Clients::Community#result(uuid)
GET /dom/uuid/ UrlScan::Clients::Community#dom(uuid)
GET /screenshots/uuid.png UrlScan::Clients::Community#screenshot(uuid)
GET /search UrlScan::Clients::Community#search(q, size: 100, search_after: nil)

Pro

HTTP Method URI API method
GET /brands UrlScan::Clients::Pro#brands
GET /kits UrlScan::Clients::Pro#kits
GET /phishfeed UrlScan::Clients::Pro#phishfeed(q: "result.task.time:>now-24h", format: "json", limit: ni)
GET /result/uuid/similar/ UrlScan::Clients::Pro#similar(uuid, q: nil, size: nil, search_after: nil, threshold: nil, min_size: nil, method: nil, resource_types: nil))

CLI usage

$ urlscan
Commands:
  urlscan dom [UUID]         # get the DOM of a scan using the scan id [UUID]
  urlscan help [COMMAND]     # Describe available commands or one specific command
  urlscan result [UUID]      # get the result of a scan using the scan id [UUID]
  urlscan screenshot [UUID]  # get the screenshot(image/png) of a scan using the scan id [UUID]
  urlscan search [QUERY]     # search for scans by [QUERY]
  urlscan submit [URL]       # submit a scan to [URL]

Options:
  [--API-KEY=API_KEY]