Skip to content

Commit 1161a4a

Browse files
committed
Version 1.3.6
- Improved storage of Constants - Updated README.md - Updated XML documentation fields and formatting - Added a new option to Search() - Implemented proper zero similar results handling - Other minor changes
1 parent 06d4304 commit 1161a4a

7 files changed

Lines changed: 83 additions & 57 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ await client.AddVerdict(new VerdictParameters()
119119
- Task\<Result> **GetResult**(string uuid)
120120
- Task\<Result> **Poll**(string uuid, int delay = 5000, int interval = 2000)
121121
- Task\<Result> **Poll**(Submission submission, int delay = 5000, int interval = 2000)
122-
- Task\<SearchResult[]> **Search**(string query, int amount = 100)
122+
- Task\<SearchItem[]> **Search**(string query, int amount = 100, string targetScan = null)
123123
- Task\<SimilarScan[]> **GetSimilarScans**(string uuid)
124124
- Task\<Stats> **GetStats**()
125125
- Task\<Stream> **DownloadScreenshotStream**(string uuid)

Urlscan/Constants.cs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,22 @@ namespace Urlscan
66
{
77
internal class Constants
88
{
9-
/// <summary>
10-
/// The API version to use when communicating.
11-
/// </summary>
129
public const int Version = 1;
13-
10+
public static readonly Uri BaseUri = new("https://urlscan.io/");
1411
public static readonly Version HttpVersion = new(2, 0);
15-
public static readonly TimeSpan Timeout = TimeSpan.FromSeconds(30);
1612

1713
public const string UserAgent = "Urlscan C# Client - actually-akac/Urlscan";
14+
public const string LiveUserAgent = "Urlscan C# Live Client - actually-akac/Urlscan";
15+
16+
public const string AcceptedEncoding = "gzip, deflate, br";
1817
public const string JsonContentType = "application/json";
1918
public const string HtmlContentType = "text/html";
19+
2020
public const int ErrorStatusCode = 500;
21+
public const int MaxPollingRetries = 20;
2122

2223
public const string SuccessSubmissionMessage = "Submission successful";
24+
public const string ZeroSimilarHitsMessage = "0 structurally similar hits on different domains, IPs and ASNs";
2325

2426
public static readonly JsonSerializerOptions JsonOptions = new()
2527
{

Urlscan/Extensions.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
using System;
2+
using System.IO;
23
using System.Linq;
4+
using System.Net.Http;
5+
using System.Threading.Tasks;
36

47
namespace Urlscan
58
{

Urlscan/Live.cs

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ public class LiveClient
2222

2323
private readonly HttpClient Client = new(HttpHandler)
2424
{
25-
BaseAddress = UrlscanClient.BaseUri,
26-
Timeout = Constants.Timeout,
25+
BaseAddress = Constants.BaseUri,
2726
DefaultRequestVersion = Constants.HttpVersion
2827
};
2928

@@ -60,9 +59,9 @@ public LiveClient(int interval = 30000, int size = 100)
6059
Size = size;
6160
Seen = new(Size);
6261

63-
Client.DefaultRequestHeaders.AcceptEncoding.ParseAdd("gzip, deflate, br");
64-
Client.DefaultRequestHeaders.UserAgent.ParseAdd("Urlscan C# Live Client - actually-akac/Urlscan");
65-
Client.DefaultRequestHeaders.Accept.ParseAdd("application/json");
62+
Client.DefaultRequestHeaders.AcceptEncoding.ParseAdd(Constants.AcceptedEncoding);
63+
Client.DefaultRequestHeaders.UserAgent.ParseAdd(Constants.LiveUserAgent);
64+
Client.DefaultRequestHeaders.Accept.ParseAdd(Constants.JsonContentType);
6665

6766
Timer = new()
6867
{
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![](https://raw.githubusercontent.com/actually-akac/Urlscan/master/Urlscan/icon.png)
44

5-
🔎 An async and lightweight C# library for interacting with the Urlscan API.
5+
### 🔎 An async and lightweight C# library for interacting with the Urlscan API.
66

77
## Usage
88
Provides an easy interface for interacting with the Urlscan API.
@@ -115,7 +115,7 @@ await client.AddVerdict(new VerdictParameters()
115115
- Task\<Result> **GetResult**(string uuid)
116116
- Task\<Result> **Poll**(string uuid, int delay = 5000, int interval = 2000)
117117
- Task\<Result> **Poll**(Submission submission, int delay = 5000, int interval = 2000)
118-
- Task\<SearchResult[]> **Search**(string query, int amount = 100)
118+
- Task\<SearchItem[]> **Search**(string query, int amount = 100, string targetScan = null)
119119
- Task\<SimilarScan[]> **GetSimilarScans**(string uuid)
120120
- Task\<Stats> **GetStats**()
121121
- Task\<Stream> **DownloadScreenshotStream**(string uuid)

0 commit comments

Comments
 (0)