---
title: "Screen providers by deployment resource requirements"
method: POST
path: "/v1/bid-screening"
tags: ["Bid Screening"]
---

# Screen providers by deployment resource requirements

`POST /v1/bid-screening`

## Request body

- object
  - `requirements` object
    - `signedBy` object
      - `allOf` string[]
      - `anyOf` string[]
    - `attributes` object[]
      - `key` string, required — Attribute key
      - `value` string, required — Attribute value
  - `resources` object[], required — Resource units with replica counts
    - `resource` object, required
      - `id` integer, required — Resource unit ID
      - `cpu` object, required
        - `units` object, required
          - `val` string, required
        - `attributes` object[]
          - `key` string, required — Attribute key
          - `value` string, required — Attribute value
      - `memory` object, required
        - `quantity` object, required
          - `val` string, required
        - `attributes` object[]
          - `key` string, required — Attribute key
          - `value` string, required — Attribute value
      - `gpu` object, required
        - `units` object, required
          - `val` string, required
        - `attributes` object[]
          - `key` string, required — Attribute key
          - `value` string, required — Attribute value
      - `storage` object[], required
        - `name` string, required — Storage volume name
        - `quantity` object, required
          - `val` string, required
        - `attributes` object[]
          - `key` string, required — Attribute key
          - `value` string, required — Attribute value
      - `endpoints` unknown[]
        - unknown
    - `count` integer, required — Replica count
    - `price` object, required
      - `denom` string, required
      - `amount` string, required
  - `timezone` string, required — Client IANA timezone, validated against zones the runtime recognizes
  - `reclamationWindow` integer — Optional reclamation window in seconds; if provided, only providers with a reclamationWindow greater than or equal to this value will be considered

## Response `200`

Returns matching providers

- object
  - `providers` object[], required
    - `owner` string, required — Provider address
    - `hostUri` string, required — Provider HTTPS endpoint
    - `isAudited` boolean, required — True if signed by a known auditor
    - `createdAt` string, date-time, required — ISO 8601 timestamp marking when the provider was first enrolled in the inventory
    - `location` string, nullable, required — Provider region from the location-region attribute (signed preferred, else self-declared); null if unset
    - `organization` string, nullable, required — Provider organization from the organization attribute (signed preferred, else self-declared); null if unset
    - `incidents` object[], required — Per-day downtime over a rolling 7-day window
      - `date` string, required — Local calendar day, YYYY-MM-DD
      - `hasOpenIncident` boolean, required — True if the provider currently has any open incident
      - `incidentCount` integer, required — Number of incident intervals overlapping that day
      - `downtimeSeconds` integer, required — Downtime clipped to that day, in seconds (max 86400)

## Other responses

- `400` — Invalid request body

## Changes

- **2026-06-26** `be2e5614d754` — 1 info
  - added the new optional request property `reclamationWindow`
- **2026-06-17** `d674858723bd` — 1 info
  - added the required property `providers/items/organization` to the response with the `200` status
- **2026-06-17** `b1975c50c4ba` — 1 breaking, 1 warning, 1 info
  - added the new required request property `timezone`
  - removed the request property `name`
  - added the required property `providers/items/incidents` to the response with the `200` status
- **2026-06-15** `cfe3a8cb9b18` — 2 info
  - api operation id `screenProviders` was added
  - added the required property `providers/items/location` to the response with the `200` status
- **2026-06-09** `a4648ee6a8c5` — 2 breaking, 1 info
  - removed the required property `providers/items/region` from the response with the `200` status
  - removed the required property `providers/items/uptime7d` from the response with the `200` status
  - added the required property `providers/items/createdAt` to the response with the `200` status

[Full history](https://skmtc.dev/akash-network/apis/akash-network-console-api/changes/v1/bid-screening/post.md)

---

[API](https://skmtc.dev/akash-network/apis/akash-network-console-api.md) · [All operations](https://skmtc.dev/akash-network/apis/akash-network-console-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/akash-network/akash-network-console-api/revisions/77a0df47eb74/schema)
