ctinkong / openapi-steamworks-web-api

An automatically generated OpenAPI specification for the Steamworks Web API

OpenAPI Specification for the Steamworks Web API

👋 Introduction

This is an automatically generated OpenAPI specification for the Steamworks Web API. It allows you to explore the endpoints through the Swagger UI and try out some of the requests, and is intended to complement the official Steamworks Web API Reference and developer wiki.

The specification is regenerated regularly so should be an accurate reflection of the current state of the API.

🔧 Prerequisites

Many of the endpoints require you to pass an API key as part of the request. You can request one for your Steam account.

🗒️ How to use

You can freely browse all of the available endpoints. You can try them out by filling in any required fields and executing the request, which will show the resulting URL of the request and a curl implementation.

Important note: Requests sent through the UI will always fail due to CORS errors. You can copy the URL or curl command to run these locally without issue.

❗ Caveats

• This project relies on an endpoint provided by Valve Software to generate the specification - not all API endpoints are documented in this (including many of those for https://partner.steam-api.com), though most of the core ones are available. If in doubt refer to the Steamworks Web API Reference.
• Conversely this specification includes a number of endpoints that aren't included in the Steamworks Web API Reference for whatever reason.
• This is an opinionated specification - the API allows you to do things like pass the key parameter as a query string parameter or in some cases as a form field. In our case we always pass it as a query string parameter.
• For simplicity all endpoints have been marked as requiring authentication, but some of the endpoints are public. You can determine this by consulting the relevant page in the Steamworks Web API Reference - or just try it!
• Most endpoints target the https://api.steampowered.com domain, but some are for https://partner.steam-api.com. You can select the server at the top of the specification, but you'll need to refer to the Steamworks Web API Reference to find out which domain you need to target.
• Many endpoints allow you to pass an input_json parameter - you'll need to URL-encode this yourself.
• Be aware that some endpoints will respond with HTTP 200 whilst containing an error message in the response body 🤷

📌 Notices

This project is not affiliated with Valve Software or the Steam platform in any way. All of the information provided is publicly available through Valve Software's own documentation and APIs.