---
title: "Rank buses by what they can take"
method: POST
path: "/api/v1/project-rooms/{id}/files/{fileId}/screen"
tags: ["Projects"]
---

# Rank buses by what they can take

`POST /api/v1/project-rooms/{id}/files/{fileId}/screen`

## Request

- Base URL: `https://askthegrid.com`
- URL: `https://askthegrid.com/api/v1/project-rooms/{id}/files/{fileId}/screen`
- Auth: HTTP bearer

The injection limit at many buses of a planning case at once, highest first, for choosing where to connect. Same basis as `studyProjectNetwork`.

## Path parameters

- `id` string, required
- `fileId` string, required

## Request body

- object
  - `buses` integer[]
  - `minKv` number
  - `nameContains` string
  - `limit` integer
  - `mw` number
  - `direction` 'inject' | 'withdraw'
  - `sink` 'load' | 'swing'
  - `ratingBasis` 'rate-a' | 'monitored'
  - `outages` 'project' | 'single'

## Response `200`

Success

- object
  - `screened` integer, required
  - `buses` object[], required
    - `bus` integer, required
    - `name` string, required
    - `kv` number, required
    - `limitMw` number, nullable, required
    - `baseLimitMw` number, nullable, required
    - `limitingElement` string, nullable, required
    - `contingency` string, nullable, required

## Other responses

- `400`: The request did not match the contract.
- `401`: Missing or invalid credentials.
- `429`: Rate limit exceeded. Wait `Retry-After` seconds; `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` report the budget. Signed-in sessions and API keys have larger budgets than anonymous callers.

---

[API](https://skmtc.dev/askthegrid/apis/ask-the-grid-api.md) · [All operations](https://skmtc.dev/askthegrid/apis/ask-the-grid-api/llms.txt) · [OpenAPI document](https://skmtc.dev/askthegrid/apis/ask-the-grid-api/revisions/9cd80115e395?raw)