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

# PitchBook: Patent Search

> Patent Search. PitchBook Patent Search reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Patent Search.

<Info>
  Tool ID: `pitchbook_patent_search`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'pitchbook_patent_search',
  {
    "pbId": "pb_123"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute pitchbook_patent_search --input '{
  "pbId": "pb_123"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "companyId": "company_123",
    "stats": {
      "total": 123,
      "perPage": 123,
      "page": 123
    },
    "items": [
      {
        "patentId": "patent_123",
        "patentTitle": "example",
        "status": "example"
      }
    ]
  }
}
```

Use `deepline tools get pitchbook_patent_search --json` for the latest machine-readable contract.

## Input reference

Retrieves patents matching the specified criteria

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.pbId` | `string` | Yes | — | Company pbId |
| `payload.status` | `string` | No | — | Search for patents by their status specifying Active, Pending and/or Inactive values. Use a comma to separate multiple values |
| `payload.publicationDate` | `string` | No | — | Search for patents published after a certain date using the > operator, patents published before a certain date using the \< operator, and patents published between 2 dates using the ^ operator. Format: YYYY-MM-DD |
| `payload.firstFilingDate` | `string` | No | — | Search for patents first filed after a certain date using the > operator, patents first filed before a certain date using the \< operator, and patents first filed between 2 dates using the ^ operator. Format: YYYY-MM-DD |
| `payload.filingAuthorityLocation` | `string` | No | — | Patents can be found by their filing authority location . Use a comma to separate multiple values |
| `payload.cpcSectionCode` | `string` | No | — | Description: Patents can be found by their CPC Section code . Use a comma to separate multiple values |
| `payload.cpcClassCode` | `string` | No | — | Patents can be found by their CPC Class code . Use a comma to separate multiple values |
| `payload.page` | `string` | No | — | Results are returned so that they can be paged through. Set this parameter to increment the page. If nothing is specified, default value is 1. |
| `payload.perPage` | `string` | No | — | Set how many returned results will be shown on the page (between 1 and 250). If nothing is specified, default value is 25. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves patents matching the specified criteria",
    "properties": {
      "pbId": {
        "type": "string",
        "description": "Company pbId"
      },
      "status": {
        "type": "string",
        "description": "Search for patents by their status specifying Active, Pending and/or Inactive values. Use a comma to separate multiple values"
      },
      "publicationDate": {
        "type": "string",
        "description": "Search for patents published after a certain date using the > operator, patents published before a certain date using the < operator, and patents published between 2 dates using the ^ operator. Format: YYYY-MM-DD"
      },
      "firstFilingDate": {
        "type": "string",
        "description": "Search for patents first filed after a certain date using the > operator, patents first filed before a certain date using the < operator, and patents first filed between 2 dates using the ^ operator. Format: YYYY-MM-DD"
      },
      "filingAuthorityLocation": {
        "type": "string",
        "description": "Patents can be found by their filing authority location . Use a comma to separate multiple values"
      },
      "cpcSectionCode": {
        "type": "string",
        "description": "Description: Patents can be found by their CPC Section code . Use a comma to separate multiple values"
      },
      "cpcClassCode": {
        "type": "string",
        "description": "Patents can be found by their CPC Class code . Use a comma to separate multiple values"
      },
      "page": {
        "type": "string",
        "description": "Results are returned so that they can be paged through. Set this parameter to increment the page. If nothing is specified, default value is 1."
      },
      "perPage": {
        "type": "string",
        "description": "Set how many returned results will be shown on the page (between 1 and 250). If nothing is specified, default value is 25."
      }
    },
    "required": [
      "pbId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.companyId` | `string` | No | — | — |
| `result.data.stats` | `object` | No | — | — |
| `result.data.stats.total` | `integer` | No | — | Format: `int32`. |
| `result.data.stats.perPage` | `integer` | No | — | Format: `int32`. |
| `result.data.stats.page` | `integer` | No | — | Format: `int32`. |
| `result.data.stats.lastPage` | `integer` | No | — | Format: `int32`. |
| `result.data.items` | `array` | No | — | — |
| `result.data.items[].patentId` | `string` | No | — | — |
| `result.data.items[].patentTitle` | `string` | No | — | — |
| `result.data.items[].status` | `string` | No | — | — |
| `result.data.items[].publicationDate` | `string` | No | — | Format: `date`. |
| `result.data.items[].firstFilingDate` | `string` | No | — | Format: `date`. |
| `result.data.items[].expirationDate` | `string \| null` | No | — | Format: `date`. |
| `result.data.items[].filingAuthorityLocation` | `string` | No | — | — |
| `result.data.items[].cpcSection` | `object \| null` | No | — | — |
| `result.data.items[].cpcSection.code` | `string` | No | — | — |
| `result.data.items[].cpcSection.description` | `string` | No | — | — |
| `result.data.items[].cpcClass` | `object \| null` | No | — | — |
| `result.data.items[].cpcClass.code` | `string` | No | — | — |
| `result.data.items[].cpcClass.description` | `string` | No | — | — |
| `result.data.items[].cpcSubclass` | `object \| null` | No | — | — |
| `result.data.items[].cpcSubclass.code` | `string` | No | — | — |
| `result.data.items[].cpcSubclass.description` | `string` | No | — | — |
| `result.meta` | `object` | 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.",
        "properties": {
          "companyId": {
            "type": "string"
          },
          "stats": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "perPage": {
                "type": "integer",
                "format": "int32"
              },
              "page": {
                "type": "integer",
                "format": "int32"
              },
              "lastPage": {
                "type": "integer",
                "format": "int32"
              }
            },
            "additionalProperties": false
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "patentId": {
                  "type": "string"
                },
                "patentTitle": {
                  "type": "string"
                },
                "status": {
                  "type": "string"
                },
                "publicationDate": {
                  "type": "string",
                  "format": "date"
                },
                "firstFilingDate": {
                  "type": "string",
                  "format": "date"
                },
                "expirationDate": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date"
                },
                "filingAuthorityLocation": {
                  "type": "string"
                },
                "cpcSection": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "code": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "cpcClass": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "code": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "cpcSubclass": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "code": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "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

* [PitchBook provider guide](/docs/providers/pitchbook/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


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