Steam-API-Dokumentation

Inhaltsverzeichnis

IAuthenticationService

Interface: IAuthenticationService
Methode: PollAuthSessionStatus
Version: 1
HTTP-Methode: POST
Beschreibung: poll during authentication process
Parameter Datentyp Pflicht Beschreibung
client_id uint64 Keine Beschreibung vorhanden.
request_id string Keine Beschreibung vorhanden.
token_to_revoke uint64 If this is set to a token owned by this user, that token will be retired

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IAuthenticationService', 'PollAuthSessionStatus', 1, [
    'client_id' => $client_id,
    'request_id' => $request_id,
    'token_to_revoke' => $token_to_revoke,
], 'POST');
Interface: IAuthenticationService
Methode: GetAuthSessionInfo
Version: 1
HTTP-Methode: POST
Beschreibung: get metadata of specific auth session, this will also implicitly bind the calling account
Parameter Datentyp Pflicht Beschreibung
client_id uint64 client ID from scanned QR Code, used for routing

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IAuthenticationService', 'GetAuthSessionInfo', 1, [
    'client_id' => $client_id,
], 'POST');
Interface: IAuthenticationService
Methode: GetPasswordRSAPublicKey
Version: 1
HTTP-Methode: GET
Beschreibung: Fetches RSA public key to use to encrypt passwords for a given account name
Parameter Datentyp Pflicht Beschreibung
account_name string user-provided account name to get an RSA key for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IAuthenticationService', 'GetPasswordRSAPublicKey', 1, [
    'account_name' => $account_name,
]);
Interface: IAuthenticationService
Methode: BeginAuthSessionViaCredentials
Version: 1
HTTP-Methode: POST
Beschreibung: start authentication process
Parameter Datentyp Pflicht Beschreibung
device_friendly_name string Keine Beschreibung vorhanden.
account_name string Keine Beschreibung vorhanden.
encrypted_password string password, RSA encrypted client side
encryption_timestamp uint64 timestamp to map to a key - STime
remember_login bool deprecated
platform_type {enum} Keine Beschreibung vorhanden.
persistence {enum} whether we are requesting a persistent or an ephemeral session
website_id string (EMachineAuthWebDomain) identifier of client requesting auth
device_details {message} User-supplied details about the device attempting to sign in
guard_data string steam guard data for client login
language uint32 Keine Beschreibung vorhanden.
qos_level int32 [ENetQOSLevel] client-specified priority for this auth attempt

Beispielcode:
Interface: IAuthenticationService
Methode: UpdateAuthSessionWithSteamGuardCode
Version: 1
HTTP-Methode: POST
Beschreibung: approve an authentication session via steam guard code
Parameter Datentyp Pflicht Beschreibung
client_id uint64 pending client ID, from initialized session
steamid uint64 user who wants to login
code string confirmation code
code_type {enum} type of confirmation code

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IAuthenticationService', 'UpdateAuthSessionWithSteamGuardCode', 1, [
    'client_id' => $client_id,
    'steamid' => $steamid,
    'code' => $code,
    'code_type' => $code_type,
], 'POST');
Interface: IAuthenticationService
Methode: BeginAuthSessionViaQR
Version: 1
HTTP-Methode: POST
Beschreibung: start authentication process
Parameter Datentyp Pflicht Beschreibung
device_friendly_name string Keine Beschreibung vorhanden.
platform_type {enum} Keine Beschreibung vorhanden.
device_details {message} User-supplied details about the device attempting to sign in
website_id string (EMachineAuthWebDomain) identifier of client requesting auth

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IAuthenticationService', 'BeginAuthSessionViaQR', 1, [
    'device_friendly_name' => $device_friendly_name,
    'platform_type' => $platform_type,
    'device_details' => $device_details,
    'website_id' => $website_id,
], 'POST');
Interface: IAuthenticationService
Methode: UpdateAuthSessionWithMobileConfirmation
Version: 1
HTTP-Methode: POST
Beschreibung: approve an authentication session via mobile 2fa
Parameter Datentyp Pflicht Beschreibung
version int32 version field
client_id uint64 pending client ID, from scanned QR Code
steamid uint64 user who wants to login
signature string HMAC digest over {version,client_id,steamid} via user's private key
confirm bool Whether to confirm the login (true) or deny the login (false)
persistence {enum} whether we are requesting a persistent or an ephemeral session

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IAuthenticationService', 'UpdateAuthSessionWithMobileConfirmation', 1, [
    'version' => $version,
    'client_id' => $client_id,
    'steamid' => $steamid,
    'signature' => $signature,
    'confirm' => $confirm,
    'persistence' => $persistence,
], 'POST');

IBroadcastService

Interface: IBroadcastService
Methode: PostGameDataFrameRTMP
Version: 1
HTTP-Methode: POST
Beschreibung: Add a game meta data frame to broadcast from a client. Uses RTMP token for validation
Parameter Datentyp Pflicht Beschreibung
appid uint32 AppID of the game being broadcasted
steamid uint64 Broadcasters SteamID
rtmp_token string Valid RTMP token for the Broadcaster
frame_data string game data frame expressing current state of game (string, zipped, whatever)

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IBroadcastService', 'PostGameDataFrameRTMP', 1, [
    'appid' => $appid,
    'steamid' => $steamid,
    'rtmp_token' => $rtmp_token,
    'frame_data' => $frame_data,
], 'POST');

ICSGOPlayers_730

Interface: ICSGOPlayers_730
Methode: GetNextMatchSharingCode
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The SteamID of the user
steamidkey string Authentication obtained from the SteamID
knowncode string Previously known match sharing code obtained from the SteamID

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ICSGOPlayers_730', 'GetNextMatchSharingCode', 1, [
    'steamid' => $steamid,
    'steamidkey' => $steamidkey,
    'knowncode' => $knowncode,
]);

ICSGOServers_730

Interface: ICSGOServers_730
Methode: GetGameMapsPlaytime
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
interval string What recent interval is requested, possible values: day, week, month
gamemode string What game mode is requested, possible values: competitive, casual
mapgroup string What maps are requested, possible values: operation

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ICSGOServers_730', 'GetGameMapsPlaytime', 1, [
    'interval' => $interval,
    'gamemode' => $gamemode,
    'mapgroup' => $mapgroup,
]);
Interface: ICSGOServers_730
Methode: GetGameServersStatus
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ICSGOServers_730', 'GetGameServersStatus', 1);

ICSGOTournaments_730

Interface: ICSGOTournaments_730
Methode: GetTournamentFantasyLineup
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
event uint32 The event ID
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ICSGOTournaments_730', 'GetTournamentFantasyLineup', 1, [
    'event' => $event,
    'steamid' => $steamid,
    'steamidkey' => $steamidkey,
]);
Interface: ICSGOTournaments_730
Methode: GetTournamentItems
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
event uint32 The event ID
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ICSGOTournaments_730', 'GetTournamentItems', 1, [
    'event' => $event,
    'steamid' => $steamid,
    'steamidkey' => $steamidkey,
]);
Interface: ICSGOTournaments_730
Methode: GetTournamentLayout
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
event uint32 The event ID

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ICSGOTournaments_730', 'GetTournamentLayout', 1, [
    'event' => $event,
]);
Interface: ICSGOTournaments_730
Methode: GetTournamentPredictions
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
event uint32 The event ID
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ICSGOTournaments_730', 'GetTournamentPredictions', 1, [
    'event' => $event,
    'steamid' => $steamid,
    'steamidkey' => $steamidkey,
]);
Interface: ICSGOTournaments_730
Methode: UploadTournamentFantasyLineup
Version: 1
HTTP-Methode: POST
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
event uint32 The event ID
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID
sectionid uint32 Event section id
pickid0 uint32 PickID to select for the slot
itemid0 uint64 ItemID to lock in for the pick
pickid1 uint32 PickID to select for the slot
itemid1 uint64 ItemID to lock in for the pick
pickid2 uint32 PickID to select for the slot
itemid2 uint64 ItemID to lock in for the pick
pickid3 uint32 PickID to select for the slot
itemid3 uint64 ItemID to lock in for the pick
pickid4 uint32 PickID to select for the slot
itemid4 uint64 ItemID to lock in for the pick

Beispielcode:
Interface: ICSGOTournaments_730
Methode: UploadTournamentPredictions
Version: 1
HTTP-Methode: POST
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
event uint32 The event ID
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID
sectionid uint32 Event section id
groupid uint32 Event group id
index uint32 Index in group
pickid uint32 Pick ID to select
itemid uint64 ItemID to lock in for the pick

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ICSGOTournaments_730', 'UploadTournamentPredictions', 1, [
    'event' => $event,
    'steamid' => $steamid,
    'steamidkey' => $steamidkey,
    'sectionid' => $sectionid,
    'groupid' => $groupid,
    'index' => $index,
    'pickid' => $pickid,
    'itemid' => $itemid,
], 'POST');

ICheatReportingService

Interface: ICheatReportingService
Methode: ReportCheatData
Version: 1
HTTP-Methode: POST
Beschreibung: Reports cheat data. Only use on test account that is running the game but not in a multiplayer session.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 steamid of the user running and reporting the cheat.
appid uint32 The appid.
pathandfilename string path and file name of the cheat executable.
webcheaturl string web url where the cheat was found and downloaded.
time_now uint64 local system time now.
time_started uint64 local system time when cheat process started. ( 0 if not yet run )
time_stopped uint64 local system time when cheat process stopped. ( 0 if still running )
cheatname string descriptive name for the cheat.
game_process_id uint32 process ID of the running game.
cheat_process_id uint32 process ID of the cheat process that ran
cheat_param_1 uint64 cheat param 1
cheat_param_2 uint64 cheat param 2
cheat_data_dump string data collection in json format

Beispielcode:

IClientStats_1046930

Interface: IClientStats_1046930
Methode: ReportEvent
Version: 1
HTTP-Methode: POST
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IClientStats_1046930', 'ReportEvent', 1, [], 'POST');

IContentServerConfigService

Interface: IContentServerConfigService
Methode: SetSteamCacheClientFilters
Version: 1
HTTP-Methode: POST
Beschreibung: Update the client filters for a SteamCache node
Parameter Datentyp Pflicht Beschreibung
cache_id uint32 Unique ID number
cache_key string Valid current cache API key
change_notes string Notes
allowed_ip_blocks string comma-separated list of allowed IP address blocks in CIDR format - blank to clear unfilter

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IContentServerConfigService', 'SetSteamCacheClientFilters', 1, [
    'cache_id' => $cache_id,
    'cache_key' => $cache_key,
    'change_notes' => $change_notes,
    'allowed_ip_blocks' => $allowed_ip_blocks,
], 'POST');
Interface: IContentServerConfigService
Methode: GetSteamCacheNodeParams
Version: 1
HTTP-Methode: GET
Beschreibung: Get the operational parameters for a SteamCache node (information the node uses to operate).
Parameter Datentyp Pflicht Beschreibung
cache_id uint32 Unique ID number
cache_key string Valid current cache API key

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IContentServerConfigService', 'GetSteamCacheNodeParams', 1, [
    'cache_id' => $cache_id,
    'cache_key' => $cache_key,
]);
Interface: IContentServerConfigService
Methode: SetSteamCachePerformanceStats
Version: 1
HTTP-Methode: POST
Beschreibung: Update the performance/load stats for a SteamCache node
Parameter Datentyp Pflicht Beschreibung
cache_id uint32 Unique ID number
cache_key string Valid current cache API key
mbps_sent uint32 Outgoing network traffic in Mbps
mbps_recv uint32 Incoming network traffic in Mbps
cpu_percent uint32 Percent CPU load
cache_hit_percent uint32 Percent cache hits
num_connected_ips uint32 Number of unique connected IP addresses
upstream_egress_utilization uint32 (deprecated) What is the percent utilization of the busiest datacenter egress link?
upstream_peering_utilization uint32 What is the percent utilization of the busiest peering link?
upstream_transit_utilization uint32 What is the percent utilization of the busiest transit link?

Beispielcode:

IContentServerDirectoryService

Interface: IContentServerDirectoryService
Methode: GetCDNForVideo
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
property_type int32 ECDNPropertyType
client_ip string client IP address
client_region string client region

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IContentServerDirectoryService', 'GetCDNForVideo', 1, [
    'property_type' => $property_type,
    'client_ip' => $client_ip,
    'client_region' => $client_region,
]);
Interface: IContentServerDirectoryService
Methode: PickSingleContentServer
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
property_type int32 ECDNPropertyType
cell_id uint32 client Cell ID
client_ip string client IP address

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IContentServerDirectoryService', 'PickSingleContentServer', 1, [
    'property_type' => $property_type,
    'cell_id' => $cell_id,
    'client_ip' => $client_ip,
]);
Interface: IContentServerDirectoryService
Methode: GetServersForSteamPipe
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
cell_id uint32 client Cell ID
max_servers uint32 max servers in response list
ip_override string client IP address
launcher_type int32 launcher type
ipv6_public string client public ipv6 address if it knows it
current_connections {message} what sources is the client currently using

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IContentServerDirectoryService', 'GetServersForSteamPipe', 1, [
    'cell_id' => $cell_id,
    'max_servers' => $max_servers,
    'ip_override' => $ip_override,
    'launcher_type' => $launcher_type,
    'ipv6_public' => $ipv6_public,
    'current_connections' => $current_connections,
]);
Interface: IContentServerDirectoryService
Methode: GetClientUpdateHosts
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
cached_signature string Keine Beschreibung vorhanden.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IContentServerDirectoryService', 'GetClientUpdateHosts', 1, [
    'cached_signature' => $cached_signature,
]);
Interface: IContentServerDirectoryService
Methode: GetDepotPatchInfo
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
appid uint32 Keine Beschreibung vorhanden.
depotid uint32 Keine Beschreibung vorhanden.
source_manifestid uint64 Keine Beschreibung vorhanden.
target_manifestid uint64 Keine Beschreibung vorhanden.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IContentServerDirectoryService', 'GetDepotPatchInfo', 1, [
    'appid' => $appid,
    'depotid' => $depotid,
    'source_manifestid' => $source_manifestid,
    'target_manifestid' => $target_manifestid,
]);

IDOTA2MatchStats_570

Interface: IDOTA2MatchStats_570
Methode: GetRealtimeStats
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
server_steam_id uint64

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2MatchStats_570', 'GetRealtimeStats', 1, [
    'server_steam_id' => $server_steam_id,
]);

IDOTA2Match_570

Interface: IDOTA2Match_570
Methode: GetLiveLeagueGames
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
league_id uint32 Only show matches of the specified league id
match_id uint64 Only show matches of the specified match id
dpc bool Only show matches that are part of the DPC

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2Match_570', 'GetLiveLeagueGames', 1, [
    'league_id' => $league_id,
    'match_id' => $match_id,
    'dpc' => $dpc,
]);
Interface: IDOTA2Match_570
Methode: GetMatchDetails
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
match_id uint64 Match id
include_persona_names bool Include persona names as part of the response

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2Match_570', 'GetMatchDetails', 1, [
    'match_id' => $match_id,
    'include_persona_names' => $include_persona_names,
]);
Interface: IDOTA2Match_570
Methode: GetMatchHistory
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
hero_id uint32 The ID of the hero that must be in the matches being queried
game_mode uint32 Which game mode to return matches for
skill uint32 The average skill range of the match, these can be [1-3] with lower numbers being lower skill. Ignored if an account ID is specified
min_players string Minimum number of human players that must be in a match for it to be returned
account_id string An account ID to get matches from. This will fail if the user has their match history hidden
league_id string The league ID to return games from
start_at_match_id uint64 The minimum match ID to start from
matches_requested string The number of requested matches to return (maximum 100)

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2Match_570', 'GetMatchHistory', 1, [
    'hero_id' => $hero_id,
    'game_mode' => $game_mode,
    'skill' => $skill,
    'min_players' => $min_players,
    'account_id' => $account_id,
    'league_id' => $league_id,
    'start_at_match_id' => $start_at_match_id,
    'matches_requested' => $matches_requested,
]);
Interface: IDOTA2Match_570
Methode: GetMatchHistoryBySequenceNum
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
start_at_match_seq_num uint64
matches_requested uint32

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2Match_570', 'GetMatchHistoryBySequenceNum', 1, [
    'start_at_match_seq_num' => $start_at_match_seq_num,
    'matches_requested' => $matches_requested,
]);
Interface: IDOTA2Match_570
Methode: GetTeamInfoByTeamID
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
start_at_team_id uint64
teams_requested uint32

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2Match_570', 'GetTeamInfoByTeamID', 1, [
    'start_at_team_id' => $start_at_team_id,
    'teams_requested' => $teams_requested,
]);
Interface: IDOTA2Match_570
Methode: GetTopLiveEventGame
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
partner int32 Which partner's games to use.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2Match_570', 'GetTopLiveEventGame', 1, [
    'partner' => $partner,
]);
Interface: IDOTA2Match_570
Methode: GetTopLiveGame
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
partner int32 Which partner's games to use.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2Match_570', 'GetTopLiveGame', 1, [
    'partner' => $partner,
]);
Interface: IDOTA2Match_570
Methode: GetTopWeekendTourneyGames
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
partner int32 Which partner's games to use.
home_division int32 Prefer matches from this division.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2Match_570', 'GetTopWeekendTourneyGames', 1, [
    'partner' => $partner,
    'home_division' => $home_division,
]);
Interface: IDOTA2Match_570
Methode: GetTournamentPlayerStats
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
account_id string
league_id string
hero_id string
time_frame string
match_id uint64

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2Match_570', 'GetTournamentPlayerStats', 1, [
    'account_id' => $account_id,
    'league_id' => $league_id,
    'hero_id' => $hero_id,
    'time_frame' => $time_frame,
    'match_id' => $match_id,
]);
Interface: IDOTA2Match_570
Methode: GetTournamentPlayerStats
Version: 2
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
account_id string
league_id string
hero_id string
time_frame string
match_id uint64
phase_id uint32

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2Match_570', 'GetTournamentPlayerStats', 2, [
    'account_id' => $account_id,
    'league_id' => $league_id,
    'hero_id' => $hero_id,
    'time_frame' => $time_frame,
    'match_id' => $match_id,
    'phase_id' => $phase_id,
]);

IDOTA2StreamSystem_570

Interface: IDOTA2StreamSystem_570
Methode: GetBroadcasterInfo
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
broadcaster_steam_id uint64 64-bit Steam ID of the broadcaster
league_id uint32 LeagueID to use if we aren't in a lobby

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2StreamSystem_570', 'GetBroadcasterInfo', 1, [
    'broadcaster_steam_id' => $broadcaster_steam_id,
    'league_id' => $league_id,
]);

IDOTA2Ticket_570

Interface: IDOTA2Ticket_570
Methode: GetSteamIDForBadgeID
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
BadgeID string The badge ID

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2Ticket_570', 'GetSteamIDForBadgeID', 1, [
    'BadgeID' => $BadgeID,
]);
Interface: IDOTA2Ticket_570
Methode: SetSteamAccountPurchased
Version: 1
HTTP-Methode: POST
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The 64-bit Steam ID
BadgeType uint32 Badge Type

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2Ticket_570', 'SetSteamAccountPurchased', 1, [
    'steamid' => $steamid,
    'BadgeType' => $BadgeType,
], 'POST');
Interface: IDOTA2Ticket_570
Methode: SteamAccountValidForBadgeType
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The 64-bit Steam ID
ValidBadgeType1 uint32 Valid Badge Type 1
ValidBadgeType2 uint32 Valid Badge Type 2
ValidBadgeType3 uint32 Valid Badge Type 3
ValidBadgeType4 uint32 Valid Badge Type 4

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IDOTA2Ticket_570', 'SteamAccountValidForBadgeType', 1, [
    'steamid' => $steamid,
    'ValidBadgeType1' => $ValidBadgeType1,
    'ValidBadgeType2' => $ValidBadgeType2,
    'ValidBadgeType3' => $ValidBadgeType3,
    'ValidBadgeType4' => $ValidBadgeType4,
]);

IEconDOTA2_570

Interface: IEconDOTA2_570
Methode: GetEventStatsForAccount
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
eventid uint32 The Event ID of the event you're looking for.
accountid uint32 The account ID to look up.
language string The language to provide hero names in.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconDOTA2_570', 'GetEventStatsForAccount', 1, [
    'eventid' => $eventid,
    'accountid' => $accountid,
    'language' => $language,
]);
Interface: IEconDOTA2_570
Methode: GetHeroes
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
language string The language to provide hero names in.
itemizedonly bool Return a list of itemized heroes only.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconDOTA2_570', 'GetHeroes', 1, [
    'language' => $language,
    'itemizedonly' => $itemizedonly,
]);
Interface: IEconDOTA2_570
Methode: GetItemCreators
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
itemdef uint32 The item definition to get creator information for.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconDOTA2_570', 'GetItemCreators', 1, [
    'itemdef' => $itemdef,
]);
Interface: IEconDOTA2_570
Methode: GetItemWorkshopPublishedFileIDs
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
itemdef uint32 The item definition to get published file ids for.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconDOTA2_570', 'GetItemWorkshopPublishedFileIDs', 1, [
    'itemdef' => $itemdef,
]);
Interface: IEconDOTA2_570
Methode: GetRarities
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
language string The language to provide rarity names in.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconDOTA2_570', 'GetRarities', 1, [
    'language' => $language,
]);
Interface: IEconDOTA2_570
Methode: GetTournamentPrizePool
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
leagueid uint32 The ID of the league to get the prize pool of

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconDOTA2_570', 'GetTournamentPrizePool', 1, [
    'leagueid' => $leagueid,
]);

IEconItems_1046930

Interface: IEconItems_1046930
Methode: GetPlayerItems
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The Steam ID to fetch items for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_1046930', 'GetPlayerItems', 1, [
    'steamid' => $steamid,
]);

IEconItems_1269260

Interface: IEconItems_1269260
Methode: GetEquippedPlayerItems
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The Steam ID to fetch items for
class_id uint32 Return items equipped for this class id

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_1269260', 'GetEquippedPlayerItems', 1, [
    'steamid' => $steamid,
    'class_id' => $class_id,
]);

IEconItems_221540

Interface: IEconItems_221540
Methode: GetPlayerItems
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The Steam ID to fetch items for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_221540', 'GetPlayerItems', 1, [
    'steamid' => $steamid,
]);

IEconItems_238460

Interface: IEconItems_238460
Methode: GetPlayerItems
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The Steam ID to fetch items for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_238460', 'GetPlayerItems', 1, [
    'steamid' => $steamid,
]);

IEconItems_440

Interface: IEconItems_440
Methode: GetPlayerItems
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The Steam ID to fetch items for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_440', 'GetPlayerItems', 1, [
    'steamid' => $steamid,
]);
Interface: IEconItems_440
Methode: GetSchema
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
language string The language to return the names in. Defaults to returning string keys.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_440', 'GetSchema', 1, [
    'language' => $language,
]);
Interface: IEconItems_440
Methode: GetSchemaItems
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
language string The language to return the names in. Defaults to returning string keys.
start int32 The first item id to return. Defaults to 0. Response will indicate next value to query if applicable.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_440', 'GetSchemaItems', 1, [
    'language' => $language,
    'start' => $start,
]);
Interface: IEconItems_440
Methode: GetSchemaOverview
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
language string The language to return the names in. Defaults to returning string keys.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_440', 'GetSchemaOverview', 1, [
    'language' => $language,
]);
Interface: IEconItems_440
Methode: GetSchemaURL
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_440', 'GetSchemaURL', 1);
Interface: IEconItems_440
Methode: GetStoreMetaData
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
language string The language to results in.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_440', 'GetStoreMetaData', 1, [
    'language' => $language,
]);
Interface: IEconItems_440
Methode: GetStoreStatus
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_440', 'GetStoreStatus', 1);

IEconItems_570

Interface: IEconItems_570
Methode: GetPlayerItems
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The Steam ID to fetch items for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_570', 'GetPlayerItems', 1, [
    'steamid' => $steamid,
]);
Interface: IEconItems_570
Methode: GetStoreMetaData
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
language string The language to results in.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_570', 'GetStoreMetaData', 1, [
    'language' => $language,
]);

IEconItems_583950

Interface: IEconItems_583950
Methode: GetEquippedPlayerItems
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The Steam ID to fetch items for
class_id uint32 Return items equipped for this class id

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_583950', 'GetEquippedPlayerItems', 1, [
    'steamid' => $steamid,
    'class_id' => $class_id,
]);

IEconItems_620

Interface: IEconItems_620
Methode: GetPlayerItems
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The Steam ID to fetch items for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_620', 'GetPlayerItems', 1, [
    'steamid' => $steamid,
]);
Interface: IEconItems_620
Methode: GetSchema
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
language string The language to return the names in. Defaults to returning string keys.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_620', 'GetSchema', 1, [
    'language' => $language,
]);

IEconItems_730

Interface: IEconItems_730
Methode: GetPlayerItems
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The Steam ID to fetch items for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_730', 'GetPlayerItems', 1, [
    'steamid' => $steamid,
]);
Interface: IEconItems_730
Methode: GetSchema
Version: 2
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
language string The language to return the names in. Defaults to returning string keys.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_730', 'GetSchema', 2, [
    'language' => $language,
]);
Interface: IEconItems_730
Methode: GetSchemaURL
Version: 2
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_730', 'GetSchemaURL', 2);
Interface: IEconItems_730
Methode: GetStoreMetaData
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
language string The language to results in.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconItems_730', 'GetStoreMetaData', 1, [
    'language' => $language,
]);

IEconService

Interface: IEconService
Methode: GetTradeHistory
Version: 1
HTTP-Methode: GET
Beschreibung: Gets a history of trades
Parameter Datentyp Pflicht Beschreibung
max_trades uint32 The number of trades to return information for
start_after_time uint32 The time of the last trade shown on the previous page of results, or the time of the first trade if navigating back
start_after_tradeid uint64 The tradeid shown on the previous page of results, or the ID of the first trade if navigating back
navigating_back bool The user wants the previous page of results, so return the previous max_trades trades before the start time and ID
get_descriptions bool If set, the item display data for the items included in the returned trades will also be returned
language string The language to use when loading item display data
include_failed bool Keine Beschreibung vorhanden.
include_total bool If set, the total number of trades the account has participated in will be included in the response

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconService', 'GetTradeHistory', 1, [
    'max_trades' => $max_trades,
    'start_after_time' => $start_after_time,
    'start_after_tradeid' => $start_after_tradeid,
    'navigating_back' => $navigating_back,
    'get_descriptions' => $get_descriptions,
    'language' => $language,
    'include_failed' => $include_failed,
    'include_total' => $include_total,
]);
Interface: IEconService
Methode: GetTradeStatus
Version: 1
HTTP-Methode: GET
Beschreibung: Gets status for a specific trade
Parameter Datentyp Pflicht Beschreibung
tradeid uint64 Keine Beschreibung vorhanden.
get_descriptions bool If set, the item display data for the items included in the returned trades will also be returned
language string The language to use when loading item display data

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconService', 'GetTradeStatus', 1, [
    'tradeid' => $tradeid,
    'get_descriptions' => $get_descriptions,
    'language' => $language,
]);
Interface: IEconService
Methode: GetTradeOffers
Version: 1
HTTP-Methode: GET
Beschreibung: Get a list of sent or received trade offers
Parameter Datentyp Pflicht Beschreibung
get_sent_offers bool Request the list of sent offers.
get_received_offers bool Request the list of received offers.
get_descriptions bool If set, the item display data for the items included in the returned trade offers will also be returned. If one or more descriptions can't be retrieved, then your request will fail.
language string The language to use when loading item display data.
active_only bool Indicates we should only return offers which are still active, or offers that have changed in state since the time_historical_cutoff
historical_only bool Indicates we should only return offers which are not active.
time_historical_cutoff uint32 When active_only is set, offers updated since this time will also be returned. When historical_only is set, only offers updated since this time are included.
cursor uint32 Cursor aka start index

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconService', 'GetTradeOffers', 1, [
    'get_sent_offers' => $get_sent_offers,
    'get_received_offers' => $get_received_offers,
    'get_descriptions' => $get_descriptions,
    'language' => $language,
    'active_only' => $active_only,
    'historical_only' => $historical_only,
    'time_historical_cutoff' => $time_historical_cutoff,
    'cursor' => $cursor,
]);
Interface: IEconService
Methode: GetTradeOffer
Version: 1
HTTP-Methode: GET
Beschreibung: Gets a specific trade offer
Parameter Datentyp Pflicht Beschreibung
tradeofferid uint64 Keine Beschreibung vorhanden.
language string Keine Beschreibung vorhanden.
get_descriptions bool If set, the item display data for the items included in the returned trade offers will also be returned. If one or more descriptions can't be retrieved, then your request will fail.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconService', 'GetTradeOffer', 1, [
    'tradeofferid' => $tradeofferid,
    'language' => $language,
    'get_descriptions' => $get_descriptions,
]);
Interface: IEconService
Methode: GetTradeOffersSummary
Version: 1
HTTP-Methode: GET
Beschreibung: Get counts of pending and new trade offers
Parameter Datentyp Pflicht Beschreibung
time_last_visit uint32 The time the user last visited. If not passed, will use the time the user last visited the trade offer page.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconService', 'GetTradeOffersSummary', 1, [
    'time_last_visit' => $time_last_visit,
]);
Interface: IEconService
Methode: GetTradeHoldDurations
Version: 1
HTTP-Methode: GET
Beschreibung: Returns the estimated hold duration and end date that a trade with a user would have
Parameter Datentyp Pflicht Beschreibung
steamid_target uint64 User you are trading with
trade_offer_access_token string A special token that allows for trade offers from non-friends.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IEconService', 'GetTradeHoldDurations', 1, [
    'steamid_target' => $steamid_target,
    'trade_offer_access_token' => $trade_offer_access_token,
]);

IGCVersion_1046930

Interface: IGCVersion_1046930
Methode: GetClientVersion
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGCVersion_1046930', 'GetClientVersion', 1);
Interface: IGCVersion_1046930
Methode: GetServerVersion
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGCVersion_1046930', 'GetServerVersion', 1);

IGCVersion_1269260

Interface: IGCVersion_1269260
Methode: GetClientVersion
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGCVersion_1269260', 'GetClientVersion', 1);
Interface: IGCVersion_1269260
Methode: GetServerVersion
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGCVersion_1269260', 'GetServerVersion', 1);

IGCVersion_440

Interface: IGCVersion_440
Methode: GetClientVersion
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGCVersion_440', 'GetClientVersion', 1);
Interface: IGCVersion_440
Methode: GetServerVersion
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGCVersion_440', 'GetServerVersion', 1);

IGCVersion_570

Interface: IGCVersion_570
Methode: GetClientVersion
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGCVersion_570', 'GetClientVersion', 1);
Interface: IGCVersion_570
Methode: GetServerVersion
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGCVersion_570', 'GetServerVersion', 1);

IGCVersion_583950

Interface: IGCVersion_583950
Methode: GetClientVersion
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGCVersion_583950', 'GetClientVersion', 1);
Interface: IGCVersion_583950
Methode: GetServerVersion
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGCVersion_583950', 'GetServerVersion', 1);

IGCVersion_730

Interface: IGCVersion_730
Methode: GetServerVersion
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGCVersion_730', 'GetServerVersion', 1);

IGameNotificationsService

Interface: IGameNotificationsService
Methode: UserCreateSession
Version: 1
HTTP-Methode: POST
Beschreibung: Creates an async game session
Parameter Datentyp Pflicht Beschreibung
appid uint32 The appid to create the session for.
context uint64 Game-specified context value the game can used to associate the session with some object on their backend.
title {message} The title of the session to be displayed within each user's list of sessions.
users {message} The initial state of all users in the session.
steamid uint64 (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGameNotificationsService', 'UserCreateSession', 1, [
    'appid' => $appid,
    'context' => $context,
    'title' => $title,
    'users' => $users,
    'steamid' => $steamid,
], 'POST');
Interface: IGameNotificationsService
Methode: UserUpdateSession
Version: 1
HTTP-Methode: POST
Beschreibung: Updates an async game session
Parameter Datentyp Pflicht Beschreibung
sessionid uint64 The sessionid to update.
appid uint32 The appid of the session to update.
title {message} (Optional) The new title of the session. If not specified, the title will not be changed.
users {message} (Optional) A list of users whose state will be updated to reflect the given state. If the users are not already in the session, they will be added to it.
steamid uint64 (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGameNotificationsService', 'UserUpdateSession', 1, [
    'sessionid' => $sessionid,
    'appid' => $appid,
    'title' => $title,
    'users' => $users,
    'steamid' => $steamid,
], 'POST');
Interface: IGameNotificationsService
Methode: UserDeleteSession
Version: 1
HTTP-Methode: POST
Beschreibung: Deletes an async game session
Parameter Datentyp Pflicht Beschreibung
sessionid uint64 The sessionid to delete.
appid uint32 The appid of the session to delete.
steamid uint64 (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGameNotificationsService', 'UserDeleteSession', 1, [
    'sessionid' => $sessionid,
    'appid' => $appid,
    'steamid' => $steamid,
], 'POST');

IGameServersService

Interface: IGameServersService
Methode: GetAccountList
Version: 1
HTTP-Methode: GET
Beschreibung: Gets a list of game server accounts with their logon tokens

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGameServersService', 'GetAccountList', 1);
Interface: IGameServersService
Methode: CreateAccount
Version: 1
HTTP-Methode: POST
Beschreibung: Creates a persistent game server account
Parameter Datentyp Pflicht Beschreibung
appid uint32 The app to use the account for
memo string The memo to set on the new account

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGameServersService', 'CreateAccount', 1, [
    'appid' => $appid,
    'memo' => $memo,
], 'POST');
Interface: IGameServersService
Methode: SetMemo
Version: 1
HTTP-Methode: POST
Beschreibung: This method changes the memo associated with the game server account. Memos do not affect the account in any way. The memo shows up in the GetAccountList response and serves only as a reminder of what the account is used for.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The SteamID of the game server to set the memo on
memo string The memo to set on the new account

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGameServersService', 'SetMemo', 1, [
    'steamid' => $steamid,
    'memo' => $memo,
], 'POST');
Interface: IGameServersService
Methode: ResetLoginToken
Version: 1
HTTP-Methode: POST
Beschreibung: Generates a new login token for the specified game server
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The SteamID of the game server to reset the login token of

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGameServersService', 'ResetLoginToken', 1, [
    'steamid' => $steamid,
], 'POST');
Interface: IGameServersService
Methode: DeleteAccount
Version: 1
HTTP-Methode: POST
Beschreibung: Deletes a persistent game server account
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The SteamID of the game server account to delete

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGameServersService', 'DeleteAccount', 1, [
    'steamid' => $steamid,
], 'POST');
Interface: IGameServersService
Methode: GetAccountPublicInfo
Version: 1
HTTP-Methode: GET
Beschreibung: Gets public information about a given game server account
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The SteamID of the game server to get info on

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGameServersService', 'GetAccountPublicInfo', 1, [
    'steamid' => $steamid,
]);
Interface: IGameServersService
Methode: QueryLoginToken
Version: 1
HTTP-Methode: GET
Beschreibung: Queries the status of the specified token, which must be owned by you
Parameter Datentyp Pflicht Beschreibung
login_token string Login token to query

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGameServersService', 'QueryLoginToken', 1, [
    'login_token' => $login_token,
]);
Interface: IGameServersService
Methode: GetServerSteamIDsByIP
Version: 1
HTTP-Methode: GET
Beschreibung: Gets a list of server SteamIDs given a list of IPs
Parameter Datentyp Pflicht Beschreibung
server_ips string Keine Beschreibung vorhanden.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGameServersService', 'GetServerSteamIDsByIP', 1, [
    'server_ips' => $server_ips,
]);
Interface: IGameServersService
Methode: GetServerIPsBySteamID
Version: 1
HTTP-Methode: GET
Beschreibung: Gets a list of server IP addresses given a list of SteamIDs
Parameter Datentyp Pflicht Beschreibung
server_steamids uint64 Keine Beschreibung vorhanden.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGameServersService', 'GetServerIPsBySteamID', 1, [
    'server_steamids' => $server_steamids,
]);
Interface: IGameServersService
Methode: QueryByFakeIP
Version: 1
HTTP-Methode: GET
Beschreibung: Perform a query on a specific server by FakeIP
Parameter Datentyp Pflicht Beschreibung
fake_ip uint32 FakeIP of server to query.
fake_port uint32 Fake port of server to query.
app_id uint32 AppID to use. Each AppID has its own FakeIP address.
query_type {enum} What type of query?

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IGameServersService', 'QueryByFakeIP', 1, [
    'fake_ip' => $fake_ip,
    'fake_port' => $fake_port,
    'app_id' => $app_id,
    'query_type' => $query_type,
]);

IHelpRequestLogsService

Interface: IHelpRequestLogsService
Methode: UploadUserApplicationLog
Version: 1
HTTP-Methode: POST
Beschreibung: User uploading application logs
Parameter Datentyp Pflicht Beschreibung
appid uint32 Keine Beschreibung vorhanden.
log_type string Keine Beschreibung vorhanden.
version_string string Keine Beschreibung vorhanden.
log_contents string Keine Beschreibung vorhanden.
request_id uint64 Keine Beschreibung vorhanden.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IHelpRequestLogsService', 'UploadUserApplicationLog', 1, [
    'appid' => $appid,
    'log_type' => $log_type,
    'version_string' => $version_string,
    'log_contents' => $log_contents,
    'request_id' => $request_id,
], 'POST');
Interface: IHelpRequestLogsService
Methode: GetApplicationLogDemand
Version: 1
HTTP-Methode: POST
Beschreibung: Returns whether the server would like the user to upload logs
Parameter Datentyp Pflicht Beschreibung
appid uint32 Keine Beschreibung vorhanden.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IHelpRequestLogsService', 'GetApplicationLogDemand', 1, [
    'appid' => $appid,
], 'POST');

IInventoryService

Interface: IInventoryService
Methode: SplitItemStack
Version: 1
HTTP-Methode: POST
Beschreibung: Split an item stack into two stacks
Parameter Datentyp Pflicht Beschreibung
appid uint32 Keine Beschreibung vorhanden.
itemid uint64 Keine Beschreibung vorhanden.
quantity uint32 Keine Beschreibung vorhanden.
steamid uint64 Keine Beschreibung vorhanden.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IInventoryService', 'SplitItemStack', 1, [
    'appid' => $appid,
    'itemid' => $itemid,
    'quantity' => $quantity,
    'steamid' => $steamid,
], 'POST');
Interface: IInventoryService
Methode: CombineItemStacks
Version: 1
HTTP-Methode: POST
Beschreibung: Combine two stacks of items
Parameter Datentyp Pflicht Beschreibung
appid uint32 Keine Beschreibung vorhanden.
fromitemid uint64 Keine Beschreibung vorhanden.
destitemid uint64 Keine Beschreibung vorhanden.
quantity uint32 Keine Beschreibung vorhanden.
steamid uint64 Keine Beschreibung vorhanden.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IInventoryService', 'CombineItemStacks', 1, [
    'appid' => $appid,
    'fromitemid' => $fromitemid,
    'destitemid' => $destitemid,
    'quantity' => $quantity,
    'steamid' => $steamid,
], 'POST');
Interface: IInventoryService
Methode: GetPriceSheet
Version: 1
HTTP-Methode: GET
Beschreibung: Get the Inventory Service price sheet
Parameter Datentyp Pflicht Beschreibung
ecurrency int32 Keine Beschreibung vorhanden.
currency_code string Standard short code of the requested currency (preferred)

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IInventoryService', 'GetPriceSheet', 1, [
    'ecurrency' => $ecurrency,
    'currency_code' => $currency_code,
]);

IPlayerService

Interface: IPlayerService
Methode: IsPlayingSharedGame
Version: 1
HTTP-Methode: GET
Beschreibung: Obsolete, partners should use ISteamUser.CheckAppOwnership
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The player we're asking about
appid_playing uint32 The game player is currently playing

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IPlayerService', 'IsPlayingSharedGame', 1, [
    'steamid' => $steamid,
    'appid_playing' => $appid_playing,
]);
Interface: IPlayerService
Methode: RecordOfflinePlaytime
Version: 1
HTTP-Methode: POST
Beschreibung: Tracks playtime for a user when they are offline
Parameter Datentyp Pflicht Beschreibung
steamid uint64 Keine Beschreibung vorhanden.
ticket string Keine Beschreibung vorhanden.
play_sessions {message} Keine Beschreibung vorhanden.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IPlayerService', 'RecordOfflinePlaytime', 1, [
    'steamid' => $steamid,
    'ticket' => $ticket,
    'play_sessions' => $play_sessions,
], 'POST');
Interface: IPlayerService
Methode: GetRecentlyPlayedGames
Version: 1
HTTP-Methode: GET
Beschreibung: Gets information about a player's recently played games
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The player we're asking about
count uint32 The number of games to return (0/unset: all)

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IPlayerService', 'GetRecentlyPlayedGames', 1, [
    'steamid' => $steamid,
    'count' => $count,
]);
Interface: IPlayerService
Methode: GetOwnedGames
Version: 1
HTTP-Methode: GET
Beschreibung: Return a list of games owned by the player
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The player we're asking about
include_appinfo bool true if we want additional details (name, icon) about each game
include_played_free_games bool Free games are excluded by default. If this is set, free games the user has played will be returned.
appids_filter uint32 if set, restricts result set to the passed in apps
include_free_sub bool Some games are in the free sub, which are excluded by default.
skip_unvetted_apps bool if set, skip unvetted store apps
language string Will return appinfo in this language
include_extended_appinfo bool true if we want even more details (capsule, sortas, and capabilities) about each game. include_appinfo must also be true.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IPlayerService', 'GetOwnedGames', 1, [
    'steamid' => $steamid,
    'include_appinfo' => $include_appinfo,
    'include_played_free_games' => $include_played_free_games,
    'appids_filter' => $appids_filter,
    'include_free_sub' => $include_free_sub,
    'skip_unvetted_apps' => $skip_unvetted_apps,
    'language' => $language,
    'include_extended_appinfo' => $include_extended_appinfo,
]);
Interface: IPlayerService
Methode: GetSteamLevel
Version: 1
HTTP-Methode: GET
Beschreibung: Returns the Steam Level of a user
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The player we're asking about

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IPlayerService', 'GetSteamLevel', 1, [
    'steamid' => $steamid,
]);
Interface: IPlayerService
Methode: GetBadges
Version: 1
HTTP-Methode: GET
Beschreibung: Gets badges that are owned by a specific user
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The player we're asking about

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IPlayerService', 'GetBadges', 1, [
    'steamid' => $steamid,
]);
Interface: IPlayerService
Methode: GetCommunityBadgeProgress
Version: 1
HTTP-Methode: GET
Beschreibung: Gets all the quests needed to get the specified badge, and which are completed
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The player we're asking about
badgeid int32 The badge we're asking about

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IPlayerService', 'GetCommunityBadgeProgress', 1, [
    'steamid' => $steamid,
    'badgeid' => $badgeid,
]);

IPortal2Leaderboards_620

Interface: IPortal2Leaderboards_620
Methode: GetBucketizedData
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
leaderboardName string The leaderboard name to fetch data for.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IPortal2Leaderboards_620', 'GetBucketizedData', 1, [
    'leaderboardName' => $leaderboardName,
]);

IPublishedFileService

Interface: IPublishedFileService
Methode: GetUserVoteSummary
Version: 1
HTTP-Methode: GET
Beschreibung: Get user vote summary
Parameter Datentyp Pflicht Beschreibung
publishedfileids uint64 Keine Beschreibung vorhanden.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IPublishedFileService', 'GetUserVoteSummary', 1, [
    'publishedfileids' => $publishedfileids,
]);
Interface: IPublishedFileService
Methode: QueryFiles
Version: 1
HTTP-Methode: GET
Beschreibung: Performs a search query for published files
Parameter Datentyp Pflicht Beschreibung
query_type uint32 enumeration EPublishedFileQueryType in clientenums.h
page uint32 Current page
cursor string Cursor to paginate through the results (set to '*' for the first request). Prefer this over using the page parameter, as it will allow you to do deep pagination. When used, the page parameter will be ignored.
numperpage uint32 (Optional) The number of results, per page to return.
creator_appid uint32 App that created the files
appid uint32 App that consumes the files
requiredtags string Tags to match on. See match_all_tags parameter below
excludedtags string (Optional) Tags that must NOT be present on a published file to satisfy the query.
match_all_tags bool If true, then items must have all the tags specified, otherwise they must have at least one of the tags.
required_flags string Required flags that must be set on any returned items
omitted_flags string Flags that must not be set on any returned items
search_text string Text to match in the item's title or description
filetype uint32 EPublishedFileInfoMatchingFileType
child_publishedfileid uint64 Find all items that reference the given item.
days uint32 If query_type is k_PublishedFileQueryType_RankedByTrend, then this is the number of days to get votes for [1,7].
include_recent_votes_only bool If query_type is k_PublishedFileQueryType_RankedByTrend, then limit result set just to items that have votes within the day range given
cache_max_age_seconds uint32 Allow stale data to be returned for the specified number of seconds.
language int32 Language to search in and also what gets returned. Defaults to English.
required_kv_tags {message} Required key-value tags to match on.
taggroups {message} (Optional) At least one of the tags must be present on a published file to satisfy the query.
date_range_created {message} (Optional) Filter to items created within this range.
date_range_updated {message} (Optional) Filter to items updated within this range.
excluded_content_descriptors {enum} (Optional) Filter out items that have these content descriptors.
admin_query bool Admin tool is doing a query, return hidden items
totalonly bool (Optional) If true, only return the total number of files that satisfy this query.
ids_only bool (Optional) If true, only return the published file ids of files that satisfy this query.
return_vote_data bool Return vote data
return_tags bool Return tags in the file details
return_kv_tags bool Return key-value tags in the file details
return_previews bool Return preview image and video details in the file details
return_children bool Return child item ids in the file details
return_short_description bool Populate the short_description field instead of file_description
return_for_sale_data bool Return pricing information, if applicable
return_metadata bool Populate the metadata
return_playtime_stats uint32 Return playtime stats for the specified number of days before today.
return_details bool By default, if none of the other 'return_*' fields are set, only some voting details are returned. Set this to true to return the default set of details.
strip_description_bbcode bool Strips BBCode from descriptions.
desired_revision {enum} Return the data for the specified revision.
return_reactions bool If true, then reactions to items will be returned.

Beispielcode:
Interface: IPublishedFileService
Methode: GetSubSectionData
Version: 1
HTTP-Methode: GET
Beschreibung: Get sub section data (for table of contents, a specific section, or all)
Parameter Datentyp Pflicht Beschreibung
publishedfileid uint64 Keine Beschreibung vorhanden.
for_table_of_contents bool Keine Beschreibung vorhanden.
specific_sectionid uint64 Keine Beschreibung vorhanden.
desired_revision {enum} Return the data for the specified revision.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('IPublishedFileService', 'GetSubSectionData', 1, [
    'publishedfileid' => $publishedfileid,
    'for_table_of_contents' => $for_table_of_contents,
    'specific_sectionid' => $specific_sectionid,
    'desired_revision' => $desired_revision,
]);
Interface: IPublishedFileService
Methode: GetDetails
Version: 1
HTTP-Methode: GET
Beschreibung: Retrieves information about a set of published files.
Parameter Datentyp Pflicht Beschreibung
publishedfileids uint64 Set of published file Ids to retrieve details for.
includetags bool If true, return tag information in the returned details.
includeadditionalpreviews bool If true, return preview information in the returned details.
includechildren bool If true, return children in the returned details.
includekvtags bool If true, return key value tags in the returned details.
includevotes bool If true, return vote data in the returned details.
short_description bool If true, return a short description instead of the full description.
includeforsaledata bool If true, return pricing data, if applicable.
includemetadata bool If true, populate the metadata field.
language int32 Specifies the localized text to return. Defaults to English.
return_playtime_stats uint32 Return playtime stats for the specified number of days before today.
appid uint32 Keine Beschreibung vorhanden.
strip_description_bbcode bool Strips BBCode from descriptions.
desired_revision {enum} Return the data for the specified revision.
includereactions bool If true, then reactions to items will be returned.
admin_query bool Admin tool is doing a query, return hidden items

Beispielcode:
Interface: IPublishedFileService
Methode: GetUserFiles
Version: 1
HTTP-Methode: GET
Beschreibung: Retrieves files published by a user.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 Steam ID of the user whose files are being requested.
appid uint32 App Id of the app that the files were published to.
shortcutid uint32 (Optional) Shortcut Id to retrieve published files from.
page uint32 (Optional) Starting page for results.
numperpage uint32 (Optional) The number of results, per page to return.
type string (Optional) Type of files to be returned.
sortmethod string (Optional) Sorting method to use on returned values.
privacy uint32 (optional) Filter by privacy settings.
requiredtags string (Optional) Tags that must be present on a published file to satisfy the query.
excludedtags string (Optional) Tags that must NOT be present on a published file to satisfy the query.
required_kv_tags {message} Required key-value tags to match on.
filetype uint32 (Optional) File type to match files to.
creator_appid uint32 App Id of the app that published the files, only matched if specified.
match_cloud_filename string Match this cloud filename if specified.
cache_max_age_seconds uint32 Allow stale data to be returned for the specified number of seconds.
language int32 Specifies the localized text to return. Defaults to English.
taggroups {message} (Optional) At least one of the tags must be present on a published file to satisfy the query.
excluded_content_descriptors {enum} (Optional) Filter out items that have these content descriptors.
admin_query bool Admin tool is doing a query, return hidden items
totalonly bool (Optional) If true, only return the total number of files that satisfy this query.
ids_only bool (Optional) If true, only return the published file ids of files that satisfy this query.
return_vote_data bool Return vote data
return_tags bool Return tags in the file details
return_kv_tags bool Return key-value tags in the file details
return_previews bool Return preview image and video details in the file details
return_children bool Return child item ids in the file details
return_short_description bool Populate the short_description field instead of file_description
return_for_sale_data bool Return pricing information, if applicable
return_metadata bool Populate the metadata field
return_playtime_stats uint32 Return playtime stats for the specified number of days before today.
strip_description_bbcode bool Strips BBCode from descriptions.
return_reactions bool If true, then reactions to items will be returned.
startindex_override uint32 Backwards compatible for the client.
desired_revision {enum} Return the data for the specified revision.
return_apps bool Return list of apps the items belong to

Beispielcode:
Interface: IPublishedFileService
Methode: GetUserFileCount
Version: 1
HTTP-Methode: GET
Beschreibung: Retrieves a count of files published by a user. Uses the same messages as GetUserFiles but totalonly must be true.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 Steam ID of the user whose files are being requested.
appid uint32 App Id of the app that the files were published to.
shortcutid uint32 (Optional) Shortcut Id to retrieve published files from.
page uint32 (Optional) Starting page for results.
numperpage uint32 (Optional) The number of results, per page to return.
type string (Optional) Type of files to be returned.
sortmethod string (Optional) Sorting method to use on returned values.
privacy uint32 (optional) Filter by privacy settings.
requiredtags string (Optional) Tags that must be present on a published file to satisfy the query.
excludedtags string (Optional) Tags that must NOT be present on a published file to satisfy the query.
required_kv_tags {message} Required key-value tags to match on.
filetype uint32 (Optional) File type to match files to.
creator_appid uint32 App Id of the app that published the files, only matched if specified.
match_cloud_filename string Match this cloud filename if specified.
cache_max_age_seconds uint32 Allow stale data to be returned for the specified number of seconds.
language int32 Specifies the localized text to return. Defaults to English.
taggroups {message} (Optional) At least one of the tags must be present on a published file to satisfy the query.
excluded_content_descriptors {enum} (Optional) Filter out items that have these content descriptors.
admin_query bool Admin tool is doing a query, return hidden items
totalonly bool (Optional) If true, only return the total number of files that satisfy this query.
ids_only bool (Optional) If true, only return the published file ids of files that satisfy this query.
return_vote_data bool Return vote data
return_tags bool Return tags in the file details
return_kv_tags bool Return key-value tags in the file details
return_previews bool Return preview image and video details in the file details
return_children bool Return child item ids in the file details
return_short_description bool Populate the short_description field instead of file_description
return_for_sale_data bool Return pricing information, if applicable
return_metadata bool Populate the metadata field
return_playtime_stats uint32 Return playtime stats for the specified number of days before today.
strip_description_bbcode bool Strips BBCode from descriptions.
return_reactions bool If true, then reactions to items will be returned.
startindex_override uint32 Backwards compatible for the client.
desired_revision {enum} Return the data for the specified revision.
return_apps bool Return list of apps the items belong to

Beispielcode:

ISteamApps

Interface: ISteamApps
Methode: GetAppList
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamApps', 'GetAppList', 1);
Interface: ISteamApps
Methode: GetAppList
Version: 2
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamApps', 'GetAppList', 2);
Interface: ISteamApps
Methode: GetSDRConfig
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
appid uint32 AppID of game

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamApps', 'GetSDRConfig', 1, [
    'appid' => $appid,
]);
Interface: ISteamApps
Methode: GetServersAtAddress
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
addr string IP or IP:queryport to list

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamApps', 'GetServersAtAddress', 1, [
    'addr' => $addr,
]);
Interface: ISteamApps
Methode: UpToDateCheck
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
appid uint32 AppID of game
version uint32 The installed version of the game

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamApps', 'UpToDateCheck', 1, [
    'appid' => $appid,
    'version' => $version,
]);

ISteamBroadcast

Interface: ISteamBroadcast
Methode: ViewerHeartbeat
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 Steam ID of the broadcaster
sessionid uint64 Broadcast Session ID
token uint64 Viewer token
stream int32 video stream representation watching

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamBroadcast', 'ViewerHeartbeat', 1, [
    'steamid' => $steamid,
    'sessionid' => $sessionid,
    'token' => $token,
    'stream' => $stream,
]);

ISteamCDN

Interface: ISteamCDN
Methode: SetClientFilters
Version: 1
HTTP-Methode: POST
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
cdnname string Steam name of CDN property
allowedipblocks string comma-separated list of allowed IP address blocks in CIDR format - blank for not used
allowedasns string comma-separated list of allowed client network AS numbers - blank for not used
allowedipcountries string comma-separated list of allowed client IP country codes in ISO 3166-1 format - blank for not used

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamCDN', 'SetClientFilters', 1, [
    'cdnname' => $cdnname,
    'allowedipblocks' => $allowedipblocks,
    'allowedasns' => $allowedasns,
    'allowedipcountries' => $allowedipcountries,
], 'POST');
Interface: ISteamCDN
Methode: SetPerformanceStats
Version: 1
HTTP-Methode: POST
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
cdnname string Steam name of CDN property
mbps_sent uint32 Outgoing network traffic in Mbps
mbps_recv uint32 Incoming network traffic in Mbps
cpu_percent uint32 Percent CPU load
cache_hit_percent uint32 Percent cache hits

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamCDN', 'SetPerformanceStats', 1, [
    'cdnname' => $cdnname,
    'mbps_sent' => $mbps_sent,
    'mbps_recv' => $mbps_recv,
    'cpu_percent' => $cpu_percent,
    'cache_hit_percent' => $cache_hit_percent,
], 'POST');

ISteamDirectory

Interface: ISteamDirectory
Methode: GetCMList
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
cellid uint32 Client's Steam cell ID
maxcount uint32 Max number of servers to return

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamDirectory', 'GetCMList', 1, [
    'cellid' => $cellid,
    'maxcount' => $maxcount,
]);
Interface: ISteamDirectory
Methode: GetCMListForConnect
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
cellid uint32 Client's Steam cell ID, uses IP location if blank
cmtype string Optional CM type filter
realm string Optional Steam Realm filter
maxcount uint32 Max number of servers to return

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamDirectory', 'GetCMListForConnect', 1, [
    'cellid' => $cellid,
    'cmtype' => $cmtype,
    'realm' => $realm,
    'maxcount' => $maxcount,
]);
Interface: ISteamDirectory
Methode: GetSteamPipeDomains
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamDirectory', 'GetSteamPipeDomains', 1);

ISteamEconomy

Interface: ISteamEconomy
Methode: GetAssetClassInfo
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
appid uint32 Must be a steam economy app.
language string The user's local language
class_count uint32 Number of classes requested. Must be at least one.
classid0 uint64 Class ID of the nth class.
instanceid0 uint64 Instance ID of the nth class.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamEconomy', 'GetAssetClassInfo', 1, [
    'appid' => $appid,
    'language' => $language,
    'class_count' => $class_count,
    'classid0' => $classid0,
    'instanceid0' => $instanceid0,
]);
Interface: ISteamEconomy
Methode: GetAssetPrices
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
appid uint32 Must be a steam economy app.
currency string The currency to filter for
language string The user's local language

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamEconomy', 'GetAssetPrices', 1, [
    'appid' => $appid,
    'currency' => $currency,
    'language' => $language,
]);

ISteamNews

Interface: ISteamNews
Methode: GetNewsForApp
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
appid uint32 AppID to retrieve news for
maxlength uint32 Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit.
enddate uint32 Retrieve posts earlier than this date (unix epoch timestamp)
count uint32 # of posts to retrieve (default 20)
tags string Comma-separated list of tags to filter by (e.g. 'patchnodes')

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamNews', 'GetNewsForApp', 1, [
    'appid' => $appid,
    'maxlength' => $maxlength,
    'enddate' => $enddate,
    'count' => $count,
    'tags' => $tags,
]);
Interface: ISteamNews
Methode: GetNewsForApp
Version: 2
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
appid uint32 AppID to retrieve news for
maxlength uint32 Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit.
enddate uint32 Retrieve posts earlier than this date (unix epoch timestamp)
count uint32 # of posts to retrieve (default 20)
feeds string Comma-separated list of feed names to return news for
tags string Comma-separated list of tags to filter by (e.g. 'patchnodes')

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamNews', 'GetNewsForApp', 2, [
    'appid' => $appid,
    'maxlength' => $maxlength,
    'enddate' => $enddate,
    'count' => $count,
    'feeds' => $feeds,
    'tags' => $tags,
]);

ISteamRemoteStorage

Interface: ISteamRemoteStorage
Methode: GetCollectionDetails
Version: 1
HTTP-Methode: POST
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
collectioncount uint32 Number of collections being requested
publishedfileids[0] uint64 collection ids to get the details for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamRemoteStorage', 'GetCollectionDetails', 1, [
    'collectioncount' => $collectioncount,
    'publishedfileids[0]' => $publishedfileids[0],
], 'POST');
Interface: ISteamRemoteStorage
Methode: GetPublishedFileDetails
Version: 1
HTTP-Methode: POST
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
itemcount uint32 Number of items being requested
publishedfileids[0] uint64 published file id to look up

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamRemoteStorage', 'GetPublishedFileDetails', 1, [
    'itemcount' => $itemcount,
    'publishedfileids[0]' => $publishedfileids[0],
], 'POST');
Interface: ISteamRemoteStorage
Methode: GetUGCFileDetails
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 If specified, only returns details if the file is owned by the SteamID specified
ugcid uint64 ID of UGC file to get info for
appid uint32 appID of product

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamRemoteStorage', 'GetUGCFileDetails', 1, [
    'steamid' => $steamid,
    'ugcid' => $ugcid,
    'appid' => $appid,
]);

ISteamUser

Interface: ISteamUser
Methode: GetFriendList
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 SteamID of user
relationship string relationship type (ex: friend)

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUser', 'GetFriendList', 1, [
    'steamid' => $steamid,
    'relationship' => $relationship,
]);
Interface: ISteamUser
Methode: GetPlayerBans
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamids string Comma-delimited list of SteamIDs

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUser', 'GetPlayerBans', 1, [
    'steamids' => $steamids,
]);
Interface: ISteamUser
Methode: GetPlayerSummaries
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamids string Comma-delimited list of SteamIDs

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUser', 'GetPlayerSummaries', 1, [
    'steamids' => $steamids,
]);
Interface: ISteamUser
Methode: GetPlayerSummaries
Version: 2
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamids string Comma-delimited list of SteamIDs (max: 100)

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUser', 'GetPlayerSummaries', 2, [
    'steamids' => $steamids,
]);
Interface: ISteamUser
Methode: GetUserGroupList
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 SteamID of user

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUser', 'GetUserGroupList', 1, [
    'steamid' => $steamid,
]);
Interface: ISteamUser
Methode: ResolveVanityURL
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
vanityurl string The vanity URL to get a SteamID for
url_type int32 The type of vanity URL. 1 (default): Individual profile, 2: Group, 3: Official game group

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUser', 'ResolveVanityURL', 1, [
    'vanityurl' => $vanityurl,
    'url_type' => $url_type,
]);

ISteamUserAuth

Interface: ISteamUserAuth
Methode: AuthenticateUser
Version: 1
HTTP-Methode: POST
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 Should be the users steamid, unencrypted.
sessionkey rawbinary Should be a 32 byte random blob of data, which is then encrypted with RSA using the Steam system's public key. Randomness is important here for security.
encrypted_loginkey rawbinary Should be the users hashed loginkey, AES encrypted with the sessionkey.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUserAuth', 'AuthenticateUser', 1, [
    'steamid' => $steamid,
    'sessionkey' => $sessionkey,
    'encrypted_loginkey' => $encrypted_loginkey,
], 'POST');
Interface: ISteamUserAuth
Methode: AuthenticateUserTicket
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
appid uint32 appid of game
ticket string Ticket from GetAuthSessionTicket.

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUserAuth', 'AuthenticateUserTicket', 1, [
    'appid' => $appid,
    'ticket' => $ticket,
]);

ISteamUserOAuth

Interface: ISteamUserOAuth
Methode: GetTokenDetails
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
access_token string OAuth2 token for which to return details

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUserOAuth', 'GetTokenDetails', 1, [
    'access_token' => $access_token,
]);

ISteamUserStats

Interface: ISteamUserStats
Methode: GetGlobalAchievementPercentagesForApp
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
gameid uint64 GameID to retrieve the achievement percentages for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUserStats', 'GetGlobalAchievementPercentagesForApp', 1, [
    'gameid' => $gameid,
]);
Interface: ISteamUserStats
Methode: GetGlobalAchievementPercentagesForApp
Version: 2
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
gameid uint64 GameID to retrieve the achievement percentages for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUserStats', 'GetGlobalAchievementPercentagesForApp', 2, [
    'gameid' => $gameid,
]);
Interface: ISteamUserStats
Methode: GetGlobalStatsForGame
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
appid uint32 AppID that we're getting global stats for
count uint32 Number of stats get data for
name[0] string Names of stat to get data for
startdate uint32 Start date for daily totals (unix epoch timestamp)
enddate uint32 End date for daily totals (unix epoch timestamp)

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUserStats', 'GetGlobalStatsForGame', 1, [
    'appid' => $appid,
    'count' => $count,
    'name[0]' => $name[0],
    'startdate' => $startdate,
    'enddate' => $enddate,
]);
Interface: ISteamUserStats
Methode: GetNumberOfCurrentPlayers
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
appid uint32 AppID that we're getting user count for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUserStats', 'GetNumberOfCurrentPlayers', 1, [
    'appid' => $appid,
]);
Interface: ISteamUserStats
Methode: GetPlayerAchievements
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 SteamID of user
appid uint32 AppID to get achievements for
l string Language to return strings for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUserStats', 'GetPlayerAchievements', 1, [
    'steamid' => $steamid,
    'appid' => $appid,
    'l' => $l,
]);
Interface: ISteamUserStats
Methode: GetSchemaForGame
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
appid uint32 appid of game
l string localized langauge to return (english, french, etc.)

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUserStats', 'GetSchemaForGame', 1, [
    'appid' => $appid,
    'l' => $l,
]);
Interface: ISteamUserStats
Methode: GetSchemaForGame
Version: 2
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
appid uint32 appid of game
l string localized language to return (english, french, etc.)

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUserStats', 'GetSchemaForGame', 2, [
    'appid' => $appid,
    'l' => $l,
]);
Interface: ISteamUserStats
Methode: GetUserStatsForGame
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 SteamID of user
appid uint32 appid of game

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUserStats', 'GetUserStatsForGame', 1, [
    'steamid' => $steamid,
    'appid' => $appid,
]);
Interface: ISteamUserStats
Methode: GetUserStatsForGame
Version: 2
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 SteamID of user
appid uint32 appid of game

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamUserStats', 'GetUserStatsForGame', 2, [
    'steamid' => $steamid,
    'appid' => $appid,
]);

ISteamWebAPIUtil

Interface: ISteamWebAPIUtil
Methode: GetServerInfo
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamWebAPIUtil', 'GetServerInfo', 1);
Interface: ISteamWebAPIUtil
Methode: GetSupportedAPIList
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ISteamWebAPIUtil', 'GetSupportedAPIList', 1);

IStoreService

Interface: IStoreService
Methode: GetAppList
Version: 1
HTTP-Methode: GET
Beschreibung: Gets a list of apps available on the Steam Store.
Parameter Datentyp Pflicht Beschreibung
if_modified_since uint32 Return only items that have been modified since this date.
have_description_language string Return only items that have a description in this language.
include_games bool Include games (defaults to enabled)
include_dlc bool Include DLC
include_software bool Include software items
include_videos bool Include videos and series
include_hardware bool Include hardware
last_appid uint32 For continuations, this is the last appid returned from the previous call.
max_results uint32 Number of results to return at a time. Default 10k, max 50k.

Beispielcode:

ITFItems_440

Interface: ITFItems_440
Methode: GetGoldenWrenches
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ITFItems_440', 'GetGoldenWrenches', 1);
Interface: ITFItems_440
Methode: GetGoldenWrenches
Version: 2
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ITFItems_440', 'GetGoldenWrenches', 2);

ITFPromos_440

Interface: ITFPromos_440
Methode: GetItemID
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The Steam ID to fetch items for
promoid uint32 The promo ID to grant an item for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ITFPromos_440', 'GetItemID', 1, [
    'steamid' => $steamid,
    'promoid' => $promoid,
]);
Interface: ITFPromos_440
Methode: GrantItem
Version: 1
HTTP-Methode: POST
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The Steam ID to fetch items for
promoid uint32 The promo ID to grant an item for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ITFPromos_440', 'GrantItem', 1, [
    'steamid' => $steamid,
    'promoid' => $promoid,
], 'POST');

ITFPromos_620

Interface: ITFPromos_620
Methode: GetItemID
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The Steam ID to fetch items for
PromoID uint32 The promo ID to grant an item for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ITFPromos_620', 'GetItemID', 1, [
    'steamid' => $steamid,
    'PromoID' => $PromoID,
]);
Interface: ITFPromos_620
Methode: GrantItem
Version: 1
HTTP-Methode: POST
Beschreibung: Keine Beschreibung vorhanden.
Parameter Datentyp Pflicht Beschreibung
steamid uint64 The Steam ID to fetch items for
PromoID uint32 The promo ID to grant an item for

Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ITFPromos_620', 'GrantItem', 1, [
    'steamid' => $steamid,
    'PromoID' => $PromoID,
], 'POST');

ITFSystem_440

Interface: ITFSystem_440
Methode: GetWorldStatus
Version: 1
HTTP-Methode: GET
Beschreibung: Keine Beschreibung vorhanden.

Für diese Methode sind keine Parameter vorhanden.


Beispielcode:
PHP
\wcf\system\steam\SteamAPI::execute('ITFSystem_440', 'GetWorldStatus', 1);