# /coolapk/devices/search

`POST /api/coolapk/devices/search`

Price: 20 credits

Search the Coolapk phone catalogue by keyword and spec filters

## How to use it

Use this to find phone models in Coolapk's China-market catalogue and to get the ids the other device endpoints take. A row is one phone model, not one RAM/ROM variant, so the price it carries is the model's cheapest configuration; pass its `product_id` to coolapk/devices/versions for the other variants and their own prices, or its `config_id` to coolapk/devices for the labelled spec sheet. `default` and `popularity` return the same order on the unfiltered catalogue and diverge as soon as any filter is applied, so do not read a difference between them as a bug. Brands, release years and RAM sizes are the source's own numeric codes, and `filters` reaches its remaining spec dimensions by the same codes; an unrecognised code or a combination nothing matches comes back as an empty list rather than an error. Everything is China-market: CNY prices, Chinese brand, model and spec names.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `key` (string) — Keyword to match against phone model names (default: ""; examples: "iPhone", "小米", "Redmi")
- `count` (integer, required) — Max number of phone models to return (min: 1; max: 800)
- `sort` (string) — Result ordering. `rating` and the six per-aspect orderings return only the models that carry the matching owner score, so they cover less of the catalogue than `default` (default: "default"; one of: "default", "popularity", "rating", "followers", "battery", "camera", "performance", "screen", "build_quality", "value")
- `brands` (array) — Filter by Coolapk brand id (e.g. 1016 Xiaomi, 1005 Apple, 1002 Huawei); multiple ids union (default: []; examples: [1016], [1005,1002])
- `price` (array) — Filter by the source's launch-price band in CNY; multiple bands union. The cheapest band is mostly models the catalogue carries with no price at all rather than inexpensive phones (default: []; one of: "gte_6000", "between_5000-6000", "between_4000-5000", "between_3000-4000", "between_2000-3000", "between_1000-2000", "lt_1000")
- `release_years` (array) — Filter by release year (2006-2026); multiple years union (default: []; examples: [2025], [2024,2025])
- `ram_gb` (array) — Filter by RAM size in GB (1,2,3,4,6,8,12,16,18,20,24); multiple values union (default: [])
- `filters` (object) — Advanced filters not covered by the typed fields, as {section_code: [values]}. Section codes are Coolapk config-item ids, e.g. '1025' ROM in GB ('256','512','1TB','2TB'), '1021' SoC brand, '1033' screen size, '1002' refresh rate, '1105' NFC. Serialised as selectedFilters[code][]=value. (default: {}; examples: {"1025":["512","1TB"]}, {"1021":["高通"]})
  - `*` (array)

## Response

### 200 — Successful Response

- `@type` (string) (default: "CoolapkDevice")
- `config_id` (string, required)
- `product_id` (string, required)
- `config_name` (string, required)
- `product_name` (string, required)
- `image` (string, nullable)
- `price_min` (number, nullable)
- `owner_rating` (number, nullable)
- `owner_rating_count` (integer, nullable)
- `rating_breakdown` (object) (default: {})
  - `*` (string)
- `battery_rating` (number, nullable)
- `camera_rating` (number, nullable)
- `performance_rating` (number, nullable)
- `screen_rating` (number, nullable)
- `build_quality_rating` (number, nullable)
- `value_rating` (number, nullable)
- `rating_total_count` (integer, nullable)
- `rating_owner_total_count` (integer, nullable)
- `highlights` (array) (default: [])
- `is_new_product` (boolean) (default: false)

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