Apple

Apple App Store Search

Search Apple App Store apps, optionally by developer name, genre, or explicit-content setting. Filter and paginate Apple’s returned inventory of up to 200 apps. Continuations bind the filters and ordered inventory; source ranking changes end pagination.

post/v1/apple/app-store/search

Request

  • Base URL: https://api.prismcrawl.com
  • URL: https://api.prismcrawl.com/v1/apple/app-store/search
  • Auth: API key in header x-api-key

Request body

querystring required

Text to search for on the selected service. At most 8,192 UTF-8 bytes.

countrystring

Two-letter country or storefront code, such as us or gb.

language'ca' | 'ca-es' | 'cs' | 'cs-cz' | 'da' | 'da-dk' | 'de' | 'de-ch' | 'de-de' | 'el' | 'el-gr' | 'en' | 'en-au' | 'en-ca' | 'en-gb' | 'en-us' | 'es' | 'es-es' | 'es-mx' | 'fi' | 'fi-fi' | 'fr' | 'fr-ca' | 'fr-fr' | 'hi' | 'hi-in' | 'hr' | 'hr-hr' | 'hu' | 'hu-hu' | 'id' | 'id-id' | 'it' | 'it-it' | 'ja' | 'ja-jp' | 'ko' | 'ko-kr' | 'ms' | 'ms-my' | 'nl' | 'nl-nl' | 'no' | 'no-no' | 'pl' | 'pl-pl' | 'pt' | 'pt-br' | 'pt-pt' | 'ro' | 'ro-ro' | 'ru' | 'ru-ru' | 'sk' | 'sk-sk' | 'sv' | 'sv-se' | 'th' | 'th-th' | 'tr' | 'tr-tr' | 'uk' | 'uk-ua' | 'vi' | 'vi-vi' | 'zh' | 'zh-cn' | 'zh-hk' | 'zh-tw'

Provider-supported language code, such as en.

category'software' | 'iPadSoftware' | 'macSoftware'

A category identifier supported by this operation.

disallow_explicitboolean

Exclude explicit apps using the native explicit-content control.

property'developer'

Match the query against developer names within Apple’s returned search inventory.

category_idinteger

Keep apps with this native genre ID within Apple’s returned search inventory.

limitinteger

Maximum number of items to return. The provider may return fewer.

device'desktop' | 'mobile' | 'tablet'

Device presentation for the source request.

next_page_tokenstring

Continue within Apple's returned catalog inventory, up to 200 apps per search. Use the same account, query, category, country, language, device, and result limit. The opaque token expires after one hour. Expired tokens are rejected before execution. If Apple's inventory changes during a valid continuation, the completed response costs one credit and marks pagination_reason: stale_cursor; restart the search.

htmlboolean

Return the encoded original response rather than parsed JSON.

zero_traceboolean

Do not archive source or parsed response artifacts.

output'json' | 'html' | 'md' | 'null' nullable

Response content format. md returns Markdown in data.content with data.format=md; the JSON success/request envelope remains. Accept: text/markdown also selects Markdown unless output or html=true is explicit. html is an alias for html=true and retains the existing Brotli/Base64 source format.

json_restrictorstring nullable

Select fields within data.content for JSON or Markdown. Supports comma-separated paths, non-negative array indices, half-open slices [0:3] (either bound may be omitted), [] and .{nested,subqueries}. Up to128 selections and16 levels. Missing fields are omitted; selected declared fields retain their zero defaults. The request envelope and credit headers remain. Include next_page_token when pagination is needed. Incompatible with HTML output. This changes response presentation only; tracing-enabled history retains the complete JSON result.

no_cacheboolean nullable

Accepted for compatibility. Searches are always fetched without a result cache for either value; normal successful-request billing applies.

Example request

{
  "json_restrictor": "results[].{title,url},has_next_page,next_page_token"
}

Response

Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.

successtrue required
request_idstring uuid required

Changes

No recorded changes to this operation across all 2 revisions of this API.