Difference between revisions of "WebAPI/ResolveVanityURL"
< WebAPI
(→Result Data: It might go without saying, but it *is* optional.) |
('''Main article about WebAPI.''') |
||
| (8 intermediate revisions by 6 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> |
| − | + | == Example == | |
| − | == | + | http://api.steampowered.com/ISteamUser/ResolveVanityURL/v0001/?key=XXXXXXXXXXXXXXXXXXXXXXX&vanityurl=userVanityUrlName |
| − | ;vanityurl: The | + | |
| + | == 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 11: | Line 16: | ||
;response: | ;response: | ||
:;success: The status of the request. 1 if successful, 42 if there was no match. | :;success: The status of the request. 1 if successful, 42 if there was no match. | ||
| − | :;steamid | + | :;{{API optional|steamid}}: The 64 bit Steam ID the vanity URL resolves to. Not returned on resolution failures. |
| − | :;message | + | :;{{API optional|message}}: The message associated with the request status. Currently only used on resolution failures. |
| − | |||
[[Category:WebAPI|ResolveVanityURL]] | [[Category:WebAPI|ResolveVanityURL]] | ||
Latest revision as of 20:17, 18 December 2021
Main article about WebAPI.
Contents
URL
GET http://api.steampowered.com/ISteamUser/ResolveVanityURL/v0001/
Example
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.
