steam_api_client 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05561b6cbe30e78afaa9c6f67481698c938c95af7ad492b8296c88e07a2ef5bd
-  data.tar.gz: f14bb719c36232e629d71d80d9ba8bc3592c84855125deeb8cee9db965c3db3a
+  metadata.gz: 410a0d3b36b83ac8888323849214253b0d0ba26501d1218ad7f48176eb8dd2af
+  data.tar.gz: 89f42dc5315420c9cbe41b3bb5b0eb1c511c1ca6c7133d7305c4ec700e1a6f31
 SHA512:
-  metadata.gz: a8c5a13773d8f57a6bb124adaae1d3dc282026cda3ec066900fb461fdd23b773617f3953b46f8b9715d8881eb9833434ee2101e1044e9f9aafd14cfe3dcb5299
-  data.tar.gz: 3a7ff5be8ca4685d81203f58182c769297390803406ce97b9512572b2cbd1a5e31a1fe55665bc58be07426d47d5981b7d7deac889ad7777a668d782b3f42a0c2
+  metadata.gz: ddff8c5f6b2a3b2e4faf56dccf572dd659517125b0f29a2c224b2eafb782319218c956a1b3cb2c131c988382da58eb05125c84a7bf80eb5de891d8a768cfe8fb
+  data.tar.gz: 34bd9e558c5d1a29453e02dfd76c709876765b2c1958744d5cdac985045e7b04c09cbc7c51d1706fe81df0d1ab54d2fdbaf4d411335ad2038ae86236b6a0da5e

data/CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 
 ## [Unreleased]
 
+## [1.6.0] - 2026-11-04
+
+### Added
+
+- `app_list`: the apps in the store, a page at a time (up to 50,000 per call), filtered by type or by last change (#109).
+
 ## [1.5.0] - 2026-11-04
 
 ### Added
@@ -228,7 +234,8 @@ The versions below were bumped in `version.rb` during development but **never pu
 
 - Initial gem skeleton.
 
-[Unreleased]: https://github.com/jpechaves/steam_api/compare/v1.5.0...HEAD
+[Unreleased]: https://github.com/jpechaves/steam_api/compare/v1.6.0...HEAD
+[1.6.0]: https://github.com/jpechaves/steam_api/compare/v1.5.0...v1.6.0
 [1.5.0]: https://github.com/jpechaves/steam_api/compare/v1.4.0...v1.5.0
 [1.4.0]: https://github.com/jpechaves/steam_api/compare/v1.3.0...v1.4.0
 [1.3.0]: https://github.com/jpechaves/steam_api/compare/v1.2.0...v1.3.0

data/docs/USAGE.md

@@ -336,6 +336,36 @@ lists.top_sellers.items.map(&:name)
 
 `SteamApiClient::FeaturedCategories` fields: `specials`, `coming_soon`, `top_sellers`, `new_releases`, each a `FeaturedCategories::Category` (`id`, `name` in the requested language, `items`: `FeaturedItem`), or `nil` when Steam leaves the list out. Steam also sends the spotlights, the daily deal, genres and trailers, whose shapes vary: use `retrieve_raw` for those.
 
+#### `app_list`
+
+🔑 One page of the apps in the store, in app ID order. It's the way to find an app's ID by name across the whole catalog (`store_search` returns at most 10 results). `nil` when there's nothing: past the last page, or no app changed since `if_modified_since`.
+
+- `include_games:` (default `true`), `include_dlc:`, `include_software:`, `include_videos:`, `include_hardware:` (default `false`) pick the types.
+- `max_results:` is the page size, 10,000 by default, up to 50,000.
+- `last_appid:` starts after that app: pass the previous page's `last_app_id` to get the next page.
+- `if_modified_since:` (unix time) only returns apps changed since then.
+
+```ruby
+page = client.app_list.retrieve(max_results: 5)
+# => #<data SteamApiClient::AppList apps=[#<data SteamApiClient::AppList::App app_id=10, name="Counter-Strike",
+#     last_modified=1745368572, price_change_number=39636801>, ...], have_more_results=true, last_app_id=50>
+
+# Every game, a page at a time (about 200,000 in 4 calls)
+apps = []
+last_appid = 0
+loop do
+  page = client.app_list.retrieve(last_appid: last_appid, max_results: 50_000)
+  break unless page
+
+  apps.concat(page.apps)
+  break unless page.have_more_results
+
+  last_appid = page.last_app_id
+end
+```
+
+On the last page Steam leaves out `have_more_results` (so `false`) and `last_app_id` (`nil`).
+
 #### `app_news`
 
 The latest news of an app. `count:` is required, `maxlength:` (default 300) shortens each item's contents.

data/lib/steam_api_client/endpoints.rb

@@ -44,6 +44,26 @@ module SteamApiClient
         params: {appid: param.integer(as: :gameid)}
       ),
 
+      # One page of the apps in the store, by app ID => AppList, or nil when there's nothing
+      # (past the last page, or nothing modified since if_modified_since)
+      # @see https://steamapi.xpaw.me/#IStoreService/GetAppList
+      Endpoint.new(
+        :app_list, "IStoreService/GetAppList/v1/", returns: AppList, at: %i[response],
+        params: {
+          include_games: param.boolean(default: true),
+          include_dlc: param.boolean(default: false),
+          include_software: param.boolean(default: false),
+          include_videos: param.boolean(default: false),
+          include_hardware: param.boolean(default: false),
+          # Only apps changed since then, in unix time (0 for all)
+          if_modified_since: param.integer(default: 0),
+          # The previous page's last_app_id (0 for the first page)
+          last_appid: param.integer(default: 0),
+          # Apps per page, up to 50,000
+          max_results: param.integer(default: 10_000)
+        }
+      ),
+
       # Latest news of an app => [NewsItem]
       # @see https://developer.valvesoftware.com/wiki/Steam_Web_API#GetNewsForApp_.28v0002.29
       Endpoint.new(

data/lib/steam_api_client/models/app_list.rb

@@ -0,0 +1,22 @@
+module SteamApiClient
+  # Built first, then named AppList::App below
+  app = Model.define(
+    app_id: [:integer, from: :appid],
+    name: :string,
+    # In unix time
+    last_modified: [:integer, optional: true],
+    # Changes whenever the app's price changes
+    price_change_number: [:integer, optional: true]
+  )
+
+  # One page of the apps in the store, from `app_list`
+  # @see https://steamapi.xpaw.me/#IStoreService/GetAppList
+  AppList = Model.define(
+    apps: [[app], default: []],
+    # Steam leaves these out on the last page
+    have_more_results: [:boolean, default: false],
+    # Pass as `last_appid:` to get the next page
+    last_app_id: [:integer, from: :last_appid, optional: true]
+  )
+  AppList.const_set(:App, app)
+end

data/lib/steam_api_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SteamApiClient
-  VERSION = "1.5.0"
+  VERSION = "1.6.0"
 end

data/lib/steam_api_client.rb

@@ -32,6 +32,7 @@ require_relative "steam_api_client/models/player_game_stats"
 require_relative "steam_api_client/models/news_item"
 require_relative "steam_api_client/models/global_achievement"
 require_relative "steam_api_client/models/app_schema"
+require_relative "steam_api_client/models/app_list"
 require_relative "steam_api_client/models/app_details"
 require_relative "steam_api_client/models/package_details"
 require_relative "steam_api_client/models/app_dlc"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: steam_api_client
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - João Pedro
@@ -55,6 +55,7 @@ files:
 - lib/steam_api_client/model/scalars.rb
 - lib/steam_api_client/models/app_details.rb
 - lib/steam_api_client/models/app_dlc.rb
+- lib/steam_api_client/models/app_list.rb
 - lib/steam_api_client/models/app_schema.rb
 - lib/steam_api_client/models/featured.rb
 - lib/steam_api_client/models/featured_categories.rb