PhishReport 1.1.0

Phish.Report 🎣

An async C# library for interacting with the Phish.Report, Indicator of Kit and detection beta APIs.

Warning The Phish.Report API is still under development, so in the event that you start experiencing unexpected errors, first check if there's an update available or raise an issue in this repository.

Usage

Available on NuGet as PhishReport, methods can be found under the class PhishReportClient.

You can create your API key here: https://phish.report/user

https://www.nuget.org/packages/PhishReport

Features

• Made with .NET 6
• Fully async
• Full coverage of the current beta API
• Deep documentation
• No external dependencies (uses integrated HTTP and JSON)
• Create phishing takedowns, fetch existing cases or process Indicator of Kit matches.
• Custom exceptions (PhishReportException) for advanced catching
• Automatic request retries
• Example project to demonstrate all capabilities of the library

Example

Under the Example directory you can find a working demo project that implements this library.

Code Samples

Initializing a new API client

PhishReportClient phish = new("API KEY");

Creating a new phishing takedown

PhishingTakedown takedown1 = await phish.CreateTakedown("https://seowqpeoqwakfd425.ml/dssdfds-fsdfsdf0s-df0ds0f0dsdfsdd0f0s-df0dfgdd8658/");

Retrieving an existing phishing takedown by its ID

PhishingTakedown takedown2 = await phish.GetTakedown("case_4tmKtcajnzj");

Retrieving the latest Indicator of Kit matches

IoKMatch[] matches = await phish.GetIoKMatches();

Processing Indicator of Kit matches in real time

phish.IoKMatched += (sender, match) =>
{
    Console.WriteLine($"{match.Url} just matched {match.IndicatorId}");
};

Available Methods

• Task<PhishingTakedown> CreateTakedown(string url)
• Task<PhishingTakedown> GetTakedown(string id)
• Task<IoKMatch[]> GetIoKMatches(int page = 0)

Available Events

• EventHandler<IoKMatch> IoKMatched

Resources

Website: https://phish.report

Indicator of Kit: https://phish.report/IOK/, https://github.com/phish-report/IOK