Skip to content

xPaw/SteamWebAPIDocumentation

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
September 4, 2023 12:35
March 6, 2023 21:39
src
March 6, 2023 21:49
November 14, 2019 12:05
March 7, 2019 11:00
August 30, 2023 14:23
March 7, 2019 11:00
September 27, 2023 05:03
February 23, 2023 22:42
October 3, 2022 15:28
Fix
September 14, 2023 16:57
January 27, 2023 10:16

Steam Web API Documentation

An automatically generated list of Steam Web API interfaces, methods and parameters. Allows you to craft requests in the browser.

If you specify the web api key, it will be stored in your browser, and will only be sent to Valve's API servers if you chose to do so.

āš  Please do not email me about questions on how to use specific APIs, I provide an automatically updated and generated list, I do not personally know how to use all of them.

api.json

api.json is the final file that is generated from various sources:

  1. Takes existing api.json file as a base, so removed methods are persisted
  2. Official list from GetSupportedAPIList
    • Using normal API key
    • Using partner API key
  3. Parsed protobufs to find service methods and tested against the API
    • Descriptions and fields are also parsed
  4. api_undocumented_methods.txt to insert undocumented and otherwise unknown APIs
  5. api_type_overrides.json to fix up types of known method parameters. Such as enforcing arrays

config.php

To run generation scripts, a config.php file needs to be created with API keys:

<?php
$PublicApiKey    = '';
$PublisherApiKey = '';

About

šŸ“ƒ An automatically generated list of Steam Web API interfaces, methods and parameters. Allows you to craft requests in the browser.

Topics

Resources

License

Security policy

Stars

Watchers

Forks