---
title: "Return App Store keyword autocomplete suggestions"
method: POST
path: "/v1/autocomplete"
tags: ["Data"]
---

# Return App Store keyword autocomplete suggestions

`POST /v1/autocomplete`

## Request

- Base URL: `https://api.asoskill.com`
- URL: `https://api.asoskill.com/v1/autocomplete`
- Auth: HTTP bearer

Returns up to ten ordered, unique keyword suggestions for one storefront and Apple platform. App, developer, and editorial navigation entities are excluded. Prefix results are fresh for 30 days and cached independently per storefront and platform. A successful response costs one credit.

## Request body

- AutocompleteRequest
  - `term` string, required
  - `storefront` string: Two-letter App Store storefront code; normalized to uppercase
  - `platform` 'iphone' | 'ipad' | 'mac' | 'appletv' | 'watch' | 'vision'

## Response `200`

Autocomplete result; costs one credit

- AutocompleteResponse
  - `term` string, required
  - `storefront` string, required
  - `platform` 'iphone' | 'ipad' | 'mac' | 'appletv' | 'watch' | 'vision', required
  - `resultCount` integer, required
  - `suggestions` AutocompleteSuggestion[], required
    - `position` integer, required
    - `term` string, required
  - `cache` 'hit' | 'refresh' | 'stale', required
  - `fetchedAt` string, date-time, required
  - `requestId` string, required

## Other responses

- `400`: The request body or parameters are invalid; no credit is consumed
- `401`: The bearer credential is missing, invalid, expired, or revoked; no credit is consumed
- `402`: No promotional or paid credits remain; no credit is consumed
- `409`: A concurrent credit reservation could not be completed; no credit is consumed and the request may be retried
- `429`: Request capacity or a rate allowance was exceeded; no credit is consumed. Respect Retry-After when present, otherwise retry with exponential backoff and jitter.
- `500`: Unexpected processing failure; any reserved credit is restored
- `502`: An upstream App Store service failed; any reserved credit is restored
- `503`: ASO Skill or an upstream service is temporarily unavailable; any reserved credit is restored. Retry after the indicated delay when provided.

---

[API](https://skmtc.dev/asoskill/apis/aso-skill-developer-api.md) · [All operations](https://skmtc.dev/asoskill/apis/aso-skill-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/asoskill/apis/aso-skill-developer-api/revisions/c9808e5357cf?raw)