/ifixit/stories/search

POST /api/ifixit/stories/search

Price: 10 credits

List iFixit community repair stories, filtered by guide, part or language

How to use it

Repair outcomes rather than repair instructions: what members report after using a guide or a part, which is the closest thing iFixit has to a review of a procedure. There is no free-text query here — narrow by guide, by product, or by language, or read the archive in date order. guide takes the same id forms the guides endpoint accepts. product takes a part number or product code, not the handle the products endpoint takes. only_with_images is the way to get stories with photographic evidence; leaving it off returns everything, photos or not.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of results (min: 1; max: 5000)
• language string — Which language edition of the story archive to read (default: "en"; one of: "en", "de", "es", "fr", "it", "jp", "ko", "nl", "pt", "ru", "tr", "zh")
• sort string — Order stories are returned in (default: "newest_first"; one of: "oldest_first", "newest_first")
• guide string nullable — Only stories written against this guide, given as a guide id or a guide URL (examples: "1")
• product string nullable — Only stories that used this store product, given as its part number or product code (examples: "IF145-307", "145307")
• only_with_images boolean — Keep only stories that carry photos of the repair (default: false)

Response

• @type string (default: "IfixitStory")
• id string required
• name string required
• name_html string nullable
• url string nullable
• intro string nullable
• intro_html string nullable
• text string nullable
• text_html string nullable
• conclusion string nullable
• conclusion_html string nullable
• language string nullable
• status string nullable
• rating number nullable
• created_at integer nullable
• modified_at integer nullable
• author object nullable
  • @type string (default: "IfixitAuthor")
  • id string required
  • name string nullable
  • alias string nullable
  • url string nullable
  • image string nullable
  • reputation integer nullable
  • joined_at integer nullable
  • contribution_percent number nullable
  • team_ids array (default: [])
• images array (default: [])
• guides array (default: [])
  • @type string (default: "IfixitGuidePreview")
  • id string required
  • name string nullable
  • url string nullable
  • summary string nullable
  • subject string nullable
  • category string nullable
  • guide_type string nullable
  • difficulty string nullable
  • time_required_max integer nullable
  • locale string nullable
  • is_public boolean nullable
  • image string nullable
  • flags array (default: [])
  • author_id string nullable
  • author_name string nullable
  • modified_at integer nullable
  • revision_id string nullable
• products array (default: [])
  • @type string (default: "IfixitStoryProduct")
  • name string required
  • text string nullable
  • url string nullable
  • price number nullable
  • product_code string nullable
  • option_id string nullable
  • option_name string nullable
  • item_code string nullable
  • language string nullable
  • image 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 — 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.