Skip to main content
← back to extensions

Steamworks Sales

@reset/steamworks-salesv2026.10.23.1· MIT· 3d agoBEHAVIORSACCEPTED WARNINGS
01README

Record a Steam partner's daily sales aggregates and summarise them.

02Behaviors1
@reset/steamworks-salesv2026.10.23.1steamworks_sales.ts

Global Arguments

ArgumentTypeDescription
financialKeystringSteamworks financial Web API key from a Financial API Group, supplied with a vault.get expression, never a literal. Sent only as the x-webapi-key header to partner.steam-api.com
includeViewGrants?booleanAlso record sales other partners granted this partner a view of; false when omitted
fn sample(maxDates?: number, maxPages?: number)
Read the dates Valve changed since the stored highwatermark and record each day's sales aggregates as a new version
ArgumentTypeDescription
maxDates?numberMost changed dates to record in this run, 1 to 366; 31 when omitted. The rest are kept in the cursor for the next run
maxPages?numberMost GetDetailedSales pages to read for one date, 1 to 1000; 100 when omitted. A date with more fails the run
fn summarise(from?: string, to?: string)
Summarise the recorded days in a range: totals per app and country, a daily series per app, and the earlier half against the later
ArgumentTypeDescription
from?stringFirst sales day to include, YYYY-MM-DD Pacific Time; the earliest recorded when omitted
to?stringLast sales day to include, YYYY-MM-DD Pacific Time; the latest recorded when omitted

Resources

sales(infinite)— One sales day's aggregates per app, country, currency and line item type: units, and gross, returns, tax and net sales in USD. Financial data: keep it in a private datastore
cursor(infinite)— The GetChangedDatesForPartner highwatermark to send next, the dates the last run recorded and those it left for the next
summary(infinite)— Totals per app and per country, each app's daily series and the range's earlier half against its later half
03Stats
B
86 / 100
Downloads
4
Archive size
24.1 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository0/2missing

05Platforms
06Labels
#steam#game-development#sales#analytics