Skip to content

existagon/urlscan

Repository files navigation

urlscan

A urlscan.io API library for Go

urlscan logo

Features

  • Scanning URLs with urlscan
  • Getting scan results
  • Searching for scan results

Usage

Initializing the Client

To get an API Key, sign up for urlscan and go to the "Settings & API" profile menu

    client := urlscan.NewClient("MY-API-KEY")

Scanning

scan, err := client.Scan("https://example.com", urlscan.ScanOptions{
		Tags:    []string{"test", "urlscan-go"},
		Country: "ca",
	})

Getting a result

result, err := client.GetResult("result-uuid-here")

Searching

result, _ := client.Search("domain:(example.com OR example.net)", 100)

for _, result := range result.Results {
	// Do something here
}

For further documentation, see this package at pkg.go.dev

Contributing

See CONTRIBUTING.md