Urlscan 1.0.1
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Urlscan --version 1.0.1
NuGet\Install-Package Urlscan -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Urlscan" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Urlscan --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Urlscan, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Urlscan as a Cake Addin #addin nuget:?package=Urlscan&version=1.0.1 // Install Urlscan as a Cake Tool #tool nuget:?package=Urlscan&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Urlscan
🔎 A C# library for interacting with the Urlscan API.
Usage
This library can be downloaded as the package Urlscan. The main classes are UrlscanClient and LiveClient.
https://www.nuget.org/packages/Urlscan
Obtaining API keys
API keys can be created in the user section
Settings & API
Security identifier SID cookies can be obtained from the cookie storage. Make sure to only copy the value, without the name!
Features
- Fully async
- Full coverage of the free API endpoints, including user-only routes
- Scan suspicious URLs and verdict on them
- Download screenshots and page DOMs
- See finsished public scans in real time using
LiveClient - Automatic ratelimit handling
- Detailed documentation
Available methods
- Task<Stats>
Stats() - Task<User>
UserInfo() - Task<Submission>
Scan(string url, string[] tags = null, string userAgent = null, string referer = null, bool overrideSafety = false, Visibility visibility = Visibility.Public, ScanCountry country = ScanCountry.Auto) - Task<Submission>
Scan(ScanPayload payload) - Task<Result>
Poll(Submission subm, int delay = 5000, int interval = 2000) - Task<Result>
Poll(string uuid, int delay = 5000, int interval = 2000) - Task<Result>
Result(string uuid) - Task
Verdict(Result result, VerdictScope scope, VerdictType type, string comment, string[] brands, ThreatType[] threats) - Task
Verdict(VerdictPayload payload) - Task
Verdict(string uuid, VerdictScope scope, string scopeValue, VerdictType type, string comment, string[] brands, ThreatType[] threats) - Task<SearchResult[]>
Search(string query, int amount = 100) - Task<Stream>
DownloadScreenshotStream(string uuid) - Task<byte[]>
DownloadScreenshot(Result res) - Task<byte[]>
DownloadScreenshot(string uuid) - Task<string>
DownloadDOM(Result res) - Task<string>
DownloadDOM(string uuid)
Available events
- EventHandler<LiveScan>
UrlScanned
Official Links
https://urlscan.io https://twitter.com/urlscanio
Example
Under the Example folder you can find a demo application that works with the library.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net6.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.