Difference between revisions of "WebAPI/ResolveVanityURL"

From Team Fortress Wiki
Jump to: navigation, search
m
('''Main article about WebAPI.''')
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
'''Main article about [[WebAPI]].'''
 
== URL ==
 
== URL ==
<nowiki>http://api.steampowered.com/ISteamUser/ResolveVanityURL/v0001/</nowiki>
+
<nowiki>GET http://api.steampowered.com/ISteamUser/ResolveVanityURL/v0001/</nowiki>
  
See the [[WebAPI#appids|ID list]] for a valid ID.
+
== Example ==
  
== Method-specific Parameters ==
+
http://api.steampowered.com/ISteamUser/ResolveVanityURL/v0001/?key=XXXXXXXXXXXXXXXXXXXXXXX&vanityurl=userVanityUrlName
;vanityurl: The vanity URL part of a user's Steam profile URL. This is the basename of <nowiki>http://steamcommunity.com/id/</nowiki> URLs.
+
 
 +
== Arguments ==
 +
 
 +
;key: Your [https://steamcommunity.com/dev/apikey Steam API Key]
 +
;vanityurl: The user's vanity URL that you would like to retrieve a steam ID for, e.g. http://steamcommunity.com/id/gabelogannewell would use "gabelogannewell"
  
 
== Result Data ==
 
== Result Data ==
Line 14: Line 19:
 
:;{{API optional|message}}: The message associated with the request status. Currently only used on resolution failures.
 
:;{{API optional|message}}: The message associated with the request status. Currently only used on resolution failures.
  
{{Languages|WebAPI/ResolveVanityURL}}
 
 
[[Category:WebAPI|ResolveVanityURL]]
 
[[Category:WebAPI|ResolveVanityURL]]

Latest revision as of 20:17, 18 December 2021

Main article about WebAPI.

URL

GET http://api.steampowered.com/ISteamUser/ResolveVanityURL/v0001/

Example

http://api.steampowered.com/ISteamUser/ResolveVanityURL/v0001/?key=XXXXXXXXXXXXXXXXXXXXXXX&vanityurl=userVanityUrlName

Arguments

key
Your Steam API Key
vanityurl
The user's vanity URL that you would like to retrieve a steam ID for, e.g. http://steamcommunity.com/id/gabelogannewell would use "gabelogannewell"

Result Data

response
success
The status of the request. 1 if successful, 42 if there was no match.
steamid (Optional)
The 64 bit Steam ID the vanity URL resolves to. Not returned on resolution failures.
message (Optional)
The message associated with the request status. Currently only used on resolution failures.