PhishReport 1.2.0

.NET 6.0
dotnet add package PhishReport --version 1.2.0
NuGet\Install-Package PhishReport -Version 1.2.0
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="PhishReport" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PhishReport --version 1.2.0
#r "nuget: PhishReport, 1.2.0"
#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 PhishReport as a Cake Addin
#addin nuget:?package=PhishReport&version=1.2.0

// Install PhishReport as a Cake Tool
#tool nuget:?package=PhishReport&version=1.2.0

Phish.Report 🎣

alternate text is missing from this package README image

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


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.


Provides an easy interface for interacting with the Phish.Report APIs.

You can create and track phishing takedowns and work with the Indicator of Kit (IOK) platform.

API keys are required to use the API. Create one at:

To get started, add the library into your solution with either the NuGet Package Manager or the dotnet CLI.

dotnet add package PhishReport

For the primary classes to become available, import the used namespace.

using PhishReport;

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


  • Built for .NET 6 and .NET 7
  • Fully async
  • Coverage of the current beta API
  • Extensive XML 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

Code Samples

Initializing a new API client

PhishReportClient phish = new("API KEY");

Creating a new phishing takedown

PhishingTakedown takedown1 = await phish.CreateTakedown("");

Retrieving an existing phishing takedown by its ID

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

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.IndicatorId} match on {match.Url}, source:{match.UrlscanUUID}/");

Available Methods

  • Task<PhishingTakedown> CreateTakedown(string url)
  • Task<PhishingTakedown> GetTakedown(string id)
  • Task<IokMatch[]> GetIokMatches(int page = 1)
  • Task<string[]> GetIokMatches(string uuid)

Available Events

  • EventHandler<IokMatch> IokMatched


Product 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 is compatible.  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. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.
  • net7.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.

Version Downloads Last updated
1.2.0 210 12/9/2022
1.1.1 225 12/3/2022
1.1.0 304 10/8/2022
1.0.0 311 10/4/2022