/ifixit/troubleshooting

POST /api/ifixit/troubleshooting

Price: 1 credit

Get one iFixit troubleshooting write-up with its causes, checks and suggested fixes

How to use it

The prose diagnosis behind a symptom: ordered solution sections, each with the guides and parts that section calls for. Take the id from a device's troubleshooting index or from the trailing number of a troubleshooting URL — the device and symptom words in that URL are decorative, only the number resolves. Section bodies come back as HTML, so render or strip them rather than treating them as plain text.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• problem string required — Troubleshooting page id, or the URL of a troubleshooting page (examples: "513738", "https://www.ifixit.com/Troubleshooting/iPhone_13/Black+Screen/513738"; minLength: 1)

Response

• @type string (default: "IfixitTroubleshooting")
• id string required
• name string required
• page_name string nullable
• url string nullable
• description string nullable
• keywords string nullable
• image string nullable
• thumbnail string nullable
• modified_at integer nullable
• answers_url string nullable
• edit_url string nullable
• history_url string nullable
• device_guides_url string nullable
• device_troubleshooting_url string nullable
• device_parts_url string nullable
• view_count integer nullable
• view_count_today integer nullable
• view_count_week integer nullable
• view_count_month integer nullable
• device object nullable
  • @type string (default: "IfixitTroubleshootingDevice")
  • name string nullable
  • display_name string nullable
  • description string nullable
  • image string nullable
  • url string nullable
• breadcrumbs array (default: [])
  • @type string (default: "IfixitBreadcrumb")
  • name string required
  • url string nullable
• authors array (default: [])
  • @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: [])
• introduction array (default: [])
  • @type string (default: "IfixitTroubleshootingSection")
  • id string nullable
  • heading string nullable
  • body_html string nullable
  • guides array (default: [])
    • @type string (default: "IfixitSectionGuide")
    • id string required
    • name string nullable
    • url string nullable
    • image string nullable
    • time_required string nullable
    • difficulty string nullable
    • introduction_html string nullable
  • products array (default: [])
    • @type string (default: "IfixitProductLink")
    • name string required
    • sku string nullable
    • url string nullable
    • image string nullable
    • thumbnail string nullable
    • price number nullable
    • currency string nullable
    • rating number nullable
    • rating_count integer nullable
  • part_collections array (default: [])
    • @type string (default: "IfixitPartCollection")
    • name string required
    • url string nullable
    • description string nullable
    • image string nullable
    • device_name string nullable
    • is_empty boolean nullable
• solutions array (default: [])
  • @type string (default: "IfixitTroubleshootingSection")
  • id string nullable
  • heading string nullable
  • body_html string nullable
  • guides array (default: [])
    • @type string (default: "IfixitSectionGuide")
    • id string required
    • name string nullable
    • url string nullable
    • image string nullable
    • time_required string nullable
    • difficulty string nullable
    • introduction_html string nullable
  • products array (default: [])
    • @type string (default: "IfixitProductLink")
    • name string required
    • sku string nullable
    • url string nullable
    • image string nullable
    • thumbnail string nullable
    • price number nullable
    • currency string nullable
    • rating number nullable
    • rating_count integer nullable
  • part_collections array (default: [])
    • @type string (default: "IfixitPartCollection")
    • name string required
    • url string nullable
    • description string nullable
    • image string nullable
    • device_name string nullable
    • is_empty boolean nullable
• conclusion array (default: [])
  • @type string (default: "IfixitTroubleshootingSection")
  • id string nullable
  • heading string nullable
  • body_html string nullable
  • guides array (default: [])
    • @type string (default: "IfixitSectionGuide")
    • id string required
    • name string nullable
    • url string nullable
    • image string nullable
    • time_required string nullable
    • difficulty string nullable
    • introduction_html string nullable
  • products array (default: [])
    • @type string (default: "IfixitProductLink")
    • name string required
    • sku string nullable
    • url string nullable
    • image string nullable
    • thumbnail string nullable
    • price number nullable
    • currency string nullable
    • rating number nullable
    • rating_count integer nullable
  • part_collections array (default: [])
    • @type string (default: "IfixitPartCollection")
    • name string required
    • url string nullable
    • description string nullable
    • image string nullable
    • device_name string nullable
    • is_empty boolean nullable
• featured_products array (default: [])
  • @type string (default: "IfixitProductLink")
  • name string required
  • sku string nullable
  • url string nullable
  • image string nullable
  • thumbnail string nullable
  • price number nullable
  • currency string nullable
  • rating number nullable
  • rating_count integer nullable
• linked_problems array (default: [])
  • @type string (default: "IfixitProblemLink")
  • name string required
  • id string nullable
  • url string nullable
  • device_name string nullable
  • image string nullable
• related_problems array (default: [])
  • @type string (default: "IfixitProblemLink")
  • name string required
  • id string nullable
  • url string nullable
  • device_name string nullable
  • image string nullable
• localized_urls array (default: [])
  • @type string (default: "IfixitLocalizedUrl")
  • language string required
  • url string required
• flags array (default: [])
  • @type string (default: "IfixitFlag")
  • code string required
  • name string nullable
  • text 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 troubleshooting page 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.