Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| appId | string | Yes | App ID — numeric for Apple (913335252), package name for Google (com.spotify.music) |
Query Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| platform | string | apple | apple (default) or google for Google Play — see Platforms |
| country | string | us | ISO country code (e.g. us, gb, de) |
| lang | string | en | Google Play language code (used when platform=google) |
Code Examples
Response
Opportunity Fields
| Field | Type | Description |
|---|---|---|
| keyword | string | The keyword opportunity |
| volumeScore | number | Search volume score (0-100) |
| difficulty | number | Ranking difficulty (0-100) |
| opportunityScore | number | Composite opportunity score (0-100, higher = better) |
| currentRank | number|null | App’s current rank for this keyword (null = not ranking) |
| competitorRank | number|null | Competitor’s rank if applicable |
| source | string | How the opportunity was found (see below) |
Source Values
| Source | Description |
|---|---|
suggestion | New keyword from Apple autocomplete suggestions — the app doesn’t rank for it yet |
improvable-rank | App already ranks but outside top 10 — has room to improve |
Summary Fields
| Field | Type | Description |
|---|---|---|
| totalOpportunities | number | Total number of opportunities found |
| highPriority | number | Opportunities with score >= 50 |
| mediumPriority | number | Opportunities with score 25-49 |
| lowPriority | number | Opportunities with score < 25 |
Errors
| Status | Code | When |
|---|---|---|
| 400 | INVALID_APP_ID | Non-numeric or missing app ID |
| 401 | MISSING_API_KEY | No API key in the request |
| 404 | APP_NOT_FOUND | App not found or unavailable |

