Migration Guide

Migrating from v1 to v2

This guide covers the changes you need to make when upgrading from SteamApis API v1 to v2. v2 adds new categories (Account, Market Data), reorganizes Steam user and app endpoints, and introduces a standardized response envelope.

Authentication

v1 passed the API key as a query parameter, typically api_key or key:

GET /steam/profile/76561198038526790?api_key=YOUR_KEY

v2 passes the API key via the x-api-key request header (recommended) or the ?key= query parameter (still supported):

fetch('https://api.steamapis.com/v2/steam/users/76561198038526790', {
  headers: { 'x-api-key': 'YOUR_KEY' }
})

Using the header is recommended because the key does not appear in server logs, browser history, or referrer headers.

Response envelope

v1 endpoints returned data directly at the top level:

{
  "steamid": "76561198038526790",
  "personaname": "PEPZ"
}

v2 wraps every response in a standard envelope. The exact shape depends on whether the endpoint returns a single resource or a paginated list:

{
  "success": true,
  "result": {
    "steamID": "76561198038526790",
    "nickname": "PEPZ",
    ...
  }
}

To access the data, use data.result instead of data directly.

Errors use the same envelope with success: false:

{
  "success": false,
  "error": { "name": "NOT_FOUND", "message": "User not found", "meta": {} }
}

To access the data, use data.result (single resource) or data.results (list) instead of reading the top level directly.

Steam user field renames

The v2 user endpoint returns the same underlying Steam data, but with camelCase field names and a nested avatar object. If you parse user responses, update your types:

Steam ID parameter

In v1, user endpoints required a SteamID64 (17-digit numeric ID). In v2, the steamid parameter accepts multiple Steam ID formats — SteamID64, SteamID, SteamID3 — and the API resolves them automatically.

Endpoint mapping

The following tables map every v1 endpoint to its v2 equivalent, grouped by category. Entries marked "New in v2" have no v1 predecessor.

Account

Steam users

Steam apps

Steam items

Images

Market Data (third-party marketplaces)

Market Data is a new category in v2. It aggregates pricing, offers, sales, and order-book data from 26 third-party marketplaces — functionality that did not exist in v1.

In addition to the REST endpoints below, v2 also exposes a real-time WebSocket offer stream:

Summary of breaking changes

1. Authentication method changed — move API key from query parameter to x-api-key header.
2. Response envelope — all data is now inside a result or results field.
3. Endpoint paths changed — all Steam user endpoints now use /v2/steam/users/ prefix.
4. Summary endpoint split — profile data and badges are now separate endpoints.
5. Error format changed — errors return { "success": false, "error": { "name": "...", "message": "...", "meta": ... } }.