App Store API
App Store search suggestions
The search terms the App Store suggests for a partial query, in the order the store ranks them.
Endpoint
GET/v1/app_store/search-suggestionslive · proven1 creditParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
query | yes | Partial search term | spotify |
country | no | 2-letter storefront country code (default us) | us |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/app_store/search-suggestions?query=spotify" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/app_store/search-suggestions?query=spotify",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/app_store/search-suggestions?query=spotify",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "app_store",
"endpoint": "/v1/app_store/search-suggestions",
"data": {
"_warnings": [],
"count": 0,
"country": "example",
"items": [
{
"rank": 0,
"term": "example"
}
],
"query": "example"
},
"credits_used": 1,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
_warnings | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
count | number | null | Number of records in this response, not lifetime or total matches. |
country | string | null | Optional country supplied by this operation. Null means unknown. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[].rank | number | null | Optional rank supplied by this operation. Null means unknown. |
items[].term | string | null | Optional term supplied by this operation. Null means unknown. |
query | string | null | Optional query supplied by this operation. Null means unknown. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference