/ifixit/guides

POST /api/ifixit/guides

Price: 10 credits

Get one iFixit repair guide with its full step-by-step instructions

How to use it

Use this when you already have a guide id or a guide page URL and need the actual repair instructions: every step with its text lines, photos and reader comments, plus the tools and parts the guide calls for. The slug inside a guide URL is decorative — the trailing number decides which guide comes back, so a URL whose slug names a different device still resolves to the number. Translations are separate revisions: pass language to get the translated steps, and read available_languages to learn which translations exist. To find a guide from a keyword or a device name, search first. A guide can genuinely own no steps of its own when its whole procedure lives in a chain of other guides it depends on: for that case steps carries the combined chain's steps (note their ids then belong to those other guides) instead of an empty list, and prerequisites lists which guides those are.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• guide string required — Guide id, or the URL of a guide page (examples: "145948", "https://www.ifixit.com/Guide/iPhone+13+Battery+Replacement/145948"; minLength: 1)
• language string nullable — Return the translation written in this language instead of the original (one of: "en", "de", "es", "fr", "it", "jp", "ko", "nl", "pt", "ru", "tr", "zh")

Response

• @type string (default: "IfixitGuide")
• id string required
• name string required
• url string nullable
• summary string nullable
• subject string nullable
• category string nullable
• guide_type string nullable
• difficulty string nullable
• time_required string nullable
• time_required_min_seconds integer nullable
• time_required_max_seconds integer nullable
• introduction string nullable
• introduction_html string nullable
• conclusion string nullable
• conclusion_html string nullable
• language string nullable
• available_languages array (default: [])
• is_public boolean nullable
• is_machine_translated boolean nullable
• created_at integer nullable
• published_at integer nullable
• modified_at integer nullable
• prerequisites_modified_at integer nullable
• revision_id string nullable
• image string nullable
• intro_video_url string nullable
• featured_document_id string nullable
• featured_document_embed_url string nullable
• featured_document_thumbnail_url string 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: [])
• steps array (default: [])
  • @type string (default: "IfixitGuideStep")
  • id string required
  • order integer nullable
  • name string nullable
  • revision_id string nullable
  • media_type string nullable
  • lines array (default: [])
    • @type string (default: "IfixitGuideStepLine")
    • text string nullable
    • text_html string nullable
    • bullet string nullable
    • level integer nullable
  • images array (default: [])
  • video object nullable
    • @type string (default: "IfixitStepVideo")
    • id string required
    • filename string nullable
    • duration_seconds number nullable
    • width integer nullable
    • height integer nullable
    • image string nullable
    • sources array (default: [])
  • comments array (default: [])
    • @type string (default: "IfixitComment")
    • id string required
    • text string nullable
    • text_html string nullable
    • heading string nullable
    • rating integer nullable
    • status string nullable
    • context string nullable
    • context_id string nullable
    • parent_id string nullable
    • locale string nullable
    • created_at integer nullable
    • modified_at integer nullable
    • author object nullable (see schema IfixitAuthor)
    • replies array (default: [])
• tools array (default: [])
  • @type string (default: "IfixitGuideItem")
  • name string nullable
  • url string nullable
  • wiki_name string nullable
  • wiki_url string nullable
  • image string nullable
  • quantity integer nullable
  • notes string nullable
  • item_type string nullable
  • is_optional boolean nullable
  • is_featured boolean nullable
• parts array (default: [])
  • @type string (default: "IfixitGuideItem")
  • name string nullable
  • url string nullable
  • wiki_name string nullable
  • wiki_url string nullable
  • image string nullable
  • quantity integer nullable
  • notes string nullable
  • item_type string nullable
  • is_optional boolean nullable
  • is_featured boolean nullable
• documents array (default: [])
  • @type string (default: "IfixitDocument")
  • id string required
  • name string nullable
  • filename string nullable
  • url string nullable
  • download_url string nullable
  • extension string nullable
  • page_count integer nullable
  • size integer nullable
  • created_at integer nullable
  • image string nullable
• prerequisites 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
• comments array (default: [])
  • @type string (default: "IfixitComment")
  • id string required
  • text string nullable
  • text_html string nullable
  • heading string nullable
  • rating integer nullable
  • status string nullable
  • context string nullable
  • context_id string nullable
  • parent_id string nullable
  • locale string 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: [])
  • replies array (default: [])
• 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 guide 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.