> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pulsedive.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Integrate with Harpoon

> Query Pulsedive indicators and threats from the command line with the community Harpoon tool.

[Harpoon](https://github.com/Te-k/harpoon) is an open source command-line tool for OSINT and threat intelligence research.
Its `pulsedive` command queries the Pulsedive API, so you can look up an indicator, its links and properties, or a threat without leaving your terminal.

## Prerequisites

Before you connect Harpoon to Pulsedive, make sure you have:

* A Pulsedive account and API key.
  Find your API key on your [Pulsedive account page](https://pulsedive.com/account).
* Python 3 and `pip`.
* The build libraries that Harpoon's `lxml` dependency needs.
  On Debian or Ubuntu, install `libxml2-dev`, `libxslt-dev`, and `python3-dev`.

## Installing Harpoon

Install Harpoon first so that the `harpoon` command is available.

1. Install Harpoon from PyPI:

   ```bash theme={null}
   pip install harpoon
   ```

2. Run `harpoon update` to download the files that some Harpoon commands need.

For other installation options, visit the [Harpoon README in GitHub](https://github.com/Te-k/harpoon).

## Connecting Harpoon to Pulsedive

Harpoon stores your API key in its configuration so that the `pulsedive` command can authenticate.

1. Run the configuration command:

   ```bash theme={null}
   harpoon config
   ```

2. Enter your Pulsedive API key when Harpoon prompts for the **PulseDive** key.

## Verifying the Connection

Confirm that Harpoon recognizes your key before you run queries.

1. Run `harpoon config -c` and confirm that Pulsedive appears among the configured plugins.

2. Run a lookup (for example, `harpoon pulsedive indicator example.com`) and confirm that Harpoon prints JSON.

## Using Pulsedive Data in Harpoon

The `pulsedive` command returns Pulsedive data as JSON, so you can read it directly or pass it to other tools.

| Command | Returned Data |
| - | - |
| `harpoon pulsedive indicator <IOC>` | Information about an indicator. Add `--history` (or `-H`) to include historical data. |
| `harpoon pulsedive links <IOC>` | Links between the indicator and other indicators. |
| `harpoon pulsedive properties <IOC>` | Properties of the indicator. |
| `harpoon pulsedive threat <THREAT>` | Information about a threat, such as `zeus`. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.