/pcpartpicker/lists

POST /api/pcpartpicker/lists

Price: 10 credits

Fetch one saved PCPartPicker part list with today's full price breakdown: every component with the cheapest merchant, base price, promo, shipping, tax, stock state and final price, plus the list total, the estimated system wattage and any compatibility warnings PCPartPicker raises for the combination.

How to use it

Prices here are live, unlike the frozen prices a completed build records, so this is the right call for 'what would this configuration cost now'. A component nobody currently stocks appears in `parts` with a name but no `price` and no `merchant`, and the list total then covers only the parts that are buyable. `notes` carries PCPartPicker's own compatibility reasoning, including info-level remarks that are not problems. Take the list code for a completed build from that build's `part_list_id` and never from the build code itself: list codes and build codes are separate spaces that collide, so a build code passed here can resolve to an unrelated stranger's list under a 200.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• part_list string required — PCPartPicker part-list code, or any pcpartpicker.com /list/ URL (examples: "8XhmFP", "https://pcpartpicker.com/list/8XhmFP"; minLength: 1)
• region string — PCPartPicker country site, which decides the merchants and 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")

Response

• @type string (default: "PcpartpickerPartList")
• id string required
• url string required
• name string nullable
• total_price number nullable
• estimated_wattage integer nullable
• compatibility string nullable
• notes array (default: [])
  • @type string (default: "PcpartpickerCompatibilityNote")
  • severity string required
  • text string required
• parts array (default: [])
  • @type string (default: "PcpartpickerPart")
  • component string nullable
  • product_id string nullable
  • name string nullable
  • url string nullable
  • image string nullable
  • base_price number nullable
  • promo string nullable
  • shipping string nullable
  • tax string nullable
  • availability string nullable
  • price number nullable
  • merchant string nullable
  • merchant_url string 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 — No part list with that code, or the list holds no components 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.