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

# Hunter Discover: Inputs, Cost & CLI Example

> Create broad, high-recall account lists with natural-language ICP filters before spending credits. Includes inputs, outputs, costs, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=hunter_discover:{}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                            | Type      | Required | Default | Description                                                                                    |
| ------------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------- |
| `payload.query`                 | `string`  | No       |         | Natural-language company search query. Prefer this for broad ICP discovery.                    |
| `payload.organization`          | `object`  | No       |         |                                                                                                |
| `payload.similar_to`            | `object`  | No       |         |                                                                                                |
| `payload.headquarters_location` | `object`  | No       |         |                                                                                                |
| `payload.industry`              | `object`  | No       |         | Filter with optional include/exclude arrays.                                                   |
| `payload.headcount`             | `array`   | No       |         | Accepted values include 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+. |
| `payload.company_type`          | `object`  | No       |         | Filter with optional include/exclude arrays.                                                   |
| `payload.keywords`              | `object`  | No       |         |                                                                                                |
| `payload.technology`            | `object`  | No       |         |                                                                                                |
| `payload.limit`                 | `integer` | No       |         | Max domains returned (default 100). Changing this requires a Hunter Premium plan.              |
| `payload.offset`                | `integer` | No       |         | Number of domains to skip for pagination. Non-zero offsets require a Hunter Premium plan.      |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Discover companies matching ICP criteria. This call is free in Hunter.",
    "properties": {
      "query": {
        "type": "string",
        "description": "Natural-language company search query. Prefer this for broad ICP discovery."
      },
      "organization": {
        "type": "object",
        "properties": {
          "domain": {
            "type": "array",
            "description": "Exact domains to include.",
            "items": {
              "type": "string"
            }
          },
          "name": {
            "type": "array",
            "description": "Company names to include.",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "similar_to": {
        "type": "object",
        "properties": {
          "domain": {
            "type": "string",
            "description": "Reference domain for similar companies."
          },
          "name": {
            "type": "string",
            "description": "Reference company name for similar companies."
          }
        },
        "additionalProperties": false
      },
      "headquarters_location": {
        "type": "object",
        "properties": {
          "include": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "continent": {
                  "type": "string",
                  "description": "Continent name (for example Europe, North America).",
                  "enum": [
                    "Europe",
                    "Asia",
                    "North America",
                    "Africa",
                    "Antarctica",
                    "South America",
                    "Oceania"
                  ]
                },
                "business_region": {
                  "type": "string",
                  "description": "Business region (AMER, EMEA, APAC, LATAM).",
                  "enum": [
                    "AMER",
                    "EMEA",
                    "APAC",
                    "LATAM"
                  ]
                },
                "country": {
                  "type": "string",
                  "description": "ISO 3166-1 alpha-2 country code (for example US)."
                },
                "state": {
                  "type": "string",
                  "description": "US state code (for example CA). Requires country=US."
                },
                "city": {
                  "type": "string",
                  "description": "City name (for example San Francisco)."
                }
              },
              "additionalProperties": false
            }
          },
          "exclude": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "continent": {
                  "type": "string",
                  "description": "Continent name (for example Europe, North America).",
                  "enum": [
                    "Europe",
                    "Asia",
                    "North America",
                    "Africa",
                    "Antarctica",
                    "South America",
                    "Oceania"
                  ]
                },
                "business_region": {
                  "type": "string",
                  "description": "Business region (AMER, EMEA, APAC, LATAM).",
                  "enum": [
                    "AMER",
                    "EMEA",
                    "APAC",
                    "LATAM"
                  ]
                },
                "country": {
                  "type": "string",
                  "description": "ISO 3166-1 alpha-2 country code (for example US)."
                },
                "state": {
                  "type": "string",
                  "description": "US state code (for example CA). Requires country=US."
                },
                "city": {
                  "type": "string",
                  "description": "City name (for example San Francisco)."
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "industry": {
        "type": "object",
        "description": "Filter with optional include/exclude arrays.",
        "properties": {
          "include": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "exclude": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "headcount": {
        "type": "array",
        "description": "Accepted values include 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+.",
        "items": {
          "type": "string",
          "enum": [
            "1-10",
            "11-50",
            "51-200",
            "201-500",
            "501-1000",
            "1001-5000",
            "5001-10000",
            "10001+"
          ]
        }
      },
      "company_type": {
        "type": "object",
        "description": "Filter with optional include/exclude arrays.",
        "properties": {
          "include": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "educational",
                "educational institution",
                "government agency",
                "non profit",
                "partnership",
                "privately held",
                "public company",
                "self employed",
                "self owned",
                "sole proprietorship"
              ]
            }
          },
          "exclude": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "educational",
                "educational institution",
                "government agency",
                "non profit",
                "partnership",
                "privately held",
                "public company",
                "self employed",
                "self owned",
                "sole proprietorship"
              ]
            }
          }
        },
        "additionalProperties": false
      },
      "keywords": {
        "type": "object",
        "properties": {
          "include": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "exclude": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "match": {
            "type": "string",
            "enum": [
              "all",
              "any"
            ]
          }
        },
        "additionalProperties": false
      },
      "technology": {
        "type": "object",
        "properties": {
          "include": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "exclude": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "match": {
            "type": "string",
            "enum": [
              "all",
              "any"
            ]
          }
        },
        "additionalProperties": false
      },
      "limit": {
        "type": "integer",
        "description": "Max domains returned (default 100). Changing this requires a Hunter Premium plan."
      },
      "offset": {
        "type": "integer",
        "description": "Number of domains to skip for pagination. Non-zero offsets require a Hunter Premium plan."
      }
    },
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `record` | Yes      |         | Provider response payload.                     |
| `result.meta` | `record` | No       |         | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "additionalProperties": {}
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute hunter_discover --payload '{}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.
