/microsoftstore/apps

POST /api/microsoftstore/apps

Price: 5 credits

Get Microsoft Store app details by Store product ID or product page URL

How to use it

Get full details of a Microsoft Store product (app, game, or other catalog item) by its 12-character Store product ID or product page URL. Returns title, description, publisher details, average rating and rating count, price, categories, icon and screenshots, system requirements, supported languages, permissions, age ratings, download size, update and release dates, and store URLs.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• app string required — Microsoft Store product as a 12-character Store ID or a product page URL (examples: "9NCBCSZSJRSB", "9WZDNCRFJBMP", "https://apps.microsoft.com/detail/9NCBCSZSJRSB"; minLength: 1)
• market string — Store market (default: "US"; one of: "US", "GB", "CA", "AU", "DE", "FR", "IT", "ES", "NL", "BR", "MX", "IN", "JP", "KR", "TR")
• locale string — Content language (default: "en-US"; one of: "en-US", "en-GB", "en-CA", "en-AU", "de-DE", "fr-FR", "it-IT", "es-ES", "nl-NL", "pt-BR", "es-MX", "ja-JP", "ko-KR", "tr-TR")

Response

• @type string (default: "MicrosoftstoreApp")
• id string required
• alias string nullable
• description string nullable
• short_description string nullable
• media_type string nullable
• product_type string nullable
• product_family_name string nullable
• publisher_name string nullable
• publisher_id string nullable
• publisher_address string nullable
• publisher_phone_number string nullable
• publisher_copyright string nullable
• developer_name string nullable
• average_rating number nullable
• rating_count integer (default: 0)
• rating_count_formatted string nullable
• price number nullable
• display_price string nullable
• categories array (default: [])
• image string nullable
• hero_image string nullable
• poster_art string nullable
• box_art string nullable
• screenshots array (default: [])
• images array (default: [])
  • @type string (default: "MicrosoftstoreImage")
  • image_type string required
  • url string required
  • width integer (default: 0)
  • height integer (default: 0)
  • background_color string nullable
• system_requirements object nullable
  • @type string (default: "MicrosoftstoreSystemRequirements")
  • minimum array (default: [])
    • @type string (default: "MicrosoftstoreRequirementItem")
    • name string required
    • description string nullable
    • item_code string nullable
    • level string nullable
  • recommended array (default: [])
    • @type string (default: "MicrosoftstoreRequirementItem")
    • name string required
    • description string nullable
    • item_code string nullable
    • level string nullable
• supported_languages array (default: [])
• platforms array (default: [])
• allowed_platforms array (default: [])
• permissions_required array (default: [])
• age_ratings array (default: [])
  • @type string (default: "MicrosoftstoreAgeRating")
  • rating_system string required
  • rating_system_short_name string nullable
  • rating_value string nullable
  • rating_age integer (default: 0)
  • rating_value_logo_url string nullable
  • descriptors array (default: [])
  • interactive_elements array (default: [])
  • has_in_app_purchases boolean (default: false)
• approximate_size integer (default: 0)
• max_install_size integer (default: 0)
• last_updated_at string nullable
• package_updated_at string nullable
• released_at string nullable
• package_family_names array (default: [])
• installer_type string nullable
• installer_id string nullable
• website_url string nullable
• privacy_url string nullable
• license_terms_url string nullable
• support_urls array (default: [])
• installation_terms string nullable
• disclaimer_text string nullable
• warning_messages array (default: [])
• is_application boolean (default: false)
• is_game boolean (default: false)
• is_movie boolean (default: false)
• is_tv_series boolean (default: false)
• is_pwa boolean (default: false)
• is_theme boolean (default: false)
• is_hardware boolean (default: false)
• is_microsoft_product boolean (default: false)
• is_subscription boolean (default: false)
• has_add_ons boolean (default: false)
• has_third_party_iaps boolean (default: false)
• has_xbox_live 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 — Product not found 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.