> ## 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: Credit Research Search

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

Credit Research Search.

<Info>
  Tool ID: `pitchbook_credit_research_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_credit_research_search',
  {
    "authors": "example",
    "regions": "example",
    "assetClasses": "example"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute pitchbook_credit_research_search --input '{
  "authors": "example",
  "regions": "example",
  "assetClasses": "example"
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "stats": {
      "total": 123,
      "perPage": 123,
      "page": 123
    },
    "items": [
      {
        "reportId": 123,
        "title": "VP of Engineering",
        "description": "Example description"
      }
    ]
  }
}
```

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

## Input reference

Retrieves main info about the Credit Research reports matching the specified criteria

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.authors` | `string` | No | — | Reports can be found by their authors. Use a comma to separate multiple values. |
| `payload.regions` | `string` | No | — | Search for reports by the regions covered in them. Use a comma to separate multiple values. |
| `payload.assetClasses` | `string` | No | — | Search for reports by the asset classes covered in them. Use a comma to separate multiple values. |
| `payload.reportTypes` | `string` | No | — | Reports can be found by their report types . Use a comma to separate multiple values. |
| `payload.marketTypes` | `string` | No | — | Search for reports by the market types covered in them. Use a comma to separate multiple values. |
| `payload.companyNames` | `string` | No | — | Accepts company names, pbIds, websites, and tickers. Returns a list of companies that are an exact match. Use a comma to separate multiple values. |
| `payload.purposes` | `string` | No | — | Search for reports by the purposes covered in them. Use a comma to separate multiple values. |
| `payload.fileTypes` | `string` | No | — | Reports can be found by their file types . Use a comma to separate multiple values. |
| `payload.sinceDate` | `string` | No | — | Add this parameter to extract reports published after a certain date with the > operator, before a certain date with the \< operator and between two dates with the ^ operator. |
| `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 main info about the Credit Research reports matching the specified criteria",
    "properties": {
      "authors": {
        "type": "string",
        "description": "Reports can be found by their authors. Use a comma to separate multiple values."
      },
      "regions": {
        "type": "string",
        "description": "Search for reports by the regions covered in them. Use a comma to separate multiple values."
      },
      "assetClasses": {
        "type": "string",
        "description": "Search for reports by the asset classes covered in them. Use a comma to separate multiple values."
      },
      "reportTypes": {
        "type": "string",
        "description": "Reports can be found by their report types . Use a comma to separate multiple values."
      },
      "marketTypes": {
        "type": "string",
        "description": "Search for reports by the market types covered in them. Use a comma to separate multiple values."
      },
      "companyNames": {
        "type": "string",
        "description": "Accepts company names, pbIds, websites, and tickers. Returns a list of companies that are an exact match. Use a comma to separate multiple values."
      },
      "purposes": {
        "type": "string",
        "description": "Search for reports by the purposes covered in them. Use a comma to separate multiple values."
      },
      "fileTypes": {
        "type": "string",
        "description": "Reports can be found by their file types . Use a comma to separate multiple values."
      },
      "sinceDate": {
        "type": "string",
        "description": "Add this parameter to extract reports published after a certain date with the > operator, before a certain date with the < operator and between two dates with the ^ operator."
      },
      "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": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `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[].reportId` | `integer` | No | — | Format: `int32`. |
| `result.data.items[].title` | `string` | No | — | — |
| `result.data.items[].description` | `string` | No | — | — |
| `result.data.items[].authors` | `array` | No | — | — |
| `result.data.items[].authors[].authorName` | `string` | No | — | — |
| `result.data.items[].regions` | `array` | No | — | — |
| `result.data.items[].assetClasses` | `array` | No | — | — |
| `result.data.items[].publishDate` | `string` | No | — | Format: `date`. |
| `result.data.items[].reportType` | `string` | No | — | — |
| `result.data.items[].companies` | `array` | No | — | — |
| `result.data.items[].companies[].companyId` | `string` | No | — | — |
| `result.data.items[].companies[].companyName` | `string` | No | — | — |
| `result.data.items[].purposes` | `array` | No | — | — |
| `result.data.items[].attachments` | `array` | No | — | — |
| `result.data.items[].attachments[].name` | `string` | No | — | — |
| `result.data.items[].attachments[].type` | `string` | No | — | — |
| `result.data.items[].attachments[].url` | `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": {
          "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": {
                "reportId": {
                  "type": "integer",
                  "format": "int32"
                },
                "title": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "authors": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "authorName": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "regions": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "assetClasses": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "publishDate": {
                  "type": "string",
                  "format": "date"
                },
                "reportType": {
                  "type": "string"
                },
                "companies": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "companyId": {
                        "type": "string"
                      },
                      "companyName": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "purposes": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "attachments": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string"
                      },
                      "url": {
                        "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.