{"id":28549659,"url":"https://github.com/akacdev/urlscan","last_synced_at":"2025-09-23T23:14:06.868Z","repository":{"id":37912656,"uuid":"506347762","full_name":"akacdev/Urlscan","owner":"akacdev","description":"An async and lightweight C# library for interacting with the Urlscan API.","archived":false,"fork":false,"pushed_at":"2023-11-25T14:16:05.000Z","size":229,"stargazers_count":11,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-09-01T22:10:22.868Z","etag":null,"topics":["check","domain","ioc","ip","link","malware","phishing","scan","screenshot","suspicious","url","url-scan","urlscan"],"latest_commit_sha":null,"homepage":"https://www.nuget.org/packages/Urlscan","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/akacdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-22T17:40:26.000Z","updated_at":"2025-03-13T08:32:20.000Z","dependencies_parsed_at":"2024-07-14T13:51:35.350Z","dependency_job_id":null,"html_url":"https://github.com/akacdev/Urlscan","commit_stats":null,"previous_names":["akacdev/urlscan","actually-akac/urlscan"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/akacdev/Urlscan","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akacdev%2FUrlscan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akacdev%2FUrlscan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akacdev%2FUrlscan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akacdev%2FUrlscan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akacdev","download_url":"https://codeload.github.com/akacdev/Urlscan/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akacdev%2FUrlscan/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276662644,"owners_count":25682084,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-23T02:00:09.130Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["check","domain","ioc","ip","link","malware","phishing","scan","screenshot","suspicious","url","url-scan","urlscan"],"created_at":"2025-06-10T02:11:51.016Z","updated_at":"2025-09-23T23:14:06.852Z","avatar_url":"https://github.com/akacdev.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Urlscan\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg width=\"256\" height=\"256\" src=\"https://raw.githubusercontent.com/actually-akac/Urlscan/master/Urlscan/icon.png\"\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  🔎 An async and lightweight C# library for interacting with the Urlscan API.\n\u003c/div\u003e\n\n## Usage\nThis library provides an easy interface for interacting with the Urlscan API.\nYou can use this library to automate your Urlscan submissions, search for existing scans, track newly submitted scans and analyse network activity of malicious websites.\n\nTo get started, import the library into your solution with either the `NuGet Package Manager` or the `dotnet` CLI.\n```rust\ndotnet add package Urlscan\n```\n\nFor the primary classes to become available, import the used namespace.\n```csharp\nusing Urlscan;\n```\n\nNeed more examples? Under the `Example` directory you can find a working demo project that implements this library.\n\n### Obtaining API keys\nAPI keys can be created under the user section `Settings \u0026 API`.\n\nSecure identifier SID cookies can be obtained from your browser's cookie storage. Make sure to only copy the value, without the name! \n\n## Properties\n- Built for **.NET 8**, **.NET 7** and **.NET 6**\n- Fully **async**\n- Extensive **XML documentation**\n- Coverage of the free API endpoints, including some user-only and beta routes\n- **No external dependencies** (makes use of built-in `HttpClient` and `JsonSerializer`)\n- **Custom exceptions** (`UrlscanException`) for easy debugging\n- Parsing of custom Urlscan errors\n- Example project to demonstrate all capabilities of the library\n\n## Features\n- Scan suspicious URLs and submit verdicts on them\n- Search for public scans using ElasticSearch queries\n- Download screenshots and page DOMs\n- Empower your threat intelligence with live scans through `LiveClient`\n\n## Code Samples\n\n### Initializing a new API client\n```csharp\nUrlscanClient client = new(\"d339bf51-9bc7-4d6a-a960-a264896b1891\");\n```\n\n### Getting the current user\n```csharp\nUser user = await client.GetCurrentUser();\n```\n\n### Submitting a new scan\n```csharp\nSubmission subm = await client.Scan(new ScanParameters()\n{\n    Url = \"https://example.com\",\n    Tags = new string[] { \"test\" },\n    Country = ScanCountry.FI,\n    UserAgent = \"My-Custom-Scanner/1.0.0\",\n    OverrideSafety = false,\n    Referer = \"https://google.com\",\n    Visibility = Visibility.Public\n});\n```\n\n### Polling a submission for the result\n```csharp\nResult res = await client.Poll(subm);\n```\n\n### Getting similar scans\n```csharp\nSimilarScan[] similar = await client.GetSimilarScans(\"bc1ef5f2-eddc-40ae-86c9-fb5894b5d1f2\");\n```\n\n### Processing newly created scans in real time\n```csharp\nLiveClient live = new();\nlive.UrlScanned += (sender, scan) =\u003e\n{\n    Console.WriteLine(scan.Task.URL[..Math.Min(scan.Task.URL.Length, 50)]);\n};\n```\n\n### Adding a verdict to a scan\n```csharp\nawait client.AddVerdict(new VerdictParameters()\n{\n    UUID = \"8964cc71-ea31-476c-ba8f-863bf4bf6b2f\",\n    Comment = \"Running a Discord phishing scam with Discord HypeSquad as their target.\",\n    Scope = VerdictScope.PageDomain,\n    ScopeValue = \"contact-hype-testers.com\",\n    ThreatTypes = new ThreatType[]\n    {\n        ThreatType.Phishing,\n        ThreatType.BrandImpersonation\n    },\n    Brands = new string[]\n    {\n        \"Discord\"\n    },\n    Verdict = VerdictType.Malicious\n});\n```\n\n## References\n- Official website: https://urlscan.io\n- Urlscan Twitter: https://twitter.com/urlscanio\n\n*This is a community-ran library. Not affiliated with Urlscan GmbH.*","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakacdev%2Furlscan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakacdev%2Furlscan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakacdev%2Furlscan/lists"}