/ifixit/devices/troubleshooting

POST /api/ifixit/devices/troubleshooting

Price: 1 credit

Get the symptom index for one device: its documented problems and community answers

How to use it

Start here when the user describes a symptom rather than a repair: this maps one device to the problems iFixit has written up for it, each with the id the troubleshooting endpoint takes for the full diagnosis. The device name is exact, spaces and underscores interchangeable, and a device page URL works. answers are community question threads, which are links out to the site rather than text you get back here. Many devices have no write-ups at all and answer 412, so treat a miss as 'nothing documented' rather than as a bad name.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• device string required — Device name as iFixit writes it, or the URL of a device page (examples: "iPhone 13", "Nintendo_Switch", "https://www.ifixit.com/Device/Steam_Deck"; minLength: 1)

Response

• @type string (default: "IfixitDeviceTroubleshooting")
• id string required
• device_name string required
• url string nullable
• guides_url string nullable
• troubleshooting_url string nullable
• parts_url string nullable
• answers_url string nullable
• answer_count integer nullable
• direct_problem_count integer nullable
• view_count integer nullable
• view_count_today integer nullable
• view_count_week integer nullable
• view_count_month integer nullable
• breadcrumbs array (default: [])
  • @type string (default: "IfixitBreadcrumb")
  • name string required
  • url string nullable
• problems array (default: [])
  • @type string (default: "IfixitDeviceProblem")
  • id string required
  • name string required
  • url string nullable
  • description string nullable
  • device_name string nullable
  • image string nullable
  • thumbnail string nullable
  • device_thumbnail string nullable
  • icon string nullable
  • badges array (default: [])
• answers array (default: [])
  • @type string (default: "IfixitDeviceAnswer")
  • name string required
  • url string nullable
  • description string nullable
  • device_name 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 — That device has no troubleshooting write-ups, or no device page exists under that name. 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.