Steam Web API Documentation by xPaw

https://steamapi.xpaw.me
Admin
A comprehensive, automatically generated documentation and reference for the Steam Web API,...
Tokens:139,071
Snippets:925
Trust Score:9.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET GetExamplesForFineTuning/v1

Source: https://steamapi.xpaw.me/ISteamGPTService

Retrieves examples for fine-tuning models.

```APIDOC
## GET https://api.steampowered.com/ISteamGPTService/GetExamplesForFineTuning/v1/

### Description
Retrieves a list of examples suitable for fine-tuning GPT models.

### Method
GET

### Endpoint
https://api.steampowered.com/ISteamGPTService/GetExamplesForFineTuning/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **problem** (string) - Optional
- **label** (string) - Optional
- **appid** (uint32) - Optional
- **page_size** (int32) - Optional
- **page_num** (int32) - Optional
- **example_size_softmax** (int32) - Optional
- **versionid** (int32) - Optional
- **start_time** (uint32) - Optional
- **seed** (int32) - Optional
- **upstream_modelid** (uint64) - Optional
```

--------------------------------

### GET GetClientAppList

Source: https://steamapi.xpaw.me/IClientCommService

Retrieves a list of applications installed or available on the Steam client.

```APIDOC
## GET https://api.steampowered.com/IClientCommService/GetClientAppList/v1/

### Description
Retrieves a list of applications installed or available on the Steam client.

### Method
GET

### Endpoint
https://api.steampowered.com/IClientCommService/GetClientAppList/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **fields** (string) - Optional - A combination of fields : 'all|media|tools|games'
- **filters** (string) - Optional - A combination of state filters : 'none|changing|installed'
- **client_instanceid** (uint64) - Optional - Uses first desktop session if not specified
- **include_client_info** (bool) - Optional - If true, response will also include ClientData message
- **language** (string) - Optional - Language for app names
- **filter_appids[0]+** (uint32[]) - Optional
```

--------------------------------

### GetBuildClipStatus

Source: https://steamapi.xpaw.me/IBroadcastService

Starts building a broadcast clip.

```APIDOC
## GET https://api.steampowered.com/IBroadcastService/GetBuildClipStatus/v1/

### Description
Start building a broadcast clip.

### Method
GET

### Endpoint
https://api.steampowered.com/IBroadcastService/GetBuildClipStatus/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **broadcast_clip_id** (fixed64) - Optional
```

--------------------------------

### GET GetAppList

Source: https://steamapi.xpaw.me/IStoreService

Gets a list of apps available on the Steam Store.

```APIDOC
## GET https://api.steampowered.com/IStoreService/GetAppList/v1/

### Description
Gets a list of apps available on the Steam Store.

### Method
GET

### Endpoint
https://api.steampowered.com/IStoreService/GetAppList/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **if_modified_since** (uint32) - Optional - Return only items that have been modified since this date.
- **have_description_language** (string) - Optional - Return only items that have a description in this language.
- **include_games** (bool) - Optional - Include games (defaults to enabled)
- **include_dlc** (bool) - Optional - Include DLC
- **include_software** (bool) - Optional - Include software items
- **include_videos** (bool) - Optional - Include videos and series
- **include_hardware** (bool) - Optional - Include hardware
- **last_appid** (uint32) - Optional - For continuations, this is the last appid returned from the previous call.
- **max_results** (uint32) - Optional - Number of results to return at a time. Default 10k, max 50k.
```

--------------------------------

### GET GetHardwareItems/v1/

Source: https://steamapi.xpaw.me/IStoreBrowseService

Get additional meta data specific to hardware store items (things that require physical shipping).

```APIDOC
## GET https://api.steampowered.com/IStoreBrowseService/GetHardwareItems/v1/

### Description
Get additional meta data specific to hardware store items (things that require physical shipping).

### Method
GET

### Endpoint
https://api.steampowered.com/IStoreBrowseService/GetHardwareItems/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **packageid** (uint32[]) - Optional - List of package IDs
- **context** (StoreBrowseContext) - Optional - Context object
```

--------------------------------

### GET GetPlan

Source: https://steamapi.xpaw.me/IPromotionPlanningService

Retrieves a specific promotion plan.

```APIDOC
## GET https://api.steampowered.com/IPromotionPlanningService/GetPlan/v1/

### Description
Retrieves details for a specific promotion plan by ID.

### Method
GET

### Endpoint
https://api.steampowered.com/IPromotionPlanningService/GetPlan/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **promotion_id** (fixed64) - Optional
```

--------------------------------

### GET StartTrade

Source: https://steamapi.xpaw.me/ISteamEconomy

Initiates a trade between two users.

```APIDOC
## GET https://partner.steam-api.com/ISteamEconomy/StartTrade/v1/

### Description
Initiates a trade between two users.

### Method
GET

### Endpoint
https://partner.steam-api.com/ISteamEconomy/StartTrade/v1/

### Parameters
#### Query Parameters
- **appid** (uint32) - Required - That the key is associated with. Must be a steam economy app.
- **partya** (uint64) - Required - SteamID of first user in the trade
- **partyb** (uint64) - Required - SteamID of second user in the trade
```

--------------------------------

### GET GetAccessTokens/v1/

Source: https://steamapi.xpaw.me/ISteamLearnService

Gets the access tokens needed for registering data sources, submitting data to them, and snapshotting projects.

```APIDOC
## GET https://api.steampowered.com/ISteamLearnService/GetAccessTokens/v1/

### Description
Gets the access tokens needed for registering data sources, submitting data to them, and snapshotting projects.

### Method
GET

### Endpoint
https://api.steampowered.com/ISteamLearnService/GetAccessTokens/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **appid** (uint32) - Optional
```

--------------------------------

### GET GetContentHubConfig/v1/

Source: https://steamapi.xpaw.me/IStoreBrowseService

Retrieves the configuration for a content hub.

```APIDOC
## GET https://api.steampowered.com/IStoreBrowseService/GetContentHubConfig/v1/

### Description
Retrieves the configuration for a content hub.

### Method
GET

### Endpoint
https://api.steampowered.com/IStoreBrowseService/GetContentHubConfig/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **context** (StoreBrowseContext) - Optional - Context object containing language, elanguage, and country_code
- **excluded_content_descriptorids** (int32[]) - Optional - List of excluded content descriptor IDs
```

--------------------------------

### GET GetFriendsRecommendedApp/v1/

Source: https://steamapi.xpaw.me/IUserReviewsService

Retrieves an application recommended by friends.

```APIDOC
## GET https://api.steampowered.com/IUserReviewsService/GetFriendsRecommendedApp/v1/

### Description
Retrieves an application recommended by friends.

### Method
GET

### Endpoint
https://api.steampowered.com/IUserReviewsService/GetFriendsRecommendedApp/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **appid** (uint32) - Optional
```

--------------------------------

### GET GetFAQ

Source: https://steamapi.xpaw.me/IClanFAQSService

Retrieves a specific FAQ.

```APIDOC
## GET /IClanFAQSService/GetFAQ/v1/

### Description
Retrieves a specific FAQ.

### Method
GET

### Endpoint
https://api.steampowered.com/IClanFAQSService/GetFAQ/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **faq_id** (uint64) - Optional - The unique FAQ identifier.
- **language** (uint32) - Optional - ELanguage to fetch. Falls back to English or SC, based on realm.
```

--------------------------------

### GET UpToDateCheck

Source: https://steamapi.xpaw.me/ISteamApps

Checks if the installed version of an application is up to date.

```APIDOC
## GET https://api.steampowered.com/ISteamApps/UpToDateCheck/v1/

### Description
Checks if the installed version of an application is up to date.

### Method
GET

### Endpoint
https://api.steampowered.com/ISteamApps/UpToDateCheck/v1/

### Parameters
#### Query Parameters
- **appid** (uint32) - Required - AppID of game
- **version** (uint32) - Required - The installed version of the game
```

--------------------------------

### POST CreateExample/v1/

Source: https://steamapi.xpaw.me/ISteamGPTRenderFarmService

Creates a new example entry in the render farm service.

```APIDOC
## POST https://api.steampowered.com/ISteamGPTRenderFarmService/CreateExample/v1/

### Description
Creates a new example record for the render farm service.

### Method
POST

### Endpoint
https://api.steampowered.com/ISteamGPTRenderFarmService/CreateExample/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **problem** (string) - Optional
- **label** (string) - Optional
- **appid** (uint32) - Optional
- **steamid** (fixed64) - Optional
- **exact_example** (string) - Optional
- **log_addresses** (CSteamGPT_CreateExample_Request_SteamGPTLogAddress[]) - Optional
- **metadata** (string) - Optional
- **max_timestamp** (int32) - Optional
- **data_version** (uint32) - Optional
- **reevidence_data** (string) - Optional
- **parent_row_id** (fixed64) - Optional
- **match_id** (uint64) - Optional
- **labeling_task_id** (uint64) - Optional
- **is_test_set** (bool) - Optional
```

--------------------------------

### GET GetAllActivePlan

Source: https://steamapi.xpaw.me/IPromotionPlanningService

Retrieves all active promotion plans.

```APIDOC
## GET https://api.steampowered.com/IPromotionPlanningService/GetAllActivePlan/v1/

### Description
Retrieves all currently active promotion plans.

### Method
GET

### Endpoint
https://api.steampowered.com/IPromotionPlanningService/GetAllActivePlan/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
```

--------------------------------

### POST CreateExample/v1

Source: https://steamapi.xpaw.me/ISteamGPTService

Creates a new example entry for the GPT service.

```APIDOC
## POST https://api.steampowered.com/ISteamGPTService/CreateExample/v1/

### Description
Creates a new example record within the GPT service.

### Method
POST

### Endpoint
https://api.steampowered.com/ISteamGPTService/CreateExample/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **problem** (string) - Optional
- **label** (string) - Optional
- **appid** (uint32) - Optional
- **steamid** (fixed64) - Optional
- **exact_example** (string) - Optional
- **log_addresses** (CSteamGPT_CreateExample_Request_SteamGPTLogAddress[]) - Optional
- **metadata** (string) - Optional
- **max_timestamp** (int32) - Optional
- **data_version** (uint32) - Optional
- **reevidence_data** (string) - Optional
- **parent_row_id** (fixed64) - Optional
- **match_id** (uint64) - Optional
- **labeling_task_id** (uint64) - Optional
- **is_test_set** (bool) - Optional
```

--------------------------------

### GET GetCommunityBadgeProgress

Source: https://steamapi.xpaw.me/IPlayerService

Gets all the quests needed to get the specified badge, and which are completed.

```APIDOC
## GET https://api.steampowered.com/IPlayerService/GetCommunityBadgeProgress/v1/

### Description
Gets all the quests needed to get the specified badge, and which are completed.

### Method
GET

### Endpoint
https://api.steampowered.com/IPlayerService/GetCommunityBadgeProgress/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **steamid** (uint64) - Required - The player we're asking about
- **badgeid** (int32) - Required - The badge we're asking about
```

--------------------------------

### POST GetExamplesFromTestSet/v1

Source: https://steamapi.xpaw.me/ISteamGPTService

Retrieves examples from a test set.

```APIDOC
## POST https://api.steampowered.com/ISteamGPTService/GetExamplesFromTestSet/v1/

### Description
Retrieves examples from a specific test set.

### Method
POST

### Endpoint
https://api.steampowered.com/ISteamGPTService/GetExamplesFromTestSet/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **appid** (uint32) - Optional
- **start_index** (uint64) - Optional
- **max_results** (uint32) - Optional
```

--------------------------------

### POST StartBuildClip

Source: https://steamapi.xpaw.me/IBroadcastService

Initiates the process of building a broadcast clip.

```APIDOC
## POST https://api.steampowered.com/IBroadcastService/StartBuildClip/v1/

### Description
Start building a broadcast clip.

### Method
POST

### Endpoint
https://api.steampowered.com/IBroadcastService/StartBuildClip/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **steamid** (fixed64) - Optional
- **broadcast_session_id** (fixed64) - Optional
- **first_segment** (int32) - Optional
- **num_segments** (int32) - Optional
- **clip_description** (string) - Optional
```

--------------------------------

### GET GetItemDefs

Source: https://steamapi.xpaw.me/IInventoryService

Get item definitions.

```APIDOC
## GET https://partner.steam-api.com/IInventoryService/GetItemDefs/v1/

### Description
Get item definitions.

### Method
GET

### Endpoint
https://partner.steam-api.com/IInventoryService/GetItemDefs/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **appid** (uint32) - Required - App ID
- **modifiedsince** (string) - Required - Modified since timestamp
- **itemdefids** (uint64) - Required - Item definition IDs
- **workshopids** (uint64) - Required - Workshop IDs
- **cache_max_age_seconds** (uint32) - Optional - Allow stale data to be returned for the specified number of seconds.
```

--------------------------------

### POST InstallClientApp

Source: https://steamapi.xpaw.me/IClientCommService

Triggers the installation of an application on the Steam client.

```APIDOC
## POST https://api.steampowered.com/IClientCommService/InstallClientApp/v1/

### Description
Triggers the installation of an application on the Steam client.

### Method
POST

### Endpoint
https://api.steampowered.com/IClientCommService/InstallClientApp/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **appid** (uint32) - Optional - appID of product to install
- **client_instanceid** (uint64) - Optional - Uses first desktop session if not specified
```

--------------------------------

### GET GetPopular/v1

Source: https://steamapi.xpaw.me/IEconMarketService

Gets the most popular items.

```APIDOC
## GET https://partner.steam-api.com/IEconMarketService/GetPopular/v1/

### Description
Gets the most popular items.

### Method
GET

### Endpoint
https://partner.steam-api.com/IEconMarketService/GetPopular/v1/

### Parameters
#### Query Parameters
- **key** (string) - Access key
- **language** (string) - The language to use in item descriptions
- **rows** (uint32) - Optional - Number of rows per page
- **start** (uint32) - The result number to start at
- **filter_appid** (uint32) - If present, the app ID to limit results to
- **ecurrency** (uint32) - If present, prices returned will be represented in this currency
```

--------------------------------

### POST CreateAccount

Source: https://steamapi.xpaw.me/IGameServersService

Creates a persistent game server account.

```APIDOC
## POST https://api.steampowered.com/IGameServersService/CreateAccount/v1/

### Description
Creates a persistent game server account.

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **appid** (uint32) - Required - The app to use the account for
- **memo** (string) - Required - The memo to set on the new account
```

--------------------------------

### GET ClientGetLastPlayedTimes

Source: https://steamapi.xpaw.me/IPlayerService

Gets the last-played times for the account.

```APIDOC
## GET https://api.steampowered.com/IPlayerService/ClientGetLastPlayedTimes/v1/

### Description
Gets the last-played times for the account.

### Method
GET

### Endpoint
https://api.steampowered.com/IPlayerService/ClientGetLastPlayedTimes/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **min_last_played** (uint32) - Optional - The most recent last-played time the client already knows about
```

--------------------------------

### GET GetSessionDetailsForApp

Source: https://steamapi.xpaw.me/IGameNotificationsService

Get the details for a specific session.

```APIDOC
## GET https://partner.steam-api.com/IGameNotificationsService/GetSessionDetailsForApp/v1/

### Description
Get the details for a specific session.

### Method
GET

### Endpoint
https://partner.steam-api.com/IGameNotificationsService/GetSessionDetailsForApp/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **sessions** ({message}) - Required - 
- **appid** (uint32) - Required - The appid for the sessions.
- **language** (string) - Required - Language to localize the text in.
```

--------------------------------

### GET GetTradeStatus/v1/

Source: https://steamapi.xpaw.me/IEconService

Gets the status for a specific trade.

```APIDOC
## GET https://api.steampowered.com/IEconService/GetTradeStatus/v1/

### Description
Gets status for a specific trade.

### Method
GET

### Endpoint
https://api.steampowered.com/IEconService/GetTradeStatus/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **tradeid** (uint64) - Required - The ID of the trade.
- **get_descriptions** (bool) - Optional - If set, the item display data for the items included in the returned trades will also be returned
- **language** (string) - Optional - The language to use when loading item display data
```

--------------------------------

### POST CreateTentativePlan

Source: https://steamapi.xpaw.me/IPromotionPlanningService

Creates a tentative promotion plan.

```APIDOC
## POST https://api.steampowered.com/IPromotionPlanningService/CreateTentativePlan/v1/

### Description
Creates a tentative promotion plan.

### Method
POST

### Endpoint
https://api.steampowered.com/IPromotionPlanningService/CreateTentativePlan/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key

#### Request Body
- **plan** (CPromotionPlan) - Optional - The promotion plan object.
```

--------------------------------

### POST EditProjectConfig/v1/

Source: https://steamapi.xpaw.me/ISteamLearnService

Updates the configuration for a specific Steam Learn project.

```APIDOC
## POST https://api.steampowered.com/ISteamLearnService/EditProjectConfig/v1/

### Description
Updates the project configuration for a Steam Learn project.

### Method
POST

### Endpoint
https://api.steampowered.com/ISteamLearnService/EditProjectConfig/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key

#### Request Body
- **project_config** (CMsgSteamLearnProjectConfig) - Optional - The project configuration object containing project details, data sources, and node definitions.
```

--------------------------------

### GET GetActiveMarketingMessages

Source: https://steamapi.xpaw.me/IMarketingMessagesService

Get a list of active marketing messages.

```APIDOC
## GET https://api.steampowered.com/IMarketingMessagesService/GetActiveMarketingMessages/v1/

### Description
Get a list of active marketing messages.

### Method
GET

### Endpoint
https://api.steampowered.com/IMarketingMessagesService/GetActiveMarketingMessages/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **country** (string) - Optional
- **anonymous_user** (bool) - Optional - Will not return any marketing message that requires ownership/playtime/wishlist
```

--------------------------------

### GET GetServerVersion/v1

Source: https://steamapi.xpaw.me/IGCVersion_2305270

Retrieves the current server version.

```APIDOC
## GET https://api.steampowered.com/IGCVersion_2305270/GetServerVersion/v1/

### Description
Retrieves the current server version.

### Method
GET

### Endpoint
https://api.steampowered.com/IGCVersion_2305270/GetServerVersion/v1/
```

--------------------------------

### GET GetServerVersion/v1

Source: https://steamapi.xpaw.me/IGCVersion_247040

Retrieves the current server version.

```APIDOC
## GET /IGCVersion_247040/GetServerVersion/v1/

### Description
Retrieves the current version of the server.

### Method
GET

### Endpoint
https://api.steampowered.com/IGCVersion_247040/GetServerVersion/v1/
```

--------------------------------

### GET GetSupportedApps/v1/

Source: https://steamapi.xpaw.me/ISteamCloudGaming

Retrieves a list of supported applications for a specified cloud gaming platform.

```APIDOC
## GET GetSupportedApps/v1/

### Description
Retrieves a list of applications supported on a specific cloud gaming platform.

### Method
GET

### Endpoint
https://api.steampowered.com/ISteamCloudGaming/GetSupportedApps/v1/

### Parameters
#### Query Parameters
- **platform** (string) - Required - Cloud gaming platform name
- **detailed** (bool) - Optional - Request extra details if supported
```

--------------------------------

### GET GetNicknameList

Source: https://steamapi.xpaw.me/IPlayerService

Gets the list of nicknames this user has for other users.

```APIDOC
## GET https://api.steampowered.com/IPlayerService/GetNicknameList/v1/

### Description
Gets the list of nicknames this user has for other users.

### Method
GET

### Endpoint
https://api.steampowered.com/IPlayerService/GetNicknameList/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
```

--------------------------------

### POST InitTxn/v3

Source: https://steamapi.xpaw.me/ISteamMicroTxnSandbox

Initializes a new transaction.

```APIDOC
## POST https://partner.steam-api.com/ISteamMicroTxnSandbox/InitTxn/v3/

### Description
Initializes a transaction for a user purchase.

### Method
POST

### Endpoint
https://partner.steam-api.com/ISteamMicroTxnSandbox/InitTxn/v3/

### Parameters
#### Request Body
- **orderid** (uint64) - Required - 3rd party ID for transaction
- **steamid** (uint64) - Required - SteamID of user making purchase
- **appid** (uint32) - Required - AppID of game this transaction is for
- **itemcount** (uint32) - Required - Number of items in cart
- **language** (string) - Required - ISO 639-1 language code of description
- **currency** (string) - Required - ISO 4217 currency code
- **itemid[0]+** (uint32[]) - Required - 3rd party ID for item
- **qty[0]+** (uint32[]) - Required - Quantity of this item
- **amount[0]+** (int32[]) - Required - Total cost (in cents) of item(s)
- **description[0]+** (string[]) - Required - Description of item
```

--------------------------------

### GET GetFavoriteBadge

Source: https://steamapi.xpaw.me/IPlayerService

Gets the badge the user has set as their favorite.

```APIDOC
## GET https://api.steampowered.com/IPlayerService/GetFavoriteBadge/v1/

### Description
Gets the badge the user has set as their favorite.

### Method
GET

### Endpoint
https://api.steampowered.com/IPlayerService/GetFavoriteBadge/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **steamid** (uint64) - Optional
```

--------------------------------

### GET GetBadges

Source: https://steamapi.xpaw.me/IPlayerService

Gets badges that are owned by a specific user.

```APIDOC
## GET https://api.steampowered.com/IPlayerService/GetBadges/v1/

### Description
Gets badges that are owned by a specific user.

### Method
GET

### Endpoint
https://api.steampowered.com/IPlayerService/GetBadges/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **steamid** (uint64) - Required - The player we're asking about
```

--------------------------------

### POST CreatePlan

Source: https://steamapi.xpaw.me/IPromotionPlanningService

Creates a new promotion plan.

```APIDOC
## POST https://api.steampowered.com/IPromotionPlanningService/CreatePlan/v1/

### Description
Creates a new promotion plan with the provided details.

### Method
POST

### Endpoint
https://api.steampowered.com/IPromotionPlanningService/CreatePlan/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key

#### Request Body
- **plan** (CPromotionPlan) - Optional - The promotion plan object containing promotion_id, admin_jsondata, partner_jsondata, input_jsondata, rtime32_start_time, rtime32_end_time, partner_id, input_access_key, last_update_time, partner_readonly_jsondata, partner_writable_jsondata, assets_readonly_jsondata, and assets_writable_jsondata.
```

--------------------------------

### POST BeginAuthSessionViaCredentials

Source: https://steamapi.xpaw.me/IAuthenticationService

Starts the authentication process using user credentials.

```APIDOC
## POST /IAuthenticationService/BeginAuthSessionViaCredentials/v1/

### Description
Starts the authentication process using user credentials.

### Method
POST

### Endpoint
https://api.steampowered.com/IAuthenticationService/BeginAuthSessionViaCredentials/v1/

### Parameters
#### Request Body
- **device_friendly_name** (string) - Required
- **account_name** (string) - Required
- **encrypted_password** (string) - Required - Password, RSA encrypted client side
- **encryption_timestamp** (uint64) - Required - Timestamp to map to a key
- **remember_login** (bool) - Required - Deprecated
- **platform_type** ({enum}) - Required
- **persistence** ({enum}) - Optional - Whether we are requesting a persistent or an ephemeral session
- **website_id** (string) - Optional - Identifier of client requesting auth
- **device_details** ({message}) - Required - User-supplied details about the device attempting to sign in
- **guard_data** (string) - Required - Steam guard data for client login
- **language** (uint32) - Required
- **qos_level** (int32) - Optional - Client-specified priority for this auth attempt
```

--------------------------------

### GET GetPriceSheet

Source: https://steamapi.xpaw.me/IInventoryService

Get the Inventory Service price sheet.

```APIDOC
## GET https://api.steampowered.com/IInventoryService/GetPriceSheet/v1/

### Description
Get the Inventory Service price sheet.

### Method
GET

### Endpoint
https://api.steampowered.com/IInventoryService/GetPriceSheet/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **ecurrency** (int32) - Required - Currency ID
- **currency_code** (string) - Required - Standard short code of the requested currency
```

--------------------------------

### GET /IGCVersion_3488080/GetServerVersion/v1/

Source: https://steamapi.xpaw.me/IGCVersion_3488080

Retrieves the current server version.

```APIDOC
## GET /IGCVersion_3488080/GetServerVersion/v1/

### Description
Retrieves the current server version for the IGCVersion_3488080 service.

### Method
GET

### Endpoint
https://api.steampowered.com/IGCVersion_3488080/GetServerVersion/v1/
```

--------------------------------

### GET GetAddItemHistory

Source: https://steamapi.xpaw.me/IInventoryService

Gets a list of items that have been added to accounts.

```APIDOC
## GET https://partner.steam-api.com/IInventoryService/GetAddItemHistory/v1/

### Description
Gets a list of items that have been added to accounts.

### Method
GET

### Endpoint
https://partner.steam-api.com/IInventoryService/GetAddItemHistory/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **appid** (uint32) - Required - 
- **max_results** (uint32) - Optional - 
- **start_highwater** (uint64) - Required - 
- **start_timestamp** (uint32) - Required -
```

--------------------------------

### POST LaunchClientApp

Source: https://steamapi.xpaw.me/IClientCommService

Launches an application on the Steam client.

```APIDOC
## POST https://api.steampowered.com/IClientCommService/LaunchClientApp/v1/

### Description
Launches an application on the Steam client.

### Method
POST

### Endpoint
https://api.steampowered.com/IClientCommService/LaunchClientApp/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **client_instanceid** (uint64) - Optional
- **appid** (uint32) - Optional
- **query_params** (string) - Optional
```

--------------------------------

### POST CreateProject

Source: https://steamapi.xpaw.me/ISteamLearnService

Creates a new project.

```APIDOC
## POST /ISteamLearnService/CreateProject/v1/

### Description
Creates a new project.

### Method
POST

### Endpoint
https://api.steampowered.com/ISteamLearnService/CreateProject/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key

#### Request Body
- **project_name** (string) - Optional
- **project_description** (string) - Optional
```

--------------------------------

### GET GetPurchaseRequests

Source: https://steamapi.xpaw.me/IFamilyGroupsService

Get pending purchase requests for the family.

```APIDOC
## GET /IFamilyGroupsService/GetPurchaseRequests/v1/

### Description
Get pending purchase requests for the family.

### Method
GET

### Endpoint
https://api.steampowered.com/IFamilyGroupsService/GetPurchaseRequests/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **family_groupid** (uint64) - Optional
- **include_completed** (bool) - Optional
- **request_ids[0]+** (uint64[]) - Optional
- **rt_include_completed_since** (uint32) - Optional
```

--------------------------------

### GET GetDiscoveryQueue

Source: https://steamapi.xpaw.me/IStoreService

Get a list of games for the user to explore on the store.

```APIDOC
## GET https://api.steampowered.com/IStoreService/GetDiscoveryQueue/v1/

### Description
Get a list of games for the user to explore on the store.

### Method
GET

### Endpoint
https://api.steampowered.com/IStoreService/GetDiscoveryQueue/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **queue_type** (enum) - Optional - EStoreDiscoveryQueueType
- **country_code** (string) - Optional
- **rebuild_queue** (bool) - Optional
- **settings_changed** (bool) - Optional
- **settings** (CStoreDiscoveryQueueSettings) - Optional
- **rebuild_queue_if_stale** (bool) - Optional
- **ignore_user_preferences** (bool) - Optional
- **no_experimental_results** (bool) - Optional
- **experimental_cohort** (uint32) - Optional
- **debug_get_solr_query** (bool) - Optional
- **store_page_filter** (CStorePageFilter) - Optional
- **context** (StoreBrowseContext) - Optional
- **data_request** (StoreBrowseItemDataRequest) - Optional
```

--------------------------------

### POST BeginAuthSessionViaQR

Source: https://steamapi.xpaw.me/IAuthenticationService

Starts the authentication process using a QR code.

```APIDOC
## POST /IAuthenticationService/BeginAuthSessionViaQR/v1/

### Description
Starts the authentication process using a QR code.

### Method
POST

### Endpoint
https://api.steampowered.com/IAuthenticationService/BeginAuthSessionViaQR/v1/

### Parameters
#### Request Body
- **device_friendly_name** (string) - Required
- **platform_type** ({enum}) - Required
- **device_details** ({message}) - Required - User-supplied details about the device attempting to sign in
- **website_id** (string) - Optional - Identifier of client requesting auth
```

--------------------------------

### POST GetLogContentsForTraining/v1

Source: https://steamapi.xpaw.me/ISteamMLService

Retrieves log contents formatted for machine learning training processes.

```APIDOC
## POST /ISteamMLService/GetLogContentsForTraining/v1/

### Description
Retrieves log contents for training purposes based on provided parameters.

### Method
POST

### Endpoint
https://api.steampowered.com/ISteamMLService/GetLogContentsForTraining/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **name** (string) - Optional
- **lane** (int32) - Optional
- **stride** (int32) - Optional
- **salt** (int32) - Optional
- **goal_examples** (int32) - Optional
- **train_pcg** (float) - Optional
- **train_accept** (bool) - Optional
- **appid** (uint32) - Optional
- **channel** (string) - Optional
- **restart** (bool) - Optional
- **count_lines_as_examples** (bool) - Optional
- **retry** (bool) - Optional
- **version** (int32) - Optional
```

--------------------------------

### POST BeginHTTPUpload

Source: https://steamapi.xpaw.me/ICloudService

Begins the process of uploading a file to Steam external storage services via HTTP PUT.

```APIDOC
## POST https://api.steampowered.com/ICloudService/BeginHTTPUpload/v1/

### Description
Begins the process of uploading a file to Steam external storage services. File should be uploaded via HTTP PUT to the returned URL, after which the upload must be finalized by a call to CommitHTTPUpload.

### Method
POST

### Endpoint
https://api.steampowered.com/ICloudService/BeginHTTPUpload/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **appid** (uint32) - Optional - App ID for which the file is being uploaded.
- **file_size** (uint32) - Optional - Original file size in bytes.
- **filename** (string) - Optional - Name of the file to store in the cloud.
- **file_sha** (string) - Optional - Hex string (40 digits) representing the SHA1 digest of the file.
- **is_public** (bool) - Optional - True if the file should be marked public on the UFS, false otherwise.
- **platforms_to_sync[0]+** (string[]) - Optional - Array of string specifying which platforms to sync.
- **request_headers_names[0]+** (string[]) - Optional - Names for headers you'll want to set on your upload request.
- **request_headers_values[0]+** (string[]) - Optional - Values for headers you'll want to set on your upload request.
- **upload_batch_id** (uint64) - Optional - ID of this batch returned by prior BeginAppUploadBatch call.
```

--------------------------------

### GET GetGameAchievements

Source: https://steamapi.xpaw.me/IPlayerService

Get a games available achievements for display purposes.

```APIDOC
## GET https://api.steampowered.com/IPlayerService/GetGameAchievements/v1/

### Description
Get a games available achievements for display purposes.

### Method
GET

### Endpoint
https://api.steampowered.com/IPlayerService/GetGameAchievements/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **appid** (uint32) - Optional
- **language** (string) - Optional - Lowercase, language shortnames
- **hash_only** (bool) - Optional
```

--------------------------------

### POST Create

Source: https://steamapi.xpaw.me/IClanFAQSService

Creates a new FAQ for a clan.

```APIDOC
## POST /IClanFAQSService/Create/v1/

### Description
Creates a new FAQ for a clan.

### Method
POST

### Endpoint
https://api.steampowered.com/IClanFAQSService/Create/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **steamid** (uint64) - Optional - The clan the FAQ is for.
- **internal_name** (string) - Optional - Human-readable name, for editor use only.
- **json_data** (string) - Optional - extra metadata, like legacy KB data. Optional.
```

--------------------------------

### GET GetAvatarFrame

Source: https://steamapi.xpaw.me/IPlayerService

Gets which avatar frame is active for a specific user.

```APIDOC
## GET https://api.steampowered.com/IPlayerService/GetAvatarFrame/v1/

### Description
Gets which avatar frame is active for a specific user.

### Method
GET

### Endpoint
https://api.steampowered.com/IPlayerService/GetAvatarFrame/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **steamid** (fixed64) - Optional - The player we're asking about
- **language** (string) - Optional
```

--------------------------------

### GET GetAnimatedAvatar

Source: https://steamapi.xpaw.me/IPlayerService

Gets which animated avatar is active for a specific user.

```APIDOC
## GET https://api.steampowered.com/IPlayerService/GetAnimatedAvatar/v1/

### Description
Gets which animated avatar is active for a specific user.

### Method
GET

### Endpoint
https://api.steampowered.com/IPlayerService/GetAnimatedAvatar/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **steamid** (fixed64) - Optional - The player we're asking about
- **language** (string) - Optional
```

--------------------------------

### GET GetAllPlansForApps

Source: https://steamapi.xpaw.me/IPromotionPlanningService

Retrieves all promotion plans for specific applications.

```APIDOC
## GET https://api.steampowered.com/IPromotionPlanningService/GetAllPlansForApps/v1/

### Description
Retrieves promotion plans associated with a list of application IDs.

### Method
GET

### Endpoint
https://api.steampowered.com/IPromotionPlanningService/GetAllPlansForApps/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **appids[0]+** (uint32[]) - Optional
- **exclude_sales** (bool) - Optional
- **exclude_direct_featuring** (bool) - Optional
```

--------------------------------

### GET GetParentalSettings/v1

Source: https://steamapi.xpaw.me/IParentalService

Get the current parental settings for the logged in account.

```APIDOC
## GET https://api.steampowered.com/IParentalService/GetParentalSettings/v1/

### Description
Get the current parental settings for the logged in account.

### Method
GET

### Endpoint
https://api.steampowered.com/IParentalService/GetParentalSettings/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **steamid** (fixed64) - Optional
```

--------------------------------

### POST CreateSession

Source: https://steamapi.xpaw.me/IGameNotificationsService

Creates an async game session.

```APIDOC
## POST https://partner.steam-api.com/IGameNotificationsService/CreateSession/v1/

### Description
Creates an async game session.

### Method
POST

### Endpoint
https://partner.steam-api.com/IGameNotificationsService/CreateSession/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **appid** (uint32) - Required - The appid to create the session for.
- **context** (uint64) - Required - Game-specified context value the game can used to associate the session with some object on their backend.
- **title** ({message}) - Required - The title of the session to be displayed within each user's list of sessions.
- **users** ({message}) - Required - 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.
```

--------------------------------

### GET GetItemDefMeta

Source: https://steamapi.xpaw.me/IInventoryService

Get metadata about the current item definition for this game.

```APIDOC
## GET https://api.steampowered.com/IInventoryService/GetItemDefMeta/v1/

### Description
Get metadata about the current item definition for this game.

### Method
GET

### Endpoint
https://api.steampowered.com/IInventoryService/GetItemDefMeta/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **appid** (uint32) - Optional - App ID
```

--------------------------------

### GET GetActiveMessageSessions/v1/

Source: https://steamapi.xpaw.me/IFriendMessagesService

Get information about recent offline messages and chats.

```APIDOC
## GET https://api.steampowered.com/IFriendMessagesService/GetActiveMessageSessions/v1/

### Description
Get information about recent offline messages and chats.

### Method
GET

### Endpoint
https://api.steampowered.com/IFriendMessagesService/GetActiveMessageSessions/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **lastmessage_since** (uint32) - Optional - return only session information where a chat message has been sent since this time (for polling)
- **only_sessions_with_messages** (bool) - Optional - If non-zero, return only message sessions that have messages since our message cutoff. If zero, we return all active sessions.
```

--------------------------------

### GET GetProject/v1/

Source: https://steamapi.xpaw.me/ISteamLearnService

Retrieves information about a specific Steam Learn project.

```APIDOC
## GET https://api.steampowered.com/ISteamLearnService/GetProject/v1/

### Description
Retrieves information about a specific Steam Learn project.

### Method
GET

### Endpoint
https://api.steampowered.com/ISteamLearnService/GetProject/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **project_id** (uint32) - Optional
```

--------------------------------

### GET GetMiniProfileBackground

Source: https://steamapi.xpaw.me/IPlayerService

Gets which mini profile background is active for a specific user.

```APIDOC
## GET https://api.steampowered.com/IPlayerService/GetMiniProfileBackground/v1/

### Description
Gets which mini profile background is active for a specific user.

### Method
GET

### Endpoint
https://api.steampowered.com/IPlayerService/GetMiniProfileBackground/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **steamid** (fixed64) - Optional - The player we're asking about
- **language** (string) - Optional
```

--------------------------------

### POST CreateLobby

Source: https://steamapi.xpaw.me/ILobbyMatchmakingService

Creates a new lobby and sets its initial lobby data.

```APIDOC
## POST /ILobbyMatchmakingService/CreateLobby/v1/

### Description
Creates a lobby and sets its related lobby data.

### Method
POST

### Endpoint
https://partner.steam-api.com/ILobbyMatchmakingService/CreateLobby/v1/

### Parameters
#### Query Parameters
- **key** (string) - Access key
- **appid** (uint32) - App ID
- **max_members** (int32) - Maximum number of members
- **lobby_type** (int32) - Type of lobby
- **lobby_name** (string) - Name of the lobby
- **steamid_invited_members** (uint64) - SteamID of invited members
- **lobby_metadata** ({message}) - Metadata for the lobby
```

--------------------------------

### GET GetFriendsGameplayInfo

Source: https://steamapi.xpaw.me/IPlayerService

Get a list of friends who are playing, have played, own, or want a game.

```APIDOC
## GET https://api.steampowered.com/IPlayerService/GetFriendsGameplayInfo/v1/

### Description
Get a list of friends who are playing, have played, own, or want a game.

### Method
GET

### Endpoint
https://api.steampowered.com/IPlayerService/GetFriendsGameplayInfo/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **appid** (uint32) - Optional
```

--------------------------------

### GET /IStoreMarketingService/GetFrontPageConfig/v1/

Source: https://steamapi.xpaw.me/IStoreMarketingService

Retrieves the configuration for the store front page.

```APIDOC
## GET /IStoreMarketingService/GetFrontPageConfig/v1/

### Description
Retrieves the configuration for the store front page, allowing for customized data requests and localization settings.

### Method
GET

### Endpoint
https://api.steampowered.com/IStoreMarketingService/GetFrontPageConfig/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
- **context** (StoreBrowseContext) - Optional - Contextual settings including language, elanguage, and country_code
- **data_request** (StoreBrowseItemDataRequest) - Optional - Specifies the data fields to include in the response
```

--------------------------------

### GET GetAccountList

Source: https://steamapi.xpaw.me/IGameServersService

Gets a list of game server accounts with their logon tokens.

```APIDOC
## GET https://api.steampowered.com/IGameServersService/GetAccountList/v1/

### Description
Gets a list of game server accounts with their logon tokens.

### Parameters
#### Query Parameters
- **key** (string) - Required - Access key
```
Tokens:
Raw