# /ifixit/devices

`POST /api/ifixit/devices`

Price: 5 credits

Get one iFixit device page with its guides, specs, part categories and repairability score

## How to use it

The hub page for one device model or one device family: what iFixit knows about it and every guide written for it, so reach for this when the question is about a device rather than about a single procedure. The device name is the identifier — spaces and underscores are interchangeable, and a device page URL works too. Names are exact catalogue entries, not free text, so resolve an uncertain name through a search first. Broad names such as iPhone are family pages whose children are the individual models; specific models carry the guides. repairability_score is stated only for the models iFixit has scored.

## 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", "iPhone_13", "https://www.ifixit.com/Device/iPhone_13"; 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

### 200 — Successful Response

- `@type` (string) (default: "IfixitDevice")
- `id` (string, required)
- `name` (string, required)
- `display_name` (string, nullable)
- `page_name` (string, nullable)
- `url` (string, nullable)
- `description` (string, nullable)
- `contents` (string, nullable)
- `contents_html` (string, nullable)
- `namespace` (string, nullable)
- `language` (string, nullable)
- `available_languages` (array) (default: [])
- `is_troubleshooting` (boolean, nullable)
- `is_machine_translated` (boolean, nullable)
- `repairability_score` (integer, nullable)
- `created_at` (integer, nullable)
- `modified_at` (integer, nullable)
- `revision_id` (string, nullable)
- `image` (string, nullable)
- `answers_url` (string, nullable)
- `parts_url` (string, nullable)
- `author_id` (string, nullable)
- `tags` (array) (default: [])
- `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: [])
- `ancestors` (array) (default: [])
  - `@type` (string) (default: "IfixitWikiPreview")
  - `id` (string, required)
  - `name` (string, nullable)
  - `display_name` (string, nullable)
  - `url` (string, nullable)
  - `summary` (string, nullable)
  - `namespace` (string, nullable)
  - `locale` (string, nullable)
  - `image` (string, nullable)
  - `modified_at` (integer, nullable)
- `children` (array) (default: [])
  - `@type` (string) (default: "IfixitWikiPreview")
  - `id` (string, required)
  - `name` (string, nullable)
  - `display_name` (string, nullable)
  - `url` (string, nullable)
  - `summary` (string, nullable)
  - `namespace` (string, nullable)
  - `locale` (string, nullable)
  - `image` (string, nullable)
  - `modified_at` (integer, nullable)
- `related_devices` (array) (default: [])
  - `@type` (string) (default: "IfixitWikiPreview")
  - `id` (string, required)
  - `name` (string, nullable)
  - `display_name` (string, nullable)
  - `url` (string, nullable)
  - `summary` (string, nullable)
  - `namespace` (string, nullable)
  - `locale` (string, nullable)
  - `image` (string, nullable)
  - `modified_at` (integer, nullable)
- `linked_devices` (array) (default: [])
  - `@type` (string) (default: "IfixitWikiPreview")
  - `id` (string, required)
  - `name` (string, nullable)
  - `display_name` (string, nullable)
  - `url` (string, nullable)
  - `summary` (string, nullable)
  - `namespace` (string, nullable)
  - `locale` (string, nullable)
  - `image` (string, nullable)
  - `modified_at` (integer, nullable)
- `guides` (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)
- `featured_guides` (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)
- `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)
- `tools` (array) (default: [])
  - `@type` (string) (default: "IfixitDeviceTool")
  - `name` (string, required)
  - `url` (string, nullable)
  - `image` (string, nullable)
  - `item_code` (string, nullable)
- `part_categories` (array) (default: [])
  - `@type` (string) (default: "IfixitPartCategory")
  - `name` (string, required)
  - `url` (string, nullable)
  - `product_count` (integer, nullable)
- `diagrams` (array) (default: [])
  - `@type` (string) (default: "IfixitDiagram")
  - `id` (string, required)
  - `name` (string, nullable)
  - `image` (string, nullable)
  - `thumbnail` (string, nullable)
  - `width` (integer, nullable)
  - `height` (integer, nullable)
- `specs` (array) (default: [])
  - `@type` (string) (default: "IfixitAttribute")
  - `name` (string, required)
  - `value` (string, nullable)
  - `inherited_from` (string, nullable)
- `category_specs` (array) (default: [])
  - `@type` (string) (default: "IfixitAttribute")
  - `name` (string, required)
  - `value` (string, nullable)
  - `inherited_from` (string, nullable)
- `maintenance_tasks` (array) (default: [])
  - `@type` (string) (default: "IfixitMaintenanceTask")
  - `id` (string, required)
  - `task` (string, nullable)
  - `status` (string, nullable)
  - `guide_id` (string, nullable)
  - `parts` (array) (default: [])
  - `triggers` (array) (default: [])
    - `@type` (string) (default: "IfixitMaintenanceTrigger")
    - `trigger_type` (string, nullable)
    - `metric` (string, nullable)
    - `comparator` (string, nullable)
    - `threshold` (integer, nullable)
    - `unit` (string, nullable)
    - `first_interval` (integer, nullable)
    - `repeat_interval` (integer, nullable)
- `flags` (array) (default: [])
  - `@type` (string) (default: "IfixitFlag")
  - `code` (string, required)
  - `name` (string, nullable)
  - `text` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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 device page exists under that name.

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.