/ifixit/users/guides

POST /api/ifixit/users/guides

Price: 5 credits

List the repair guides one iFixit member wrote

How to use it

Everything a member wrote, keyed by the numeric user id you find as author_id on a guide, a comment or a search result. A profile URL works as well; only the number in it is read. Setting language chooses which language edition of each guide comes back, not which guides — the set is the same size whichever you ask for — so use it to read an author's work in the caller's language.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• user string required — User id, or the URL of a user profile (examples: "3837266", "https://www.ifixit.com/User/1/kyle"; minLength: 1)
• count integer required — Max number of results (min: 1; max: 1000)
• language string — Which language edition of the guide catalogue to read (default: "en"; one of: "en", "de", "es", "fr", "it", "jp", "ko", "nl", "pt", "ru", "tr", "zh")

Response

• @type string (default: "IfixitGuideSearchResult")
• id string required
• name string required
• url string nullable
• summary string nullable
• text string nullable
• image string nullable
• device string nullable
• device_ancestors array (default: [])
• part string nullable
• guide_type string nullable
• difficulty_level integer nullable
• language string nullable
• is_public boolean nullable
• is_teardown boolean nullable
• view_count integer nullable
• modified_at integer nullable
• score integer nullable
• tags array (default: [])
• flags array (default: [])
• team_ids array (default: [])
• author_id 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.