/pcpartpicker/products/filters

POST /api/pcpartpicker/products/filters

Price: 10 credits

List the filter groups a PCPartPicker category publishes: every option group with its selectable labels, every numeric group with its unit and the lowest and highest values currently in the catalogue, and the orderings the category offers.

How to use it

Read this before filtering a category with /pcpartpicker/products/search: the group names and option labels are category-specific, so what CPUs call Socket and Core Family has no counterpart under video cards. A group with `kind` values goes into that endpoint's `filters` by `name` plus the option `label`; a group with `kind` range goes into `ranges` by `name` with bounds in the `unit` shown here, where the literal unit `currency` means whole units of the region's money and an absent unit means a plain count; the group named Sort lists what `sort` accepts. A category can publish more than one group under the same `name` and `kind`, such as two option groups both named Color; pass the option `label` and the search endpoint resolves it against whichever of those groups actually offers it, so every label listed here is usable. Combining labels that only exist in different such duplicate groups is rejected with a 422 naming both groups' options, since duplicates can describe genuinely different things, such as a Power Supply group of model names versus one of Yes/No. `is_common` marks the options PCPartPicker shows without expanding the group — the rest are equally valid.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category string required — Component category whose filter groups to read (one of: "cpu", "cpu-cooler", "motherboard", "memory", "internal-hard-drive", "video-card", "power-supply", "case", "headphones", "keyboard", "mouse", "speakers", "webcam", "monitor", "os", "sound-card", "wired-network-card", "wireless-network-card", "case-fan", "fan-controller", "thermal-paste", "external-hard-drive", "optical-drive", "ups")
• region string — PCPartPicker country site, which decides the currency of the Price bounds (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")
• count integer required — Max number of filter groups to return (min: 1)

Response

• @type string (default: "PcpartpickerFilterGroup")
• name string required
• category string nullable
• kind string required
• unit string nullable
• options array (default: [])
  • @type string (default: "PcpartpickerFilterOption")
  • label string required
  • is_common boolean nullable
• minimum number nullable
• maximum number nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit 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 entity was not found, or a precondition failed 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 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 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 Wait at least 30 seconds, then retry.

Response 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.