/ifixit/categories

POST /api/ifixit/categories

Price: 20 credits

List iFixit's device category tree, flattened one row per category

How to use it

Use this to enumerate what iFixit covers when you do not yet have a device name: every category from the top classes down to individual models, each row naming its parent and the chain above it. Any name that comes back is accepted by the device endpoints as-is. Set parent to start partway down instead of at the root, and max_depth to keep the answer to whole levels rather than a depth-first slice cut off by count.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of results (min: 1)
• parent string nullable — Return only the categories below this one, instead of the whole tree (examples: "Phone", "Mac_Laptop")
• max_depth integer nullable — Stop descending once a category is this many levels below the starting point (min: 1)

Response

• @type string (default: "IfixitCategory")
• name string required
• url string nullable
• parent string nullable
• ancestors array (default: [])
• depth integer (default: 0)
• has_children boolean (default: false)

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 category exists under that parent 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.