Getting Started

Quick start

Acquire your Steam ID and API key

To get started with SteamApis, sign in using your Steam account. Once signed in, go to your SteamApis Settings page to retrieve your SteamID6464 and your API key. The API key is essential for accessing the majority of API endpoints.

Discover how to find your Steam ID.
Get your API Key in your SteamApis account.

Making API requests

When making any API request, you must include your secret API key as part of the request. Following is a sample structure of an API endpoint:

Discover the App ID to any game on SteamDB.
index.js
const SteamID64 = 76561191451107936;
const AppID = 252490;
const YourSecretAPIKey = '1nqNbqP5JYQ9Lpw5nATfKumaxN0';
const ContextID = '';
const endpoint = `https://api.steamapis.com/steam/inventory/{SteamID64}/{AppID}/{ContextID}?api_key={YourSecretAPIKey}`

Parameters

SteamID64
number
The SteamID64 identifier of the user who's inventory you want to fetch..
AppID
number
Default to false - Enables blob storage to store static assets, such as images, videos and more.
ContextID
boolean
Context identifier for the application which contents you want to receive from the user's inventory.
YourSecretAPIKey
string
A unique identifier that allows developers to access the Steam Web API.

Response examples

All API responses are returned in JSON format, and to determine if your request was successful, you need to check the statusCode in the response. If you're unsure about what the statusCode means, you can look it up here for further clarification:

  • 200 OK - the request was successful (some API calls may return 201 instead).
  • 201 Created - the request was successful and a resource was created.
  • 204 No Content - the request was successful but there is no representation to return (i.e. the response is empty).
  • 400 Bad Request - the request could not be understood or was missing required parameters.
  • 401 Unauthorized - authentication failed or user doesn't have permissions for requested operation.
  • 403 Forbidden - access denied.
  • 404 Not Found - resource was not found.
  • 405 Method Not Allowed - requested method is not supported for resource.
You can find a full documentation of possible status codes on WebFX