> ## 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: Get Batch Credit News

> [Bulk] Credit News. PitchBook Get Batch Credit News reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

\[Bulk] Credit News.

<Info>
  Tool ID: `pitchbook_get_batch_credit_news`
</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_get_batch_credit_news',
  {
    "items": [
      {
        "articleId": 123
      }
    ]
  },
);

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

### CLI

```bash theme={null}
deepline tools execute pitchbook_get_batch_credit_news --input '{
  "items": [
    {
      "articleId": 123
    }
  ]
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "stats": {
      "total": 123,
      "found": 123,
      "notFound": 123
    },
    "found": [
      {
        "articleId": 123,
        "title": "VP of Engineering",
        "authors": [
          {}
        ]
      }
    ],
    "notFound": [
      123
    ]
  }
}
```

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

## Input reference

Returns whole information about the specified Credit News articles. This bulk call allows you to send multiple articleIds within a single API call

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.items` | `array` | Yes | — | Credit News article IDs to retrieve in this bulk request. Minimum items: 1. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Returns whole information about the specified Credit News articles. This bulk call allows you to send multiple articleIds within a single API call",
    "properties": {
      "items": {
        "type": "array",
        "description": "Credit News article IDs to retrieve in this bulk request.",
        "minItems": 1,
        "items": {
          "type": "object",
          "properties": {
            "articleId": {
              "type": "integer",
              "format": "int32"
            }
          },
          "required": [
            "articleId"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "items"
    ],
    "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.found` | `integer` | No | — | Format: `int32`. |
| `result.data.stats.notFound` | `integer` | No | — | Format: `int32`. |
| `result.data.stats.duplicates` | `integer` | No | — | Format: `int32`. |
| `result.data.found` | `array` | No | — | — |
| `result.data.found[].articleId` | `integer` | No | — | Format: `int32`. |
| `result.data.found[].title` | `string` | No | — | — |
| `result.data.found[].authors` | `array` | No | — | — |
| `result.data.found[].authors[].authorName` | `string` | No | — | — |
| `result.data.found[].regions` | `array` | No | — | — |
| `result.data.found[].publishDate` | `string` | No | — | Format: `date-time`. |
| `result.data.found[].assetClasses` | `array` | No | — | — |
| `result.data.found[].topics` | `array` | No | — | — |
| `result.data.found[].issuer` | `object \| null` | No | — | — |
| `result.data.found[].issuer.pbId` | `string` | No | — | — |
| `result.data.found[].issuer.name` | `string` | No | — | — |
| `result.data.found[].lender` | `object \| null` | No | — | — |
| `result.data.found[].lender.pbId` | `string` | No | — | — |
| `result.data.found[].lender.name` | `string` | No | — | — |
| `result.data.found[].sponsor` | `object \| null` | No | — | — |
| `result.data.found[].sponsor.pbId` | `string` | No | — | — |
| `result.data.found[].sponsor.name` | `string` | No | — | — |
| `result.data.found[].articleBody` | `string` | No | — | — |
| `result.data.found[].attachments` | `array` | No | — | — |
| `result.data.found[].attachments[].name` | `string` | No | — | — |
| `result.data.found[].attachments[].url` | `string` | No | — | — |
| `result.data.found[].deal` | `object \| null` | No | — | — |
| `result.data.found[].deal.dealId` | `string` | No | — | — |
| `result.data.notFound` | `array` | No | — | — |
| `result.data.duplicates` | `array` | No | — | — |
| `result.data.duplicates[].articleId` | `integer` | No | — | Format: `int32`. |
| `result.data.duplicates[].occurrence` | `integer` | No | — | Format: `int32`. |
| `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"
              },
              "found": {
                "type": "integer",
                "format": "int32"
              },
              "notFound": {
                "type": "integer",
                "format": "int32"
              },
              "duplicates": {
                "type": "integer",
                "format": "int32"
              }
            },
            "additionalProperties": false
          },
          "found": {
            "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
                },
                "articleBody": {
                  "type": "string"
                },
                "attachments": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "url": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "deal": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "dealId": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "additionalProperties": false
            }
          },
          "notFound": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            }
          },
          "duplicates": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "articleId": {
                  "type": "integer",
                  "format": "int32"
                },
                "occurrence": {
                  "type": "integer",
                  "format": "int32"
                }
              },
              "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.