> ## 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 News Search

> Search debt market news articles by author, region, asset class, topic, issuer, lender or sponsor. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Search debt market news articles by author, region, asset class, topic, issuer, lender or sponsor.

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

## 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(
  'pitchbook_credit_news_search',
  {
    "authors": "example",
    "regions": "example",
    "assetClasses": "example"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute pitchbook_credit_news_search --input '{
  "authors": "example",
  "regions": "example",
  "assetClasses": "example"
}' --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": {
    "stats": {
      "total": 123,
      "perPage": 123,
      "page": 123
    },
    "items": [
      {
        "articleId": 123,
        "title": "VP of Engineering",
        "authors": [
          {}
        ]
      }
    ]
  }
}
```

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

## Input reference

Retrieves main info about the Credit news articles matching the specified criteria

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.authors` | `string` | No | — | Articles can be found by their authors. Use a comma to separate multiple values. |
| `payload.regions` | `string` | No | — | Search for articles by the regions covered in them. Use a comma to separate multiple values. |
| `payload.assetClasses` | `string` | No | — | Search for articles by the asset classes covered in them. Use a comma to separate multiple values |
| `payload.topics` | `string` | No | — | Articles can be found by their topics . Use a comma to separate multiple values |
| `payload.issuer` | `string` | No | — | Accepts issuer names, pbIds, websites, and tickers. Returns a list of entities that are an exact match. Use a comma to separate multiple values |
| `payload.lender` | `string` | No | — | Accepts lender names, pbIds, websites, and tickers. Returns a list of entities that are an exact match. Use a comma to separate multiple values |
| `payload.sponsor` | `string` | No | — | Accepts sponsor names, pbIds, websites, and tickers. Returns a list of entities that are an exact match. Use a comma to separate multiple values. |
| `payload.sinceDate` | `string` | No | — | Add this parameter to extract news articles 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={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves main info about the Credit news articles matching the specified criteria",
    "properties": {
      "authors": {
        "type": "string",
        "description": "Articles can be found by their authors. Use a comma to separate multiple values."
      },
      "regions": {
        "type": "string",
        "description": "Search for articles by the regions covered in them. Use a comma to separate multiple values."
      },
      "assetClasses": {
        "type": "string",
        "description": "Search for articles by the asset classes covered in them. Use a comma to separate multiple values"
      },
      "topics": {
        "type": "string",
        "description": "Articles can be found by their topics . Use a comma to separate multiple values"
      },
      "issuer": {
        "type": "string",
        "description": "Accepts issuer names, pbIds, websites, and tickers. Returns a list of entities that are an exact match. Use a comma to separate multiple values"
      },
      "lender": {
        "type": "string",
        "description": "Accepts lender names, pbIds, websites, and tickers. Returns a list of entities that are an exact match. Use a comma to separate multiple values"
      },
      "sponsor": {
        "type": "string",
        "description": "Accepts sponsor names, pbIds, websites, and tickers. Returns a list of entities that are an exact match. Use a comma to separate multiple values."
      },
      "sinceDate": {
        "type": "string",
        "description": "Add this parameter to extract news articles 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[].articleId` | `integer` | No | — | Format: `int32`. |
| `result.data.items[].title` | `string` | No | — | — |
| `result.data.items[].authors` | `array` | No | — | — |
| `result.data.items[].authors[].authorName` | `string` | No | — | — |
| `result.data.items[].regions` | `array` | No | — | — |
| `result.data.items[].publishDate` | `string` | No | — | Format: `date-time`. |
| `result.data.items[].assetClasses` | `array` | No | — | — |
| `result.data.items[].topics` | `array` | No | — | — |
| `result.data.items[].issuer` | `object \| null` | No | — | — |
| `result.data.items[].issuer.pbId` | `string` | No | — | — |
| `result.data.items[].issuer.name` | `string` | No | — | — |
| `result.data.items[].lender` | `object \| null` | No | — | — |
| `result.data.items[].lender.pbId` | `string` | No | — | — |
| `result.data.items[].lender.name` | `string` | No | — | — |
| `result.data.items[].sponsor` | `object \| null` | No | — | — |
| `result.data.items[].sponsor.pbId` | `string` | No | — | — |
| `result.data.items[].sponsor.name` | `string` | No | — | — |
| `result.data.items[].deal` | `object \| null` | No | — | — |
| `result.data.items[].deal.dealId` | `string` | No | — | — |
| `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": {
          "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": {
                "articleId": {
                  "type": "integer",
                  "format": "int32"
                },
                "title": {
                  "type": "string"
                },
                "authors": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "authorName": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "regions": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "publishDate": {
                  "type": "string",
                  "format": "date-time"
                },
                "assetClasses": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "topics": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "issuer": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "pbId": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "lender": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "pbId": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "sponsor": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "pbId": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "deal": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "dealId": {
                      "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](https://deepline.com/docs/providers/pitchbook/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.