Garry's Mod Wiki

Home / steamworks.GetList

steamworks.GetList

  steamworks.GetList( string type, table tags, number offset, number numRetrieve, number days, string userID = "0", function resultCallback, string searchText = nil )
Search Github

Description

Retrieves a customized list of Steam Workshop addons.

Arguments

1 string type
The type of items to retrieve. Possible values include:

  • popular (All invalid options will equal to this)
  • trending
  • latest
  • friends
  • followed - Items of people the player is following on Steam
  • friend_favs - Favorites of player's friends
  • favorite - Player's favorites
2 table tags
A table of tags to match.
3 number offset
How much of results to skip from first one. This is useful for pagination. Negative values are invalid.
4 number numRetrieve
How many items to retrieve, up to 50 at a time. Negative values are invalid.
5 number days
When getting popular or trending content from Steam, this determines a time period, in range of days from 0 to 365. ( 7 = most popular addons in last 7 days, 30 = most popular addons in the last month, etc ). If given a zero, will automatically choose a value, which is 7 for trending.
6 string userID = "0"
"0" to retrieve all addons, "1" to retrieve addons only published by you, or a valid SteamID64 of a user to get workshop items of.
7 function resultCallback
The function to process retrieved data.

Function argument(s):
1 table data - The list of items, or nil in case of error.
8 string searchText = nil
If given, will use the text to filter results.

This was recently added in version (2026.05.28). It might only be available on the Dev Branch right now.

Example

Retrieves top 10 of Steam Workshop addons.

steamworks.GetList( "popular", nil, 0, 10, 7, 0, function( data ) PrintTable( data ) end )
Output:
totalresults = 1748 numresults = 10 results: 1 = 21197 2 = 72122655 3 = 68207248 4 = 71921341 5 = 79927494 6 = 12692 7 = 21174 8 = 72145362 9 = 16221 10 = 22104

Account Management

Special Pages

Wiki List