App Store Keywords Suggestion
Structured App Store data: send queries. Single lookup, 1 credit per successful call.
GET · POST1 credit / successful callSingle lookup
Overview
Section titled “Overview”Call GET /api/v2/app-store-keywords-suggestion/ with queries. The results are in data.result. 2 optional parameters refine the call (see Parameters).
Request
Section titled “Request”curl -G "https://api.scrapier.io/api/v2/app-store-keywords-suggestion/" \ -H "X-API-Key: YOUR_API_KEY" \ --data-urlencode "queries=light" \ --max-time 210const params = new URLSearchParams({ queries: "light" });
const res = await fetch(`https://api.scrapier.io/api/v2/app-store-keywords-suggestion/?${params}`, { headers: { "X-API-Key": "YOUR_API_KEY" }, signal: AbortSignal.timeout(210_000),});const body = await res.json();if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`);
console.log(body.data.result);import requests
resp = requests.get( "https://api.scrapier.io/api/v2/app-store-keywords-suggestion/", headers={"X-API-Key": "YOUR_API_KEY"}, params={"queries": "light"}, timeout=210,)body = resp.json()if not resp.ok: raise RuntimeError(body.get("error") or body.get("detail"))
print(body["data"]["result"])curl -X POST "https://api.scrapier.io/api/v2/app-store-keywords-suggestion/" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"queries":"light"}' \ --max-time 210Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X-API-Key header | string | yes | — | Your API key from the dashboard. |
queries | string | yes | e.g. light | Search keyword. Lookup endpoint -- next_cursor null. |
max_items | integer | no | 50 | No description in the catalog yet. |
Advanced
| Name | Type | Default | Description |
|---|---|---|---|
use_proxy | boolean | true | Route the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise. |
raw_data | boolean | false | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under raw_responses, in place of the formatted items. When false (default) you get the formatted output. Pagination (cursor / next_cursor) works the same in both modes. |
Response
Section titled “Response”{ "success": true, "data": { "queries": "light", "result": { "query": "light", "success": true, "suggestions": [ { "keyword": "light", "type": "suggestion", "item": "light" }, { "keyword": "light", "type": "suggestion", "item": "lightroom" }, { "keyword": "light", "type": "suggestion", "item": "lightning tracker" } ] }, "next_cursor": null }}Bad input. The exact message varies by endpoint.
{ "success": false, "error": "…"}Balance below the endpoint’s price.
{ "error": "Insufficient credits. Buy more to scrape more.", "balance": 1, "required": 2}Invalid or unknown API key.
{ "detail": "Authentication service unavailable or invalid API key."}Throttled — wait for Retry-After.
{ "detail": "Request was throttled. Expected available in N seconds."}Sample from the live catalog; arrays trimmed to 3 items. Results are in data.result.
Response fields
Section titled “Response fields”| Field | Type | Example | Description |
|---|---|---|---|
queries | string | light | — |
result | object | {…} | The results. |
next_cursor | null | null | Pass back as cursor for the next page. null on the last page. |
result.query | string | light | — |
result.success | boolean | true | — |
result.suggestions | array | [3 items] | — |
Pagination
Section titled “Pagination”Returns everything in one call; next_cursor is always null.
Errors
Section titled “Errors”Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.
| Status | Meaning | Retry? | Charged? |
|---|---|---|---|
400 | Bad or missing input. | No — fix the params | No |
401 / 403 | Missing, invalid or revoked API key. | No — fix the key | No |
402 | Out of credits (body has balance). | No — top up | No |
404 | Unknown endpoint slug. | No — check the slug | No |
429 / 503 | Busy or throttled. | Yes — after Retry-After | No |
5xx | Target site or upstream failure, or timeout. | Yes — with backoff | No |
- The response data carries its own
successfield from the scraper. The outersuccessis what counts: an HTTP 200 with outersuccess: trueis billed, even if the inner field says otherwise.
Related
Section titled “Related”- App Store App Info — Structured App Store data: send
urls. Single lookup, 1 credit per successful call. - Apple App Store — Structured App Store data: every input is optional. Cursor-paginated, 1 credit per successful call.
- Apple App Store Review Scraper — Structured App Store data: send
urls. Cursor-paginated, 1 credit per successful call.