# /threedmark/hardware/search

`POST /api/threedmark/hardware/search`

Price: 10 credits

Read UL's full ranking of graphics cards or processors, ordered by 3DMark score, name, MSRP, value for money or recent popularity, and optionally narrowed to desktop parts, mobile parts or Apple silicon and to a minimum performance rating. Each row carries the part's rank, its name as UL spells it, the launch price, the median 3DMark score with the test that score comes from, a value-for-money rating and a popularity figure from the last 30 days of submissions. The CPU ranking's other per-thread-count columns (single thread, 2/4/8/16 threads) come back in `scores`.

## How to use it

This is the name catalogue for the hardware endpoint — a row's `name` and its own `kind` are exactly what that endpoint accepts; a `kind=gpu` search still returns some rows whose own `kind` is `mac` (Apple systems ranked inside the GPU listing but reviewed under a separate page), so pass the row's `kind` back rather than the search's. The whole ranking is served in one response, so `count` takes the top N under the chosen ordering rather than paging. `sort` by value_for_money or popularity reorders the same set, it does not filter it; use `min_rating` and `form_factors` to cut the list. Every score is a median across submitted runs of the same test named in `score_test`, so a part whose `score_test` differs is not comparable on that number.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `kind` (string) — Rank graphics cards or processors (default: "gpu"; one of: "gpu", "cpu", "mac")
- `sort` (string) — Which column the ranking is ordered by (default: "SCORE"; one of: "SCORE", "NAME", "PRICE", "VALUE_FOR_MONEY", "POPULARITY")
- `ascending` (boolean) — Order from the lowest value up rather than the highest down (default: false)
- `form_factors` (array, nullable) — Restrict to desktop parts, mobile parts, Apple silicon, or a combination (one of: "DESKTOP", "MOBILE", "MAC")
- `min_rating` (integer) — Drop parts below this five-star performance rating (default: 0; min: 0; max: 5)
- `count` (integer, required) — Max number of ranked parts to return (min: 1)

## Response

### 200 — Successful Response

- `@type` (string) (default: "ThreedmarkHardwareRanking")
- `name` (string, required)
- `kind` (string, required)
- `rank` (integer, nullable)
- `msrp_price` (string, nullable)
- `score` (number, nullable)
- `value_for_money` (number, nullable)
- `popularity` (number, nullable)
- `score_test` (string, nullable)
- `scores` (object) (default: {})
  - `*` (number)

## 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

The entity was not found, or a precondition failed

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.