/ifixit/stories

POST /api/ifixit/stories

Price: 1 credit

Get one iFixit community repair story with its full text, photos, guides and parts used

How to use it

A repair story is a member's write-up of a repair they finished — first-person outcome, not instructions. Use this when you already hold a story id or URL; use the story search to find one by device, guide or part. Both a raw and an HTML rendering of every text block come back, so pick one rather than concatenating them.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• story string required — Story id, or the URL of a story page (examples: "1", "https://www.ifixit.com/Story/1"; minLength: 1)

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 — No story exists with that id. 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.