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

# Dealroom.co: Dealroom Lookup Locations

> Look up location IDs by place name for use in company, investor and founder search filters. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Look up location IDs by place name for use in company, investor and founder search filters.

> [!NOTE]
>
> Tool ID: `dealroom_lookup_locations`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'dealroom_lookup_locations',
  {
    "keyword": "software companies hiring engineers",
    "limit": 10,
    "keyword_type": "locations_name"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute dealroom_lookup_locations --input '{
  "keyword": "software companies hiring engineers",
  "limit": 10,
  "keyword_type": "locations_name"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "items": [
      {
        "id": 123,
        "name": "Example",
        "type": "continent"
      }
    ]
  }
}
```

Use `deepline describe dealroom_lookup_locations --json` for the latest machine-readable contract.

## Input reference

Search locations by name, type and parent using elasticsearch.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.keyword` | `string` | No | — | — |
| `payload.limit` | `integer` | No | `10` | Allows you to set the limit of items in the response. The default of the field is **10** and the maximum is **100** items per response |
| `payload.keyword_type` | `"locations_name"` | No | `"locations_name"` | `locations_name` keyword type matches along name and aliases. Allowed: `locations_name`. |
| `payload.keyword_match_type` | `"fuzzy"` | No | `"fuzzy"` | Allowed: `fuzzy`. |
| `payload.types` | `array` | No | — | Location types. |
| `payload.parent` | `string` | No | — | Parent location. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Search locations by name, type and parent using elasticsearch.",
    "properties": {
      "keyword": {
        "type": "string"
      },
      "limit": {
        "type": "integer",
        "description": "Allows you to set the limit of items in the response. The default of the field is **10** and the maximum is **100** items per response",
        "default": 10
      },
      "keyword_type": {
        "type": "string",
        "description": "`locations_name` keyword type matches along name and aliases.",
        "default": "locations_name",
        "enum": [
          "locations_name"
        ]
      },
      "keyword_match_type": {
        "type": "string",
        "default": "fuzzy",
        "enum": [
          "fuzzy"
        ]
      },
      "types": {
        "type": "array",
        "description": "Location types.",
        "items": {
          "type": "string",
          "enum": [
            "continent",
            "country",
            "city",
            "state"
          ]
        }
      },
      "parent": {
        "type": "string",
        "description": "Parent location."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.items` | `array` | No | — | — |
| `result.data.items[].id` | `integer` | No | — | — |
| `result.data.items[].name` | `string` | No | — | — |
| `result.data.items[].type` | `"continent" \| "country" \| "state" \| "city"` | No | — | Allowed: `continent`, `country`, `state`, `city`. |
| `result.data.items[].parents` | `array` | No | — | — |
| `result.data.items[].parents[].id` | `integer` | No | — | — |
| `result.data.items[].parents[].name` | `string` | No | — | — |
| `result.data.items[].parents[].type` | `"continent" \| "country" \| "state" \| "city"` | No | — | Allowed: `continent`, `country`, `state`, `city`. |
| `result.data.items[].parents[].parents` | `array \| null` | No | — | — |
| `result.data.items[].parents[].parents[].id` | `integer` | No | — | — |
| `result.data.items[].parents[].parents[].name` | `string` | No | — | — |
| `result.data.items[].parents[].parents[].type` | `"continent" \| "country" \| "state" \| "city"` | No | — | Allowed: `continent`, `country`, `state`, `city`. |
| `result.data.items[].usage` | `integer` | No | — | Number of times this location has been used |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "continent",
                    "country",
                    "state",
                    "city"
                  ]
                },
                "parents": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer"
                      },
                      "name": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "continent",
                          "country",
                          "state",
                          "city"
                        ]
                      },
                      "parents": {
                        "type": [
                          "array",
                          "null"
                        ],
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "integer"
                            },
                            "name": {
                              "type": "string"
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "continent",
                                "country",
                                "state",
                                "city"
                              ]
                            }
                          },
                          "additionalProperties": false
                        }
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "usage": {
                  "type": "integer",
                  "description": "Number of times this location has been used"
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Dealroom.co provider guide](https://deepline.com/docs/providers/dealroom/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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