Skip to content
This repository has been archived by the owner on May 8, 2021. It is now read-only.

A RESTful API providing a proxy for the Steam Player API

Notifications You must be signed in to change notification settings

gilmoreg/steam-battle-serverless

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Steam-Battle-Serverless

A RESTful API providing a proxy for the Steam Player API. Serves as the backend for steam-battle.

steam-battle-api exposes two routes:

  • /checkid?id=

Verifies the existence of a valid Steam ID. Accepts any of the three valid Steam ID types, or the name portion of a valid vanity url.

Given a valid Steam ID (as defined above), returns the following model:

{
  id,             // 64bit Steam ID
  profile: {
    avatar,    	  // URL for avatar image
    avatarfull,	  // URL for full size avatar image
    personaname,	// Persona name
    profileurl,	  // URL for Steam profile
  }
}
  • /player?id=

Given a valid 64-bit Steam ID, returns the following model:

{
  player: {
    id,		          // 64bit Steam ID
    profile: {
      avatar,    	  // URL for avatar image
      avatarfull,	  // URL for full size avatar image
      personaname,	// Persona name
      profileurl,	  // URL for Steam profile
    },
    score: {
      owned,	      // number of games owned
      playtime,	    // number of total hours played
      recent,	      // number of hours played in the last two weeks
      total		      // a total score (owned + playtime + recent)
    }
  }
}

Technical:

  • Hosted as Google Cloud Functions

Dependencies:

  • steamid for converting between Steam ID formats

About

A RESTful API providing a proxy for the Steam Player API

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published