### IClientCommService/InstallClientApp Source: https://steamapi.xpaw.me/index Installs an application on a Steam client instance. This endpoint triggers installation of the specified app. ```APIDOC ## POST IClientCommService/InstallClientApp ### Description Installs an application on a Steam client instance ### Parameters - **key** (string) - Required - Access key for API authentication - **appid** (integer) - Required - App ID of product to install - **client_instanceid** (string) - Optional - Uses first desktop session if not specified ``` -------------------------------- ### IBroadcastService/GetBuildClipStatus Source: https://steamapi.xpaw.me/index Starts building a broadcast clip. ```APIDOC ## POST /IBroadcastService/GetBuildClipStatus ### Description Starts building a broadcast clip. ### Method POST ### Endpoint /IBroadcastService/GetBuildClipStatus ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **broadcast_clip_id** (string) - Required - The ID of the broadcast clip to build. ### Request Example ```json { "key": "YOUR_API_KEY", "broadcast_clip_id": "YOUR_CLIP_ID" } ``` ### Response #### Success Response (200) * **status** (string) - The status of the clip building process (e.g., "Queued", "Processing", "Completed"). #### Response Example ```json { "status": "Queued" } ``` ``` -------------------------------- ### IStoreService/GetDiscoveryQueueSettings Source: https://steamapi.xpaw.me/index Get the settings that were used to generate a user's discovery queue. ```APIDOC ## GET IStoreService/GetDiscoveryQueueSettings ### Description Get the settings that were used to generate a user's discovery queue. ### Method GET ### Endpoint /IStoreService/GetDiscoveryQueueSettings ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **queue_type** (string) - Required. - **store_page_filter** (string) - Optional. ``` -------------------------------- ### IClientCommService/LaunchClientApp Source: https://steamapi.xpaw.me/index Launches an application on a Steam client instance. This endpoint starts the specified app with optional query parameters. ```APIDOC ## POST IClientCommService/LaunchClientApp ### Description Launches an application on a Steam client instance ### Parameters - **key** (string) - Required - Access key for API authentication - **client_instanceid** (string) - Required - Client instance ID - **appid** (integer) - Required - App ID to launch - **query_params** (string) - Optional - Query parameters to pass to the app ``` -------------------------------- ### IStoreService/GetAppList Source: https://steamapi.xpaw.me/index Gets a list of apps available on the Steam Store. ```APIDOC ## GET IStoreService/GetAppList ### Description Gets a list of apps available on the Steam Store. ### Method GET ### Endpoint /IStoreService/GetAppList ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **if_modified_since** (string) - 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** (boolean) - Optional - Include games (defaults to enabled). - **include_dlc** (boolean) - Optional - Include DLC. - **include_software** (boolean) - Optional - Include software items. - **include_videos** (boolean) - Optional - Include videos and series. - **include_hardware** (boolean) - Optional - Include hardware. - **last_appid** (integer) - Optional - For continuations, this is the last appid returned from the previous call. - **max_results** (integer) - Optional - Number of results to return at a time. Default 10k, max 50k. ``` -------------------------------- ### IUserReviewsService/GetFriendsRecommendedApp Source: https://steamapi.xpaw.me/index Gets a list of applications recommended by the user's friends. ```APIDOC ## IUserReviewsService/GetFriendsRecommendedApp ### Description Gets a list of applications recommended by the user's friends. ### Method GET ### Endpoint /IUserReviewsService/GetFriendsRecommendedApp ### Parameters #### Query Parameters - **key** (string) - Required - Access key - **appid** (integer) - Required - The AppID for which to get friend recommendations. ``` -------------------------------- ### IStoreService/GetDiscoveryQueue Source: https://steamapi.xpaw.me/index Get a list of games for the user to explore on the store. ```APIDOC ## GET IStoreService/GetDiscoveryQueue ### Description Get a list of games for the user to explore on the store. ### Method GET ### Endpoint /IStoreService/GetDiscoveryQueue ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **queue_type** (string) - Required. - **country_code** (string) - Optional. - **rebuild_queue** (boolean) - Optional. - **settings_changed** (boolean) - Optional. - **settings** (object) - Optional. - **rebuild_queue_if_stale** (boolean) - Optional. - **ignore_user_preferences** (boolean) - Optional. - **no_experimental_results** (boolean) - Optional. - **experimental_cohort** (string) - Optional. - **debug_get_solr_query** (boolean) - Optional. - **store_page_filter** (string) - Optional. - **context** (object) - Required. - **data_request** (object) - Optional. ``` -------------------------------- ### IPlayerService/GetProfileThemesAvailable Source: https://steamapi.xpaw.me/index Gets the profile themes that are available for a user. Requires an access key. ```APIDOC ## GET IPlayerService/GetProfileThemesAvailable ### Description Retrieves a list of profile themes that are available for users. ### Method GET ### Endpoint /IPlayerService/GetProfileThemesAvailable/ ### Parameters #### Query Parameters - **key** (string) - Required - Your Steamworks Web API access key. ``` -------------------------------- ### IAuthenticationService API Source: https://steamapi.xpaw.me/index Endpoints for managing user authentication, including starting authentication sessions, generating tokens, and revoking access. ```APIDOC ## POST /IAuthenticationService/BeginAuthSessionViaCredentials ### Description Starts an authentication process using user credentials. ### Method POST ### Endpoint /IAuthenticationService/BeginAuthSessionViaCredentials ### Parameters #### Request Body - **device_friendly_name** (string) - Required - A user-friendly name for the device. - **account_name** (string) - Required - The user's account name. - **encrypted_password** (string) - Required - The user's password, RSA encrypted client-side. - **encryption_timestamp** (integer) - Required - Timestamp to map to an encryption key. - **remember_login** (boolean) - Deprecated. - **platform_type** (integer) - Required - The platform type. - **persistence** (boolean) - Required - Whether to request a persistent or ephemeral session. - **website_id** (integer) - Required - Identifier of the client requesting authentication. - **device_details** (object) - Required - User-supplied details about the device. - **guard_data** (object) - Required - Steam Guard data for client login. - **language** (string) - Required - The language for the authentication process. - **qos_level** (integer) - Required - Client-specified priority for the authentication attempt. ### Request Example ```json { "device_friendly_name": "My PC", "account_name": "username", "encrypted_password": "ENCRYPTED_PASSWORD_HERE", "encryption_timestamp": 1678886400, "remember_login": false, "platform_type": 2, "persistence": true, "website_id": 1, "device_details": {}, "guard_data": {}, "language": "en", "qos_level": 3 } ``` ### Response #### Success Response (200) (No specific response fields provided in the documentation) ## POST /IAuthenticationService/BeginAuthSessionViaQR ### Description Starts an authentication process using a QR code. ### Method POST ### Endpoint /IAuthenticationService/BeginAuthSessionViaQR ### Parameters #### Request Body - **device_friendly_name** (string) - Required - A user-friendly name for the device. - **platform_type** (integer) - Required - The platform type. - **device_details** (object) - Required - User-supplied details about the device. - **website_id** (integer) - Required - Identifier of the client requesting authentication. ### Request Example ```json { "device_friendly_name": "My Mobile Device", "platform_type": 3, "device_details": {}, "website_id": 2 } ``` ### Response #### Success Response (200) (No specific response fields provided in the documentation) ## GET /IAuthenticationService/EnumerateTokens ### Description Enumerates durable (refresh) tokens for the given subject account. ### Method GET ### Endpoint /IAuthenticationService/EnumerateTokens ### Parameters #### Query Parameters - **key** (string) - Required - Access key for authentication. - **include_revoked** (boolean) - Required - Whether to include revoked tokens. ### Request Example ```json { "key": "YOUR_ACCESS_KEY", "include_revoked": false } ``` ### Response #### Success Response (200) (No specific response fields provided in the documentation) ## POST /IAuthenticationService/GenerateAccessTokenForApp ### Description Generates an access token for a specific application using a refresh token. ### Method POST ### Endpoint /IAuthenticationService/GenerateAccessTokenForApp ### Parameters #### Query Parameters - **key** (string) - Required - Access key for authentication. - **refresh_token** (string) - Required - The refresh token. - **steamid** (string) - Required - The Steam ID of the user. - **renewal_type** (integer) - Required - The type of renewal. ### Request Example ```json { "key": "YOUR_ACCESS_KEY", "refresh_token": "REFRESH_TOKEN_HERE", "steamid": "STEAM_ID_OF_USER", "renewal_type": 1 } ``` ### Response #### Success Response (200) (No specific response fields provided in the documentation) ## GET /IAuthenticationService/GetAuthSessionInfo ### Description Retrieves metadata of a specific authentication session. ### Method GET ### Endpoint /IAuthenticationService/GetAuthSessionInfo ### Parameters #### Query Parameters - **client_id** (string) - Required - Client ID from the scanned QR Code, used for routing. ### Request Example ```json { "client_id": "QR_CODE_CLIENT_ID" } ``` ### Response #### Success Response (200) (No specific response fields provided in the documentation) ## GET /IAuthenticationService/GetAuthSessionRiskInfo ### Description Retrieves risk metadata for a specific authentication session that has been deemed risky. ### Method GET ### Endpoint /IAuthenticationService/GetAuthSessionRiskInfo ### Parameters #### Query Parameters - **client_id** (string) - Required - Client ID from the scanned QR Code, used for routing. - **language** (string) - Required - The language for optimistic localization of geolocation data. ### Request Example ```json { "client_id": "QR_CODE_CLIENT_ID", "language": "en" } ``` ### Response #### Success Response (200) (No specific response fields provided in the documentation) ## GET /IAuthenticationService/GetAuthSessionsForAccount ### Description Gets all active authentication sessions for an account for reference by the mobile app. ### Method GET ### Endpoint /IAuthenticationService/GetAuthSessionsForAccount ### Parameters #### Query Parameters - **key** (string) - Required - Access key for authentication. ### Request Example ```json { "key": "YOUR_ACCESS_KEY" } ``` ### Response #### Success Response (200) (No specific response fields provided in the documentation) ## GET /IAuthenticationService/GetPasswordRSAPublicKey ### Description Fetches the RSA public key to use for encrypting passwords for a given account name. ### Method GET ### Endpoint /IAuthenticationService/GetPasswordRSAPublicKey ### Parameters #### Query Parameters - **account_name** (string) - Required - The user-provided account name to get an RSA key for. ### Request Example ```json { "account_name": "username" } ``` ### Response #### Success Response (200) (No specific response fields provided in the documentation) ## POST /IAuthenticationService/MigrateMobileSession ### Description Migrates a WG token to an access and refresh token using a signature generated with the user's 2FA secret. ### Method POST ### Endpoint /IAuthenticationService/MigrateMobileSession ### Parameters #### Query Parameters - **key** (string) - Required - Access key for authentication. - **steamid** (string) - Required - Steam ID of the user to migrate. - **token** (string) - Required - The WG Token to migrate. - **signature** (string) - Required - Signature over the WG token using the user's 2FA token. ### Request Example ```json { "key": "YOUR_ACCESS_KEY", "steamid": "STEAM_ID_OF_USER", "token": "WG_TOKEN_HERE", "signature": "SIGNATURE_HERE" } ``` ### Response #### Success Response (200) (No specific response fields provided in the documentation) ## POST /IAuthenticationService/NotifyRiskQuizResults ### Description Notifies the server about risk quiz responses for metrics purposes. ### Method POST ### Endpoint /IAuthenticationService/NotifyRiskQuizResults ### Parameters #### Request Body - **client_id** (string) - Required - Client ID for the auth session, used for routing. - **results** (array) - Required - Whether the user correctly answered each risk quiz question. - **selected_action** (integer) - Required - The action selected by the user during the quiz. - **did_confirm_login** (boolean) - Required - Whether the user confirmed the login after the quiz. ### Request Example ```json { "client_id": "QR_CODE_CLIENT_ID", "results": [true, false], "selected_action": 1, "did_confirm_login": true } ``` ### Response #### Success Response (200) (No specific response fields provided in the documentation) ## POST /IAuthenticationService/PollAuthSessionStatus ### Description Polls during the authentication process. ### Method POST ### Endpoint /IAuthenticationService/PollAuthSessionStatus ### Parameters #### Request Body - **client_id** (string) - Required - The client ID for the auth session. - **request_id** (string) - Required - The request ID. - **token_to_revoke** (string) - Optional - If set, this token owned by the user will be retired. ### Request Example ```json { "client_id": "QR_CODE_CLIENT_ID", "request_id": "REQUEST_ID_HERE", "token_to_revoke": "TOKEN_TO_REVOKE_HERE" } ``` ### Response #### Success Response (200) (No specific response fields provided in the documentation) ## POST /IAuthenticationService/RevokeRefreshToken ### Description Marks the given refresh token as revoked. ### Method POST ### Endpoint /IAuthenticationService/RevokeRefreshToken ### Parameters #### Query Parameters - **key** (string) - Required - Access key for authentication. - **token_id** (string) - Required - The ID of the refresh token to revoke. - **steamid** (string) - Optional - The Steam ID of the token holder if an admin action is performed on behalf of another user. - **revoke_action** (integer) - Required - Select between logout and logout-and-forget-machine. - **signature** (string) - Required - Required signature over the token ID. ### Request Example ```json { "key": "YOUR_ACCESS_KEY", "token_id": "TOKEN_ID_TO_REVOKE", "steamid": "ADMIN_STEAM_ID", "revoke_action": 1, "signature": "SIGNATURE_HERE" } ``` ### Response #### Success Response (200) (No specific response fields provided in the documentation) ## POST /IAuthenticationService/RevokeToken ### Description Revokes a single token immediately, making it unable to renew or generate new access tokens. ### Method POST ### Endpoint /IAuthenticationService/RevokeToken ### Parameters #### Query Parameters - **key** (string) - Required - Access key for authentication. - **token** (string) - Required - The token to revoke. - **revoke_action** (integer) - Required - Select between logout and logout-and-forget-machine. ### Request Example ```json { "key": "YOUR_ACCESS_KEY", "token": "TOKEN_TO_REVOKE_HERE", "revoke_action": 1 } ``` ### Response #### Success Response (200) (No specific response fields provided in the documentation) ## POST /IAuthenticationService/UpdateAuthSessionWithMobileConfirmation ### Description Approves an authentication session via mobile 2FA. ### Method POST ### Endpoint /IAuthenticationService/UpdateAuthSessionWithMobileConfirmation ### Parameters (No specific parameters provided in the documentation) ### Request Example ```json { } ``` ### Response #### Success Response (200) (No specific response fields provided in the documentation) ``` -------------------------------- ### ICloudService/EnumerateUserFiles Source: https://steamapi.xpaw.me/index Enumerates Cloud files for a user of a given app ID. Returns up to 500 files at a time, with options to get extended details, specify count, and starting index. ```APIDOC ## GET ICloudService/EnumerateUserFiles ### Description Enumerates Cloud files for a user of a given app ID. Returns up to 500 files at a time. ### Method GET ### Endpoint /ICloudService/EnumerateUserFiles ### Parameters #### Query Parameters - **key** (string) - Required - Access key - **appid** (integer) - Required - App ID to enumerate the files of. - **extended_details** (boolean) - Optional - Get extended details back on the files found. Defaults to only returned the app Id and UGC Id of the files found. - **count** (integer) - Optional - Maximum number of results to return on this call. Defaults to a maximum of 500 files returned. - **start_index** (integer) - Optional - Starting index to begin enumeration at. Defaults to the beginning of the list. - **access_token** (string) - Optional - OAuth access token for the user ### Request Example ```json { "key": "YOUR_ACCESS_KEY", "appid": 440, "extended_details": true, "count": 100, "start_index": 0, "access_token": "USER_OAUTH_TOKEN" } ``` ### Response #### Success Response (200) - **files** (array) - An array of file objects, each containing details about a cloud file. - **appid** (integer) - The App ID of the file. - **ugcid** (string) - The UGC ID of the file. - **filename** (string) - The name of the file. - **size** (integer) - The size of the file in bytes. - **last_updated** (string) - The timestamp of the last update. #### Response Example ```json { "files": [ { "appid": 440, "ugcid": "1234567890abcdef", "filename": "my_test_file.txt", "size": 1024, "last_updated": "2023-10-27T10:00:00Z" } ] } ``` ``` -------------------------------- ### IClanFAQSService/Create Source: https://steamapi.xpaw.me/index Creates a new FAQ for a specified clan. ```APIDOC ## POST IClanFAQSService/Create ### Description Creates a new FAQ for a specified clan. ### Method POST ### Endpoint /IClanFAQSService/Create ### Parameters #### Query Parameters - **key** (string) - Required - Access key - **steamid** (string) - Required - The clan the FAQ is for. - **internal_name** (string) - Required - Human-readable name, for editor use only. - **json_data** (string) - Optional - extra metadata, like legacy KB data. ### Response #### Success Response (200) - **success** (boolean) - Indicates if the FAQ creation was successful. - **faq_id** (string) - The unique identifier for the newly created FAQ. #### Response Example ```json { "success": true, "faq_id": "new_faq_123" } ``` ``` -------------------------------- ### GET /IParentalService/GetParentalSettings Source: https://steamapi.xpaw.me/index Get the current parental settings for the logged in account. This endpoint retrieves all active parental control configurations for a Steam account. ```APIDOC ## GET /IParentalService/GetParentalSettings ### Description Retrieve the current parental settings for the logged in account. ### Method GET ### Endpoint /IParentalService/GetParentalSettings ### Parameters #### Query Parameters - **key** (string) - Required - Access key for API authentication - **steamid** (string) - Required - Steam ID of the account ### Response #### Success Response (200) - **settings** (object) - Current parental control settings - **enabled** (boolean) - Whether parental controls are enabled ``` -------------------------------- ### ISteamLearnService/CreateProject Source: https://steamapi.xpaw.me/index Creates a new project within the Steam Learn Service. This involves specifying a project name and a description. ```APIDOC ## POST ISteamLearnService/CreateProject ### Description Creates a new project. ### Method POST ### Endpoint /ISteamLearnService/CreateProject ### Parameters #### Query Parameters - **key** (string) - Required - Access key #### Request Body - **project_name** (string) - Required - The name of the project. - **project_description** (string) - Optional - A description for the project. ### Request Example ```json { "project_name": "MyNewProject", "project_description": "This is a project for machine learning experiments." } ``` ### Response #### Success Response (200) - **project_id** (string) - The unique identifier for the newly created project. #### Response Example ```json { "project_id": "proj_12345abc" } ``` ``` -------------------------------- ### GET /IParentalService/GetSignedParentalSettings Source: https://steamapi.xpaw.me/index Get the current parental settings in a verified form. This endpoint retrieves parental settings in a cryptographically signed format that can be verified by the receiver. ```APIDOC ## GET /IParentalService/GetSignedParentalSettings ### Description Get the current parental settings in a form that can be verified by the receiver. ### Method GET ### Endpoint /IParentalService/GetSignedParentalSettings ### Parameters #### Query Parameters - **key** (string) - Required - Access key for API authentication - **priority** (integer) - Optional - Priority level for the request ### Response #### Success Response (200) - **signed_settings** (string) - Cryptographically signed parental settings - **signature** (string) - Digital signature for verification ``` -------------------------------- ### IClanFAQSService/PreviewDraft Source: https://steamapi.xpaw.me/index Previews a draft version of an FAQ before publishing. ```APIDOC ## POST IClanFAQSService/PreviewDraft ### Description Previews a draft version of an FAQ before publishing. ### Method POST ### Endpoint /IClanFAQSService/PreviewDraft ### Parameters #### Query Parameters - **key** (string) - Required - Access key - **steamid** (string) - Required - The clan the FAQ is for. - **faq_id** (string) - Required - The unique FAQ identifier. - **language** (string) - Required - The language of the draft to preview. - **version** (integer) - Required - The version number of the draft to preview. ### Response #### Success Response (200) - **preview_url** (string) - A URL to preview the FAQ draft. #### Response Example ```json { "preview_url": "http://example.com/faq/preview/clan_id/faq_id/version" } ``` ``` -------------------------------- ### GET /IOnlinePlayService/GetCoPlayStatus Source: https://steamapi.xpaw.me/index Get co-play status for two accounts. This endpoint retrieves whether two Steam accounts have played together in a specified app during a given time range. ```APIDOC ## GET /IOnlinePlayService/GetCoPlayStatus ### Description Retrieve co-play status information for two Steam accounts in a specific application. ### Method GET ### Endpoint /IOnlinePlayService/GetCoPlayStatus ### Parameters #### Query Parameters - **key** (string) - Required - Access key for API authentication - **steamid** (string) - Required - Steam ID 1 of request - **steamid2** (string) - Required - Steam ID 2 of request - **appid** (integer) - Required - App ID to check - **time_range_begin** (integer) - Required - Unix timestamp for range begin - **time_range_end** (integer) - Required - Unix timestamp for range end ### Response #### Success Response (200) - **co_played** (boolean) - Whether the two accounts co-played in the app during the time range - **playtime_seconds** (integer) - Total co-play time in seconds ``` -------------------------------- ### IPromotionPlanningService Endpoints Source: https://steamapi.xpaw.me/index Endpoints for managing promotion plans, including creation, retrieval, and updating. ```APIDOC ## POST /IPromotionPlanningService/CreatePlan ### Description Creates a new promotion plan. ### Method POST ### Endpoint /IPromotionPlanningService/CreatePlan ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **plan** (object) - Required - The promotion plan object. ### Request Example ```json { "key": "YOUR_ACCESS_KEY", "plan": { "promotion_name": "Spring Sale", "start_date": "2023-03-01", "end_date": "2023-03-15" } } ``` ### Response #### Success Response (200) - **promotion_id** (string) - The ID of the newly created promotion plan. #### Response Example ```json { "promotion_id": "promo_123" } ``` --- ## POST /IPromotionPlanningService/CreateSalePageForPromo ### Description Creates a sale page for a promotion. ### Method POST ### Endpoint /IPromotionPlanningService/CreateSalePageForPromo ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **clan_account_id** (integer) - Required. - **clan_event_gid** (string) - Required. - **rtime_sale_start** (integer) - Required - Unix timestamp for sale start. - **rtime_sale_end** (integer) - Required - Unix timestamp for sale end. - **daily_deal_gid** (string) - Optional. - **promotion_gid** (string) - Optional. - **create_asset_request** (object) - Required - Asset creation request details. - **partner_id** (integer) - Required. - **advertising_appid** (integer) - Optional. ### Request Example ```json { "key": "YOUR_ACCESS_KEY", "clan_account_id": 123, "clan_event_gid": "event_abc", "rtime_sale_start": 1678886400, "rtime_sale_end": 1679886400, "create_asset_request": {}, "partner_id": 456, "advertising_appid": 789 } ``` ### Response #### Success Response (200) - **sale_page_id** (string) - The ID of the created sale page. #### Response Example ```json { "sale_page_id": "sp_xyz" } ``` --- ## POST /IPromotionPlanningService/CreateTentativePlan ### Description Creates a tentative promotion plan. ### Method POST ### Endpoint /IPromotionPlanningService/CreateTentativePlan ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **plan** (object) - Required - The promotion plan object. ### Request Example ```json { "key": "YOUR_ACCESS_KEY", "plan": { "promotion_name": "Tentative Fall Sale", "start_date": "2023-09-01", "end_date": "2023-09-10" } } ``` ### Response #### Success Response (200) - **promotion_id** (string) - The ID of the newly created tentative promotion plan. #### Response Example ```json { "promotion_id": "tentative_promo_456" } ``` --- ## POST /IPromotionPlanningService/DeletePlan ### Description Deletes a promotion plan. ### Method POST ### Endpoint /IPromotionPlanningService/DeletePlan ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **promotion_id** (string) - Required - The ID of the promotion plan to delete. ### Request Example ```json { "key": "YOUR_ACCESS_KEY", "promotion_id": "promo_123" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the plan was deleted successfully. #### Response Example ```json { "success": true } ``` --- ## GET /IPromotionPlanningService/GetAdvertisingAppsForPartner ### Description Retrieves advertising apps for a given partner. ### Method GET ### Endpoint /IPromotionPlanningService/GetAdvertisingAppsForPartner ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **partner_id** (integer) - Required - The partner ID. ### Response #### Success Response (200) - **apps** (array) - An array of advertising app objects. #### Response Example ```json { "apps": [ { "appid": 789, "name": "Example Game" } ] } ``` --- ## GET /IPromotionPlanningService/GetAllActivePlan ### Description Retrieves all active promotion plans. ### Method GET ### Endpoint /IPromotionPlanningService/GetAllActivePlan ### Parameters #### Query Parameters - **key** (string) - Required - Access key. ### Response #### Success Response (200) - **plans** (array) - An array of active promotion plan objects. #### Response Example ```json { "plans": [ { "promotion_id": "promo_123", "promotion_name": "Spring Sale", "status": "active" } ] } ``` --- ## GET /IPromotionPlanningService/GetAllPlansForApps ### Description Retrieves all promotion plans for specified applications. ### Method GET ### Endpoint /IPromotionPlanningService/GetAllPlansForApps ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **appids** (array) - Required - An array of App IDs. - **exclude_sales** (boolean) - Optional. - **exclude_direct_featuring** (boolean) - Optional. ### Response #### Success Response (200) - **plans** (array) - An array of promotion plan objects for the specified apps. #### Response Example ```json { "plans": [ { "promotion_id": "promo_123", "promotion_name": "Spring Sale" } ] } ``` --- ## GET /IPromotionPlanningService/GetAllPlansForPartner ### Description Retrieves all promotion plans for a specific partner within a date range. ### Method GET ### Endpoint /IPromotionPlanningService/GetAllPlansForPartner ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **partnerid** (integer) - Required - The partner ID. - **start_date_after_rtime** (integer) - Optional - Unix timestamp for the start date. - **start_date_before_rtime** (integer) - Optional - Unix timestamp for the end date. - **show_hidden** (boolean) - Optional. - **start_date** (integer) - Optional - Unix timestamp for the start date. - **end_date** (integer) - Optional - Unix timestamp for the end date. ### Response #### Success Response (200) - **plans** (array) - An array of promotion plan objects for the partner. #### Response Example ```json { "plans": [ { "promotion_id": "promo_123", "promotion_name": "Partner Promotion" } ] } ``` --- ## GET /IPromotionPlanningService/GetPlan ### Description Retrieves a specific promotion plan by its ID. ### Method GET ### Endpoint /IPromotionPlanningService/GetPlan ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **promotion_id** (string) - Required - The ID of the promotion plan to retrieve. ### Response #### Success Response (200) - **plan** (object) - The promotion plan object. #### Response Example ```json { "plan": { "promotion_id": "promo_123", "promotion_name": "Spring Sale", "status": "active" } } ``` --- ## GET /IPromotionPlanningService/GetPlanByAssociationID ### Description Retrieves a promotion plan by its association ID. ### Method GET ### Endpoint /IPromotionPlanningService/GetPlanByAssociationID ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **requested** (array) - Required - An array containing the association ID. ### Response #### Success Response (200) - **plans** (array) - An array containing the promotion plan object. #### Response Example ```json { "plans": [ { "promotion_id": "promo_123", "promotion_name": "Spring Sale" } ] } ``` --- ## GET /IPromotionPlanningService/GetPlanByInputAccessKey ### Description Retrieves a promotion plan using an input access key. ### Method GET ### Endpoint /IPromotionPlanningService/GetPlanByInputAccessKey ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **input_access_key** (string) - Required - The input access key for the promotion plan. ### Response #### Success Response (200) - **plan** (object) - The promotion plan object. #### Response Example ```json { "plan": { "promotion_id": "promo_123", "promotion_name": "Spring Sale" } } ``` --- ## GET /IPromotionPlanningService/GetPlanCompletedInDateRange ### Description Retrieves promotion plans completed within a specified date range. ### Method GET ### Endpoint /IPromotionPlanningService/GetPlanCompletedInDateRange ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **oldest_rtime** (integer) - Required - Unix timestamp for the oldest completion date. - **newest_rtime** (integer) - Required - Unix timestamp for the newest completion date. - **promotion_types** (array) - Optional - An array of promotion types to filter by. ### Response #### Success Response (200) - **plans** (array) - An array of completed promotion plan objects. #### Response Example ```json { "plans": [ { "promotion_id": "promo_123", "promotion_name": "Spring Sale", "completion_date": 1679886400 } ] } ``` --- ## GET /IPromotionPlanningService/GetPlansUpdatedSince ### Description Retrieves promotion plans that have been updated since a specific time. ### Method ``` -------------------------------- ### ISteamApps/UpToDateCheck Source: https://steamapi.xpaw.me/index Checks if the installed version of a game is up to date. ```APIDOC ## GET ISteamApps/UpToDateCheck ### Description Checks if the installed version of a game is up to date. ### Method GET ### Endpoint /apps/ISteamApps/UpToDateCheck ### Parameters #### Query Parameters - **appid** (integer) - Required - AppID of game - **version** (string) - Required - The installed version of the game ``` -------------------------------- ### IStoreQueryService/Query Source: https://steamapi.xpaw.me/index Executes a general query against the store. ```APIDOC ## GET IStoreQueryService/Query ### Description Executes a general query against the store. ### Method GET ### Endpoint /IStoreQueryService/Query ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **query_name** (string) - Required - Descriptive name of the query or caller; will be used in logging and metrics. - **query** (object) - Required - The query parameters. - **context** (object) - Required - The context for the request. - **data_request** (object) - Optional - If passed, item data will be returned. - **override_country_code** (string) - Optional - 2-character override country code for pulling data from other countries. ``` -------------------------------- ### IStoreService/GetMostPopularTags Source: https://steamapi.xpaw.me/index Get all whitelisted tags, with localized names. ```APIDOC ## GET IStoreService/GetMostPopularTags ### Description Get all whitelisted tags, with localized names. ### Method GET ### Endpoint /IStoreService/GetMostPopularTags ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **language** (string) - Required - The language for the tag names. ``` -------------------------------- ### IStoreService/GetLocalizedNameForTags Source: https://steamapi.xpaw.me/index Gets tag names in a different language. ```APIDOC ## GET IStoreService/GetLocalizedNameForTags ### Description Gets tag names in a different language. ### Method GET ### Endpoint /IStoreService/GetLocalizedNameForTags ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **language** (string) - Required - The language for the tag names. - **tagids[0]** (integer) - Required - The IDs of the tags. ``` -------------------------------- ### IStoreService/GetGamesFollowedCount Source: https://steamapi.xpaw.me/index Get the number of games a user is following. ```APIDOC ## GET IStoreService/GetGamesFollowedCount ### Description Get the number of games a user is following. ### Method GET ### Endpoint /IStoreService/GetGamesFollowedCount ### Parameters #### Query Parameters - **steamid** (string) - Required - The SteamID of the user. ``` -------------------------------- ### ISteamMicroTxnSandbox/InitTxn Source: https://steamapi.xpaw.me/index Sandbox version of InitTxn endpoint for testing transaction initialization without processing real charges. Supports the same functionality as production with test data. ```APIDOC ## POST ISteamMicroTxnSandbox/InitTxn ### Description Initializes a test transaction in the sandbox environment for development and testing purposes. ### Parameters #### Query Parameters - **orderid** (string) - Required - 3rd party ID for transaction - **steamid** (string) - Required - SteamID of user making purchase - **appid** (integer) - Required - AppID of game this transaction is for - **itemcount** (integer) - Required - Number of items in cart - **language** (string) - Required - ISO 639-1 language code of description - **currency** (string) - Required - ISO 4217 currency code #### Item Parameters (Array) - **itemid[0]** (string) - Required - 3rd party ID for item - **qty[0]** (integer) - Required - Quantity of this item - **amount[0]** (integer) - Required - Total cost in cents of item(s) - **description[0]** (string) - Required - Description of item - **category[0]** (string) - Optional - Category grouping for item - **billingtype[0]** (string) - Optional - Recurring billing type - **startdate[0]** (string) - Optional - Start date for recurring billing - **enddate[0]** (string) - Optional - End date for recurring billing - **period[0]** (string) - Optional - Period for recurring billing - **frequency[0]** (string) - Optional - Frequency for recurring billing - **recurringamt[0]** (integer) - Optional - Recurring billing amount ``` -------------------------------- ### ISteamCloudGaming/GetSupportedApps Source: https://steamapi.xpaw.me/index Retrieves a list of apps supported by cloud gaming platforms. ```APIDOC ## GET ISteamCloudGaming/GetSupportedApps ### Description Retrieves a list of apps supported by cloud gaming platforms. ### Method GET ### Endpoint /cloudgaming/ISteamCloudGaming/GetSupportedApps ### Parameters #### Query Parameters - **platform** (string) - Required - Cloud gaming platform name - **detailed** (boolean) - Optional - Request extra details if supported ``` -------------------------------- ### IStoreService/GetGamesFollowed Source: https://steamapi.xpaw.me/index Get the list of games a user is following. ```APIDOC ## GET IStoreService/GetGamesFollowed ### Description Get the list of games a user is following. ### Method GET ### Endpoint /IStoreService/GetGamesFollowed ### Parameters #### Query Parameters - **steamid** (string) - Required - The SteamID of the user. ``` -------------------------------- ### IBroadcastService/GetBroadcastViewerStats Source: https://steamapi.xpaw.me/index Gets viewer statistics for a given broadcast. ```APIDOC ## GET /IBroadcastService/GetBroadcastViewerStats ### Description Gets viewer stats for a given broadcast. ### Method GET ### Endpoint /IBroadcastService/GetBroadcastViewerStats ### Parameters #### Query Parameters - **key** (string) - Required - Access key. - **upload_id** (string) - Required - Get stats for this stream. - **steamid** (string) - Optional - The steamid of the broadcast whose details you are requesting. ### Request Example ```json { "key": "YOUR_API_KEY", "upload_id": "YOUR_UPLOAD_ID" } ``` ### Response #### Success Response (200) * **viewer_stats** (object) - Viewer statistics for the broadcast. * **total_viewers** (integer) - Total number of unique viewers. * **peak_viewers** (integer) - Peak number of concurrent viewers. * **total_watch_time_seconds** (integer) - Total watch time in seconds. #### Response Example ```json { "viewer_stats": { "total_viewers": 150, "peak_viewers": 75, "total_watch_time_seconds": 540000 } } ``` ``` -------------------------------- ### IPlayerService/GetPurchasedAndUpgradedProfileCustomizations Source: https://steamapi.xpaw.me/index Returns the purchased and upgraded profile customizations for a user. Requires an access key and the user's SteamID. ```APIDOC ## GET IPlayerService/GetPurchasedAndUpgradedProfileCustomizations ### Description Fetches a list of profile customizations that a user has purchased and upgraded. ### Method GET ### Endpoint /IPlayerService/GetPurchasedAndUpgradedProfileCustomizations/ ### Parameters #### Query Parameters - **key** (string) - Required - Your Steamworks Web API access key. - **steamid** (string) - Required - The 64-bit SteamID of the player. ```