# /pcpartpicker/builds/search

`POST /api/pcpartpicker/builds/search`

Price: 20 credits

Search the completed PC builds people have published on PCPartPicker. Narrows by build price, publication period, CPU socket, video card chipset, cooler type, case type, whether the CPU is overclocked and whether the build is featured, and orders by date, community rating or price. Returns each build with its code, name, author, cover photo, headline CPU and GPU, total price, upvotes and comment count.

## How to use it

The feed is ordered newest-first unless `sort` says otherwise. Group names and option labels for `filters` and `ranges` come from this feed's own sidebar and are not the ones component categories use — an unknown one is rejected with the valid list. A `total_price` with `price_is_partial` true means the builder left some parts without a price, so it understates the build. Pass a build's `id` to /pcpartpicker/builds for the full component table and the description, or to /pcpartpicker/builds/comments for the discussion.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `region` (string) — PCPartPicker country site, which decides the currency of every price (default: "us"; one of: "au", "at", "be", "ca", "cz", "dk", "fi", "fr", "de", "hu", "ie", "it", "nl", "nz", "no", "pl", "pt", "ro", "sa", "sk", "es", "se", "uk", "us")
- `search` (string, nullable) — Keyword matched against build titles (examples: "gaming", "itx"; minLength: 1)
- `filters` (array, nullable) — Option filters over the build feed, each naming a filter group and the option labels to accept. An unknown group or label is rejected with the list of what the feed publishes
  - `name` (string, required) — Filter group name exactly as the category publishes it (examples: "Manufacturer", "Memory Type", "Chipset"; minLength: 1)
  - `values` (array, required) — Option labels to accept; several labels widen the group, several groups intersect (examples: ["Asus","MSI"]; minItems: 1)
- `ranges` (array, nullable) — Numeric filters over the build feed; Price takes whole currency units of the chosen region
  - `name` (string, required) — Numeric filter group name exactly as the category publishes it (examples: "Price", "Memory", "Boost Clock"; minLength: 1)
  - `minimum` (number, nullable) — Lower bound in the group's own unit; omitted means the group's published minimum
  - `maximum` (number, nullable) — Upper bound in the group's own unit; omitted means the group's published maximum
- `sort` (string, nullable) — Ordering, given as the value or the label the feed publishes (examples: "recent", "-recent", "rating", "price"; minLength: 1)
- `count` (integer, required) — Max number of results to return (min: 1; max: 4800)

## Response

### 200 — Successful Response

- `@type` (string) (default: "PcpartpickerBuildCard")
- `id` (string, required)
- `url` (string, nullable)
- `name` (string, nullable)
- `author` (string, nullable)
- `author_url` (string, nullable)
- `image` (string, nullable)
- `key_parts` (array) (default: [])
- `total_price` (number, nullable)
- `price_is_partial` (boolean, nullable)
- `upvotes` (integer, nullable)
- `comment_count` (integer, nullable)

## Errors

### 422 — Validation Error

A filter group, an option label or a sort value the build feed does not publish

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

The build feed came back without any cards

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.