Modio

@reset/modiov2026.10.23.1· MIT· 3d agoBEHAVIORSACCEPTED WARNINGS

01README

Record a game's mods and their mod.io stats, and summarise growth.

02Behaviors1

@reset/modiov2026.10.23.1modio.ts

Argument	Type	Required	Description
apiKey	string	yes	mod.io API key, supplied with a vault.get expression, never a literal. Sent only as the api_key query parameter to apiPath, and never written to a record, log or error
apiPath	string	yes	The API path mod.io issues with the key, e.g. https://g-1.modapi.io/v1 for a game key or https://u-1.modapi.io/v1 for a user key
game	string	yes	The game whose mods are recorded: its numeric mod.io id, or its name_id as in mod.io/g/rogue-knight

fn sample(maxPages?: number)

Read the game's mods and their stats from mod.io's REST API and record them as a new version, flagging mods new since the previous one

Argument	Type	Required	Description
maxPages?	number	no	Most pages of 100 mods to read, 1 to 20; 10 when omitted

fn summarise(since?: string, top?: number, rankBy?: enum)

Summarise the recorded samples: each mod's download and subscriber change over the history, and the fastest-growing mods

Argument	Type	Required	Description
since?	string	no	Only summarise samples recorded at or after this ISO-8601 time; all samples when omitted
top?	number	no	How many fastest-growing mods to list, 1 to 100; 10 when omitted
rankBy?	enum	no	Rank the fastest-growing mods by downloads or subscribers gained per day; downloads when omitted

mods(infinite)— One game's mods and their mod.io stats at one moment, with the mods new since the previous version

summary(infinite)— Per mod the first and latest downloads and subscribers and the change, and the fastest-growing mods

03Stats

86 / 100

Downloads

Archive size

21.0 KB

05Platforms

06Labels

04Accepted warnings1