Gene Library Courses Download Pricing Contact Sign in
Gene Library
GENE-WEBAMON How-To

Getting Started with GENE-WebAmon

Getting Started with GENE-WebAmon

The GENE-WebAmon tool provides both free and professional-grade features for threat intelligence. This guide explains how to use both.

Free Tier Usage (No API Key)

The scan and screenshot operations are available without any configuration. You can use them immediately to assess domains.

  • Operation: scan

    • Description: Scans a domain for threats.
    • Parameters: domain (the domain to scan).

  • Operation: screenshot

    • Description: Takes a screenshot of a domain's homepage.
    • Parameters: domain (the domain to capture), output_path (where to save the PNG file).

Professional Tier Usage (API Key Required)

To use the search, takedown, and credits operations, you must have a Professional tier API key from Webamon.

1. Obtain an API Key

Subscribe to the Professional tier on the Webamon website to receive your API key.

2. Configure the Feluda Secret

The gene securely retrieves your API key from the Feluda secrets manager. You must create a secret with the exact name:

  • Secret Name: webamon-api-key
  • Secret Value: YOUR_WEBAMON_API_KEY

3. Use the Pro-Tier Operations

Once the secret is configured, you can use the professional-grade operations.

  • Operation: search

    • Description: Searches the Webamon database. Uses the Pro endpoint if a key is configured.
    • Parameters: query (the search term).

  • Operation: takedown

    • Description: Sends a takedown request for a malicious domain.
    • Parameters: domain (the domain to take down).

  • Operation: credits

    • Description: Checks your remaining API credits.
    • Parameters: None.

Frequently Asked Questions

Which operations require an API key?
The 'takedown' and 'credits' operations require a Pro tier API key. The 'search' operation will use the key if available, but can also work on the free tier.
Where do I get a Webamon API key?
You can get an API key by subscribing to the Professional tier on the Webamon website.
How do I store the API key in Feluda?
You must create a new secret in your Feluda project with the exact name 'webamon-api-key' and paste your key as the value.
Is the API key required to use the gene?
No. The 'scan' and 'screenshot' operations work on the free tier without any key.
How do I know if my API key is working?
You can use the 'credits' operation. If it returns your current credit balance, your key is configured correctly.