> ## 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.

# Quickstart

> Jump into Pulsedive’s powerful threat intelligence. This quickstart guide walks you through getting your API key, authenticating your first request, and retrieving data--all in under five minutes. No fluff, all action.

## Before You Begin

To complete this quickstart, you will need:

* **An active Pulsedive account**: [Sign up for free!](https://pulsedive.com/register)
* A simple command-line tool like `curl` or your preferred HTTP client.

<Info>Although you can access our API without an API key, using an API key gives you higher rate limits and smoother access to Pulsedive’s data.
You can [find your API key](https://pulsedive.com/account) in your account dashboard.</Info>

***

## Fetch Indicator Data

Query the [`/indicator.php` endpoint](/api/indicator/overview/) by indicator value. This is one of the most common calls users make.

```bash theme={null}
curl "https://pulsedive.com/api/indicator.php \
  ?indicator=1.1.1.1 \
  &pretty=1 \
  &key=<YOUR_API_KEY>"
```

You'll receive detailed threat intelligence on the indicator, including risk scores, associated threats, and detailed scan data.

***

## Use Explore to Search Across Data

Need to search across multiple indicators? Use the [`/explore.php` endpoint](/api/explore/overview/) with a query string.

```bash theme={null}
curl "https://pulsedive.com/api/explore.php \
  ?q=ioc=*evil* \
  &limit=5 \
  &pretty=1 \
  &key=<YOUR_API_KEY>"
```

This returns up to five results matching your pattern, including filtering options like risk, type, and threat.

To learn more about query syntax, operators, and wildcards, visit [Query Language](/api/explore/query-language/).

***

## Scan and Enrich an Indicator

Want deeper insight? Request enrichment and scoring for an indicator using the [`/analyze.php` endpoint](/api/scan/overview/).

<Steps>
  <Step title="Initiate a scan">
    Request enrichment and scoring for your indicator.
    This tells Pulsedive to gather threat intelligence, generate insights, and perform risk scoring.

    ```bash theme={null}
    # Scan for passive (non-intrusive) analysis
    curl "https://pulsedive.com/api/analyze.php \
      ?value=evil.com \
      &probe=0 \
      &pretty=1 \
      &key=<YOUR_API_KEY>"
    ```

    <Tip>
      Passive scans (`probe=0`) collect data without direct contact (WHOIS, DNS).
      You can also request an active scan (`probe=1`) for comprehensive intelligence, but with noisier, direct contact.
    </Tip>

    <Tip>
      By default, Pulsedive performs enrichment on new indicators without saving the indicator.
      To save it to Pulsedive's database, add `submit=1` to your request.
      Existing indicators are always updated with fresh scan results.
    </Tip>

    You will receive a response like:

    ```json theme={null}
        {
          "success": "Added request to queue.",
          "sid": 2100188,
          "qids": [
            {
              "indicator": "evil.com",
              "qid": 2100254203
            }
          ]
        }
    ```

    Your request is added to the queue immediately, but processing happens asynchronously in the background.
  </Step>

  <Step title="Poll for results">
    Use the returned queue ID (`qid`) to check for results:

    ```bash theme={null}
    curl "https://pulsedive.com/api/analyze.php \
      ?qid=123456 \
      &pretty=1 \
      &key=<YOUR_API_KEY>"
    ```
  </Step>
</Steps>

***

## What's Next?

Once you're authenticated and have your first API responses:

* Dive deeper into indicators: Try [retrieving indicator links or properties](/api/indicator/get-links-properties/) or use the [`historical`](/api/indicator/get-by-value#parameter-historical) and [`schema`](/api/indicator/get-by-value#parameter-schema) parameters to customize your results.
* Explore other endpoints: Fetch [threat](/api/threat/get-by-name/) or [feed](/api/feed/get-by-name-organization/) data to expand your threat intelligence coverage.
* For smoother development, check out [community libraries](/libraries/).