/pcpartpicker/builds

POST /api/pcpartpicker/builds

Price: 5 credits

Fetch one completed PC build published on PCPartPicker: its name, author, publication date, description, photos, upvote and comment counts, the total the builder paid, and every component in it with the price paid and a link to the part.

How to use it

Takes the six-character code from a /b/ URL. `parts` carries the price each component cost at the time the builder saved the build, not today's price — read `part_list_url`'s code through /pcpartpicker/lists for the current per-merchant breakdown, or a part's `product_id` through /pcpartpicker/products. Custom entries the builder typed by hand appear in `parts` with a name but no `product_id`. `details` holds whatever extra rows the builder filled in, such as overclock speeds, and varies from build to build.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• build string required — PCPartPicker completed-build code, or any pcpartpicker.com /b/ URL (examples: "KWPXsY", "https://pcpartpicker.com/b/KWPXsY"; minLength: 1)
• 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")

Response

• @type string (default: "PcpartpickerBuild")
• id string required
• url string required
• name string nullable
• author string nullable
• author_url string nullable
• date_published string nullable
• total_price number nullable
• upvotes integer nullable
• comment_count integer nullable
• part_list_id string nullable
• part_list_url string nullable
• description string nullable
• details object (default: {})
  • * string
• images array (default: [])
• 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 build with that code 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.