---
title: "Get a curated Microsoft Store chart"
method: GET
path: "/microsoftstore/charts"
tags: ["Microsoft Store"]
---

# Get a curated Microsoft Store chart

`GET /microsoftstore/charts`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/microsoftstore/charts`
- Auth: API key in header `x-api-key`

Returns a curated Microsoft Store chart (top free, top paid, top grossing, trending, deals, new releases, getting-started picks, or -- apps only -- most popular), optionally scoped to a category/subcategory and, for games, by Xbox Game Pass availability or player count. Some charts (notably NewAndRising) can legitimately return fewer items than page_size even at the first page -- that reflects real sparsity for that chart.

## Query parameters

- `list` 'TopFree' | 'TopPaid' | 'TopGrossing' | 'toptrending' | 'NewAndRising' | 'Deal' | 'GettingStartedApps' | 'MostPopular', required
- `media_type` 'apps' | 'games'
- `category` string
- `subcategory` string
- `discount_filter` 'onsale'
- `subscription_filter` 'gamepass'
- `num_players_filter` 'AllPlayers' | 'SinglePlayer' | 'OnlineMultiplayerWithGold' | 'LocalMultiplayer' | 'CoopSupportOnline' | 'CoopSupportLocal'
- `page` integer
- `page_size` integer
- `country` string
- `locale` string

## Headers

- `x-api-key` string, required

## Response `200`

OK

- MicrosoftstoreChartsResponseDoc
  - `code` integer
  - `data` MicrosoftstoreChartsResponse
    - `category` string
    - `count` integer
    - `discount_filter` string
    - `items` MicrosoftstoreProduct[]
      - `average_rating` number
      - `award` MicrosoftstoreAward
        - `category` string
        - `description` string
        - `editorial_id` string
        - `title` string
        - `year` integer
      - `categories` string[]
      - `description` string
      - `display_price` string
      - `free` boolean
      - `icon_url` string
      - `is_application` boolean
      - `is_game` boolean
      - `is_pwa` boolean
      - `is_subscription` boolean
      - `is_theme` boolean
      - `kind` string
      - `media_type` string
      - `poster_art_url` string
      - `price` number
      - `product_id` string
      - `publisher` string
      - `rating_count` string
      - `release_date_utc` string
      - `title` string
      - `url` string
    - `list` string
    - `media_type` string
    - `num_players_filter` string
    - `page` integer
    - `page_size` integer
    - `source_url` string
    - `subcategory` string
    - `subscription_filter` string
    - `title` string
  - `msg` string

## Other responses

- `400`: Bad Request
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/afac9b012a27?raw)