/gsmarena/search

POST /api/gsmarena/search

Price: 1 credit

Search GSMArena by name across all three of its content types at once and return the matching devices, editorial reviews and news articles as one list, each row carrying its numeric id, the kind of thing it is, the URL, name, image and — for news — the publication date.

How to use it

Turn a device, review or article name into the id the other GSMArena endpoints take. Rows always come back grouped devices, then reviews, then news, and the source caps each group separately — a small `count` returns devices only when the query matched any devices at all. A narrow query that only matches reviews or news returns those groups first instead, in the same fixed order. The match is on names and headlines, not on specifications — to find devices by their properties use the device search instead. A query with no matches returns an empty list.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search text matched against device names, review titles and news headlines (examples: "galaxy s24 ultra", "pixel", "snapdragon"; minLength: 1)
• count integer required — Max number of results to return (min: 1; max: 24)

Response

• @type string (default: "GsmarenaSearchHit")
• id integer required
• kind string required (one of: "device", "review", "news")
• url string required
• name string required
• image string nullable
• published string nullable
• published_at integer 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.