/appstore/apps/search

POST /api/appstore/apps/search

Price: 10 credits

Search Apple App Store apps by term, keyword, or developer name

How to use it

Search Apple App Store apps by term, keyword, or developer name. Set count to how many results you want. Each item has id, bundle_id, name, developer, description, version, price and currency, rating and rating count, category, content rating, app size, supported languages and devices, minimum OS version, and icon. Specify the storefront via the country field.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• term string required — Search term — an app name, keyword, or developer (examples: "whatsapp", "photo editor"; minLength: 1)
• count integer required — Max number of results to return (min: 1; max: 200)
• country string — App Store storefront country (default: "us"; one of: "us", "gb", "ca", "au", "de", "fr", "it", "es", "nl", "se", "jp", "kr", "cn", "in", "br", "mx", "ru", "tr", "pl", "ae", "sa", "sg", "hk", "tw", "id", "th", "vn", "ph", "my", "za")

Response

• @type string (default: "AppstoreApp")
• id integer required
• bundle_id string nullable
• name string required
• alias string nullable
• url string nullable
• description string nullable
• developer_id integer nullable
• developer_name string nullable
• developer_url string nullable
• seller_name string nullable
• seller_url string nullable
• version string nullable
• release_notes string nullable
• released_at string nullable
• current_version_released_at string nullable
• price number (default: 0)
• formatted_price string nullable
• currency string nullable
• is_free boolean (default: false)
• category string nullable
• category_id integer nullable
• genre_ids array (default: [])
• categories array (default: [])
• rating number nullable
• rating_count integer (default: 0)
• rating_current_version number nullable
• rating_count_current_version integer (default: 0)
• content_rating string nullable
• advisories array (default: [])
• size_bytes integer nullable
• size string nullable
• languages array (default: [])
• minimum_os_version string nullable
• supported_devices array (default: [])
• image string nullable
• screenshots array (default: [])
• has_in_app_purchases boolean (default: false)
• in_app_purchases array (default: [])
  • @type string (default: "AppstoreInAppPurchase")
  • name string required
  • price string required
• privacy array (default: [])
  • @type string (default: "AppstorePrivacyType")
  • identifier string required
  • detail string nullable
  • categories array (default: [])
• copyright string nullable
• is_game_center_enabled boolean (default: false)

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.