Welcome to PyEUPI’s documentation!

PyEUPI is the Python API Client to query the Phishing Initiative service.

It’s used for several purposes, like:

  • Submit phishing URLs

  • Retrieve your submissions

  • Search for content in the URL’s source code

  • Query information about the URL itself

  • Look for an URL qualification

Installation

Available for Python3.8+

From the repository:

pip install -e .

Or via pip:

pip install pyeupi

Getting Started !

Create your account

Before querying the API, you first need to create your Phishing Initiative account.

Get your API key

Once you’ve done that, go to the official API documentation , there you will find your rights and your API auth key.

Default users have a limited account. To ask for more rights, you can go to the contact section .

Start Querying !

from pyeupi import PyEUPI

p = PyEUPI('Your API key')
p.search(content='luxembourg')
p.search_url(tld='lu')
p.search_submissions(country='Luxembourg')

API Reference

Please refer to the official API documentation (or see the pyeupi package) to further information on the functions parameters.

Indices and tables