ExUrlscan

Build StatusCoverage StatusCodacy Badge

Description

Elixir API client for urlscan.io.

Installation

Add ExUrlscan to your list of dependencies in mix.exs:

def deps do
[{:ex_urlscan, "~> 0.1.0}]
end

Pass your API key via the mix configuration:

config :ex_urlscan,
api_key: "YOUR_API_KEY"

Or, pass the API key via URLSCAN_API_KEY environment variable.

export URLSCAN_API_KEY="YOUR_API_KEY"

Usage

# result
ExUrlscan.V1.Client.result(uuid)
# search
ExUrlscan.V1.Client.search(q: "domain:urlscan.io")
# scan
ExUrlscan.V1.Client.scan("http://github.com")
ExUrlscan.V1.Client.scan("http://github.com", public: "off")

TODO