- All Methods
- Example Requests & Meta Data
- Errors & Status Codes
- API Limits & Keys
- IdleSteam.com Account
- Steam Account
This is the Official REST API Documentation for IdleSteam.com to allow you to create your own Applications / Bots / Plugins around IdleSteam.com. Every request adds to a rate limit per API Key User which can be seen in your IdleSteam.com settings page.
Please request for any new methods you'd like added by contacting us.
All Methods
Method Overview
Request Domain
https://api.idlesteam.com/
Current Version
v1
Methods
/user/:username
Retrieve data for a IdleSteam.com User
/steamAccounts/:username
Fetch all Steam Accounts associated with IdleSteam.com User
/messages/:steam_id
Returns all messages associated with your Steam Account ID
/friendRequests/:steam_id
Returns all Friend Requests associated with your Steam Account ID
/errors/:steam_id
Returns all errors associated with your Steam Account ID
Required GET Parameter
?api_key=:your_api_key Alphanumeric
Notice Every API request requires an API Key which is in your IdleSteam.com settings page
Response Encoding
JSON
Example Requests & Meta Data
Here are some examples in different languages
Examples retrieving IdleSteam.com user information
GET https://api.idlesteam.com/v1/user/:username?api_key=[alphanumeric]
- CURL
- PHP (CURL)
- PHP
- RUBY
- PYTHON
- NODE
curl --request GET \
--url 'https://api.idlesteam.com/v1/user/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754'
<?php
$method = '/user/';
$value = 'demo_user';
$api_key = '82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754';
// BEGIN API Request code
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.idlesteam.com/v1' . $method . $value . '?api_key=' . $api_key);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$json = curl_exec($ch);
curl_close ($ch);
$data = json_decode($json);
// END API Request code
echo '<pre>' . print_r( $data , true ) . '</pre>';
<?php
$method = '/user/';
$value = 'demo_user';
$api_key = '82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754';
$url = 'https://api.idlesteam.com/v1' . $method . $value . '?api_key=' . $api_key;
$data = file_get_contents($url);
if ($data !== false) {
$data = json_decode($data);
echo '<pre>' . print_r( $data , true ) . '</pre>';
} else {
echo 'Failed, for more information visit the requested url in your browser: ' . htmlentities($url);
}
require 'net/http'
require 'json'
uri = URI.parse('https://api.idlesteam.com/v1/user/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri.request_uri)
response = http.request(request)
data = JSON[response.body]
puts data
import json
import requests
url = 'https://api.idlesteam.com/v1/user/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754'
response = requests.request('GET', url)
data = json.loads(response.text);
print( data )
const https = require('https');
https.get('https://api.idlesteam.com/v1/user/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754', (resp) => {
let data = '';
resp.on('data', (chunk) => {
data += chunk;
});
resp.on('end', () => {
console.log(data);
});
}).on('error', (err) => {
console.log('Error: ' + err.message);
});
Successful JSON Response
{
"meta" : {
"status_code" : 200,
"success" : true,
"message" : "",
"api_limit_usage" : 16,
"api_limit" : 500,
"total_results" : 1,
"href" : "https://api.idlesteam.com/v1/user/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754",
"docs_url" : "https://docs.idlesteam.com/"
},
"data" : {
"user" : "demo_user",
"upgraded" : true,
"expire_date" : "2019-04-25",
"steam_limit" : 7,
"game_limit" : 32,
"register_date" : "2016-04-12 11:25:11",
"last_login_date" : "2024-10-07 09:13:46",
"loading_games_message" : 1,
"package_name" : "Custom Package",
"package_type" : "custom",
"steam_accounts" : {
"href" : "https://api.idlesteam.com/v1/steamAccounts/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754"
}
}
}
Failed JSON Response
{
"meta" : {
"status_code" : 400,
"success" : false,
"error_code" : 1001,
"error_name" : "invalid_api_key",
"message" : "Your API Key is invalid. Please generate a key in your IdleSteam.com Settings area",
"api_limit_usage" : null,
"api_limit" : null,
"total_results" : null,
"href" : "https://api.idlesteam.com/v1/user/demo_user?api_key=invalid_key",
"docs_url" : "https://docs.idlesteam.com/"
}
}
Meta Field Data
status_codeinteger |
The HTTP Status Code that resulted from this request | successbool |
Whether or not the request was successful and returning data |
error_codeinteger |
The custom error code for more detail about what went wrong | error_namestring |
The short key error name |
messagestring |
Custom detailed error message | api_limit_usageinteger |
How many requests in the last 24 hours have been made |
api_limitinteger |
The limit of API requests in a 24 hour period | total_resultsinteger |
The amount of results from the API request |
hrefstring |
The URL of the request made | docs_urlstring |
The Documentation URL |
Errors & Status Codes
Every header error response code you may receive
Error Codes
1001 400 invalid_api_key
Your API Key is invalid. Please generate a key in your IdleSteam.com Settings area
1002 400 invalid_version_number
You must pass a valid version number to this request: /v1/
1003 405 method_not_found
This method does not exist, please check docs.idlesteam.com for valid methods
1004 400 value_not_found
Value required for this method. Descibed in docs.idlesteam.com with colons (:value)
1005 401 api_does_not_match_user
Your API key does not match this user
1006 401 api_does_not_match_steam_account
Your API key does not match this Steam Account
1007 401 api_does_not_match_messages_user
Your API Key does not own the steam account associated with these messages
1008 401 api_does_not_match_friend_requests_user
Your API Key does not own the steam account associated with these friend requests
1009 401 api_does_not_match_errors_user
Your API Key does not own the steam account associated with these errors
1010 429 too_many_requests
API Rate limit exceeded. Please contact us to get your rate limit increased.
1011 400 post_required
This method requires you to POST your data
Status Codes
200 OK
The request was successful (some API calls may return 201 instead)
201 Created
The request was successful and a resource was created
204 No Content
The request was successful but there is no representation to return (that is, the response is empty)
400 Bad Request
The request could not be understood or was missing required parameters
401 Unauthorized
Authentication failed or user does not have permissions for the requested operation
403 Forbidden
Access denied
404 Not Found
Resource was not found
405 Method Not Allowed
Requested method is not supported for the specified resource
429 Too Many Requests
Exceeded API limits
503 Service Unavailable
The service is temporary unavailable. Try again later
API Limits & Keys
API Limits
Limits are defined by the total requests in the last 24 hours for the user associated with the API Key
Default API Limit
500 in last 24 hours
is the default API rate limit number over the last 24 hour period. If you would like to request a higher API Rate Limit, please contact us
API Keys
Keys are generated in the settings area of your IdleSteam.com Control Panel.
User Information
Retrieve data for a IdleSteam.com User
GET /v1/user/:username
URL Parameters
:username required string Your IdleSteam.com login username
GET Parameters
api_key required string Your API Key generated in your Settings page
Code Examples
- CURL
- PHP (CURL)
- PHP
- RUBY
- PYTHON
- NODE
curl --request GET \
--url 'https://api.idlesteam.com/v1/user/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754'
<?php
$method = '/user/';
$value = 'demo_user';
$api_key = '82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754';
// BEGIN API Request code
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.idlesteam.com/v1' . $method . $value . '?api_key=' . $api_key);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$json = curl_exec($ch);
curl_close ($ch);
$data = json_decode($json);
// END API Request code
echo '<pre>' . print_r( $data , true ) . '</pre>';
<?php
$method = '/user/';
$value = 'demo_user';
$api_key = '82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754';
$url = 'https://api.idlesteam.com/v1' . $method . $value . '?api_key=' . $api_key;
$data = file_get_contents($url);
if ($data !== false) {
$data = json_decode($data);
echo '<pre>' . print_r( $data , true ) . '</pre>';
} else {
echo 'Failed, for more information visit the requested url in your browser: ' . htmlentities($url);
}
require 'net/http'
require 'json'
uri = URI.parse('https://api.idlesteam.com/v1/user/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri.request_uri)
response = http.request(request)
data = JSON[response.body]
puts data
import json
import requests
url = 'https://api.idlesteam.com/v1/user/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754'
response = requests.request('GET', url)
data = json.loads(response.text);
print( data )
const https = require('https');
https.get('https://api.idlesteam.com/v1/user/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754', (resp) => {
let data = '';
resp.on('data', (chunk) => {
data += chunk;
});
resp.on('end', () => {
console.log(data);
});
}).on('error', (err) => {
console.log('Error: ' + err.message);
});
Returned Field Data
userstring |
Your IdleSteam.com username you registered with | last_login_datestring |
The last time your account was logged in to |
upgradedbool |
Whether or not this user upgraded ever on their account | loading_games_messagebool |
Whether to show the 'loading stidler.com' message when starting games or on idle refreshes |
expire_datestring |
Date at which subscription will end or has ended | package_namestring |
The official display name for the package this user has |
steam_limitinteger |
Max amount of Steam accounts can be added to User Account | package_typestring |
Short name for package |
game_limitinteger |
Max amount of games that can be idled on each Steam Account | register_datestring |
Date at which this user registered |
Extended Field Data
steam_accounts.href string URL for returning added Steam account data
Successful Response
{
"meta" : {
"status_code" : 200,
"success" : true,
"message" : "",
"api_limit_usage" : 17,
"api_limit" : 500,
"total_results" : 1,
"href" : "https://api.idlesteam.com/v1/user/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754",
"docs_url" : "https://docs.idlesteam.com/"
},
"data" : {
"user" : "demo_user",
"upgraded" : true,
"expire_date" : "2019-04-25",
"steam_limit" : 7,
"game_limit" : 32,
"register_date" : "2016-04-12 11:25:11",
"last_login_date" : "2024-10-07 09:13:46",
"loading_games_message" : 1,
"package_name" : "Custom Package",
"package_type" : "custom",
"steam_accounts" : {
"href" : "https://api.idlesteam.com/v1/steamAccounts/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754"
}
}
}
Steam accounts and Idle Information
Retrieve Steam Accounts for a given IdleSteam.com User
GET /v1/steamAccounts/:username
URL Parameters
:username required string Your IdleSteam.com login username
GET Parameters
api_key required string Your API Key generated in your Settings page
Code Examples
- CURL
- PHP (CURL)
- PHP
- RUBY
- PYTHON
- NODE
curl --request GET \
--url 'https://api.idlesteam.com/v1/steamAccounts/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754'
<?php
$method = '/steamAccounts/';
$value = 'demo_user';
$api_key = '82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754';
// BEGIN API Request code
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.idlesteam.com/v1' . $method . $value . '?api_key=' . $api_key);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$json = curl_exec($ch);
curl_close ($ch);
$data = json_decode($json);
// END API Request code
echo '<pre>' . print_r( $data , true ) . '</pre>';
<?php
$method = '/steamAccounts/';
$value = 'demo_user';
$api_key = '82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754';
$url = 'https://api.idlesteam.com/v1' . $method . $value . '?api_key=' . $api_key;
$data = file_get_contents($url);
if ($data !== false) {
$data = json_decode($data);
echo '<pre>' . print_r( $data , true ) . '</pre>';
} else {
echo 'Failed, for more information visit the requested url in your browser: ' . htmlentities($url);
}
require 'net/http'
require 'json'
uri = URI.parse('https://api.idlesteam.com/v1/steamAccounts/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri.request_uri)
response = http.request(request)
data = JSON[response.body]
puts data
import json
import requests
url = 'https://api.idlesteam.com/v1/steamAccounts/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754'
response = requests.request('GET', url)
data = json.loads(response.text);
print( data )
const https = require('https');
https.get('https://api.idlesteam.com/v1/steamAccounts/demo_user?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754', (resp) => {
let data = '';
resp.on('data', (chunk) => {
data += chunk;
});
resp.on('end', () => {
console.log(data);
});
}).on('error', (err) => {
console.log('Error: ' + err.message);
});
Returned Field Data
idstring |
Your unique encrypted Steam ID | userstring |
The Steam login username |
steam_usernamestring |
The Steam display username | steam_small_avatarstring |
Steam URL of avatar image |
steam_countrystring |
The country the Steam account is set to | mobilebool |
Whether or not mobile auth is enabled on the account (Email Auth if set to false) |
game_idsarray |
List of saved idle game IDs | insert_datetimestring |
The datetime at which the Steam account was added to Control Panel |
steam_profile_idinteger |
The Steam 64 ID | autorestarterbool |
Whether or not AutoRestarter is enabled on this Steam Account |
notesstring |
Custom TEXT notes set on Steam Account | VOIDVOID |
This value has been disabled |
has_idledbool |
Whether this Steam account has idled successfully at least once | serverinteger |
Which server is being used?
|
is_onlinebool |
Whether or not this account is idling right now | appear_offlinebool |
Saved idle setting for appearing offline |
custom_game_enabledbool |
Saved idle setting for non-steam custom games | game_extra_infostring |
Saved idle setting for the non-steam custom game name |
away_message_enabledbool |
Saved idle setting for AutoResponder | away_messagestring |
The away message in full |
away_extensionstring |
The AutoResponder suffix | respond_typeinteger |
|
last_updatestring |
The last update from a running idle | accept_frstring |
Saved idle setting for AcceptFriendRequests feature |
save_chat_logsbool |
Saved idle setting for Chat Logs | hide_recent_activitybool |
Saved idle setting for Hiding Recent Activity |
accept_fr_minimum_levelint |
Minimum Steam level before accepting Friend Requests |
Extended Field Data
messages.href string URL for returning Steam Account Messages
friend_requests.href string URL for returning Steam Account Friend Requests
errors.href string URL for returning Steam Account Errors
Successful Response
{
"meta" : {
"status_code" : 200,
"success" : true,
"message" : "",
"api_limit_usage" : 18,
"api_limit" : 500,
"total_results" : 2,
"href" : "https://api.idlesteam.com/v1/demo_user/steamAccounts/?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754",
"docs_url" : "https://docs.idlesteam.com/"
},
"data" : [
{
"id" : "13f71bf7e41d1ca2d00f0bb3b169f126",
"user" : "demo_steam_user",
"steam_username" : "Demo IdleSteam.com Account",
"steam_small_avatar" : "http://cdn.edgecast.steamstatic.com/steamcommunity/public/images/avatars/88/88251592cb4973d6c89667bb1ae74a054fa948c3.jpg",
"steam_country" : "United Kingdom (Great Britain)",
"mobile" : true,
"game_ids" [ 361420, 312530, 286160, 271590, 263060, 252950, 252490, 245490, 220200, 220160, 219640, 105600, 72850, 45000, 234630, 449800, 63500, 48000, 22600, 12900, 12170, 8190, 4000, 3590, 3480, 620, 570, 400, 578080, 730, 251610, 34900 ],
"insert_datetime" : "2018-01-13 03:45:22",
"steam_profile_id" : 74561198029431138,
"autorestarter" : true,
"notes" : "",
"vac_banned" : false,
"has_idled" : true,
"server" : 4,
"is_online" : true,
"appear_offline" : false,
"custom_game_enabled" : false,
"game_extra_info" : "Testing stidler.com",
"away_message_enabled" : true,
"away_message" : "Sorry, I'm away right now. Leave your question and I'll respond when I'm back",
"away_extension" : " - stidler.com",
"respond_type" : 1,
"last_update" : "2024-10-07 04:04:25",
"accept_fr" : false,
"save_chat_logs" : true,
"hide_recent_activity" : false,
"accept_fr_minimum_level" : false,
"messages" : {
"href" : "https://api.idlesteam.com/v1/messages/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754"
},
"friend_requests" : {
"href" : "https://api.idlesteam.com/v1/friendRequests/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754"
},
"errors" : {
"href" : "https://api.idlesteam.com/v1/errors/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754"
}
},
{
"id" : "15v25cf1d41e2ea4e40f4bb3b341f117",
"user" : "another_steam_user",
"steam_username" : "Idling on Stidler.com",
"steam_small_avatar" : "http://cdn.edgecast.steamstatic.com/steamcommunity/public/images/avatars/88/88251592cb4973d6c89667bb1ae74a054fa948c3.jpg",
"steam_country" : "United States",
"mobile" : false,
"game_ids" [ 730 ],
"insert_datetime" : "2018-02-11 02:47:54",
"steam_profile_id" : 71561198029431134,
"autorestarter" : true,
"notes" : "",
"has_idled" : true,
"server" : 1,
"is_online" : true,
"appear_offline" : false,
"custom_game_enabled" : false,
"game_extra_info" : "Half Life 3",
"away_message_enabled" : true,
"away_message" : "Not here right now... sorry",
"away_extension" : " - stidler.com",
"respond_type" : 1,
"last_update" : "2024-10-07 04:04:25",
"accept_fr" : false,
"save_chat_logs" : true,
"hide_recent_activity" : false,
"accept_fr_minimum_level" : 0,
"messages" : {
"href" : "https://api.idlesteam.com/v1/messages/15v25cf1d41e2ea4e40f4bb3b341f117?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754"
},
"friend_requests" : {
"href" : "https://api.idlesteam.com/v1/friendRequests/15v25cf1d41e2ea4e40f4bb3b341f117?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754"
},
"errors" : {
"href" : "https://api.idlesteam.com/v1/errors/15v25cf1d41e2ea4e40f4bb3b341f117?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754"
}
}
]
}
Steam Account Messages
Retrieve messages for a Steam Account
GET /v1/messages/:steam_id
URL Parameters
:steam_id required string Your generated Steam ID from /steamAccounts/ method
GET Parameters
api_key required string Your API Key generated in your Settings page
Code Examples
- CURL
- PHP (CURL)
- PHP
- RUBY
- PYTHON
- NODE
curl --request GET \
--url 'https://api.idlesteam.com/v1/messages/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754'
<?php
$method = '/messages/';
$value = '13f71bf7e41d1ca2d00f0bb3b169f126';
$api_key = '82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754';
// BEGIN API Request code
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.idlesteam.com/v1' . $method . $value . '?api_key=' . $api_key);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$json = curl_exec($ch);
curl_close ($ch);
$data = json_decode($json);
// END API Request code
echo '<pre>' . print_r( $data , true ) . '</pre>';
<?php
$method = '/messages/';
$value = '13f71bf7e41d1ca2d00f0bb3b169f126';
$api_key = '82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754';
$url = 'https://api.idlesteam.com/v1' . $method . $value . '?api_key=' . $api_key;
$data = file_get_contents($url);
if ($data !== false) {
$data = json_decode($data);
echo '<pre>' . print_r( $data , true ) . '</pre>';
} else {
echo 'Failed, for more information visit the requested url in your browser: ' . htmlentities($url);
}
require 'net/http'
require 'json'
uri = URI.parse('https://api.idlesteam.com/v1/messages/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri.request_uri)
response = http.request(request)
data = JSON[response.body]
puts data
import json
import requests
url = 'https://api.idlesteam.com/v1/messages/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754'
response = requests.request('GET', url)
data = json.loads(response.text);
print( data )
const https = require('https');
https.get('https://api.idlesteam.com/v1/messages/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754', (resp) => {
let data = '';
resp.on('data', (chunk) => {
data += chunk;
});
resp.on('end', () => {
console.log(data);
});
}).on('error', (err) => {
console.log('Error: ' + err.message);
});
Returned Field Data
messagestring |
The message that was received from another Steam user while idling | steam_idinteger |
The Steam ID 64 unique identifier for the Steam account |
steam_usernamestring |
The Steam display username | away_message_enabledbool |
Whether or not AutoResponder is set to reply |
away_messagestring |
The AutoResponder custom message | respond_typeinteger |
|
appear_offlinebool |
Whether or not this idle is set to appear offline | steam_small_avatarstring |
The avatar for the user who messaged you |
vac_bannedbool |
Whether the user who has messaged you has ever been VAC banned | steam_countrystring |
The country set on the Steam account who messaged you |
steam_register_datestring |
The Steam registration date of the user who messaged you | insert_datetimestring |
When this user messaged you |
Successful Response
{
"meta" : {
"status_code" : 200,
"success" : true,
"message" : "",
"api_limit_usage" : 19,
"api_limit" : 500,
"total_results" : 3,
"href" : "https://api.idlesteam.com/v1/messages/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754",
"docs_url" : "https://docs.idlesteam.com/"
},
"data" : [
{
"message" : "Have a good day",
"steam_id" : 76561198029431138,
"steam_username" : "Ti Rone - stidler.com",
"away_message_enabled" : true,
"away_message" : "Sorry, I'm away right now. Leave your question and I'll respond when I'm back",
"respond_type" : 1,
"appear_offline" : false,
"steam_small_avatar" : "http://cdn.edgecast.steamstatic.com/steamcommunity/public/images/avatars/88/88251592cb4973d6c89667bb1ae74a054fa948c3.jpg",
"vac_banned" : false,
"steam_country" : "United Kingdom (Great Britain)",
"steam_register_date" : "2013-02-12",
"insert_datetime" : "2018-01-19 08:04:46"
},
{
"message" : "Are you okay?",
"steam_id" : 71561198029431137,
"steam_username" : "Food_Griend",
"away_message_enabled" : true,
"away_message" : "Sorry, I'm away right now. Leave your question and I'll respond when I'm back",
"respond_type" : 1,
"appear_offline" : false,
"steam_small_avatar" : "http://cdn.edgecast.steamstatic.com/steamcommunity/public/images/avatars/88/88251592cb4973d6c89667bb1ae74a054fa948c3.jpg",
"vac_banned" : true,
"steam_country" : "United States",
"steam_register_date" : "2016-01-14",
"insert_datetime" : "2018-01-19 08:00:05"
},
{
"message" : "Hey mate",
"steam_id" : 71561198029431137,
"steam_username" : "Food_Griend",
"away_message_enabled" : true,
"away_message" : "Sorry, I'm away right now. Leave your question and I'll respond when I'm back",
"respond_type" : 1,
"appear_offline" : false,
"steam_small_avatar" : "http://cdn.edgecast.steamstatic.com/steamcommunity/public/images/avatars/88/88251592cb4973d6c89667bb1ae74a054fa948c3.jpg",
"vac_banned" : true,
"steam_country" : "United States",
"steam_register_date" : "2016-01-14",
"insert_datetime" : "2018-01-19 07:59:58"
}
]
}
Steam Account Friend Requests
Retrieve friends requests for a Steam Account
GET /v1/friendRequests/:steam_id
URL Parameters
:steam_id required string Your generated Steam ID from /steamAccounts/ method
GET Parameters
api_key required string Your API Key generated in your Settings page
Code Examples
- CURL
- PHP (CURL)
- PHP
- RUBY
- PYTHON
- NODE
curl --request GET \
--url 'https://api.idlesteam.com/v1/friendRequests/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754'
<?php
$method = '/friendRequests/';
$value = '13f71bf7e41d1ca2d00f0bb3b169f126';
$api_key = '82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754';
// BEGIN API Request code
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.idlesteam.com/v1' . $method . $value . '?api_key=' . $api_key);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$json = curl_exec($ch);
curl_close ($ch);
$data = json_decode($json);
// END API Request code
echo '<pre>' . print_r( $data , true ) . '</pre>';
<?php
$method = '/friendRequests/';
$value = '13f71bf7e41d1ca2d00f0bb3b169f126';
$api_key = '82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754';
$url = 'https://api.idlesteam.com/v1' . $method . $value . '?api_key=' . $api_key;
$data = file_get_contents($url);
if ($data !== false) {
$data = json_decode($data);
echo '<pre>' . print_r( $data , true ) . '</pre>';
} else {
echo 'Failed, for more information visit the requested url in your browser: ' . htmlentities($url);
}
require 'net/http'
require 'json'
uri = URI.parse('https://api.idlesteam.com/v1/friendRequests/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri.request_uri)
response = http.request(request)
data = JSON[response.body]
puts data
import json
import requests
url = 'https://api.idlesteam.com/v1/friendRequests/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754'
response = requests.request('GET', url)
data = json.loads(response.text);
print( data )
const https = require('https');
https.get('https://api.idlesteam.com/v1/friendRequests/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754', (resp) => {
let data = '';
resp.on('data', (chunk) => {
data += chunk;
});
resp.on('end', () => {
console.log(data);
});
}).on('error', (err) => {
console.log('Error: ' + err.message);
});
Returned Field Data
sourceinteger |
The Steam ID 64 of the user who sent you a friend request | accept_friend_requestbool |
Is AutoAccept Friend Requests enabled? |
accept_friend_request_minimum_levelinteger |
The minimum Steam level to accept friend requests | acceptedbool |
Whether or not the friend request was automatically accepted |
steam_levelinteger |
The Steam level of the user who added you | steam_usernamestring |
The Steam Display Username of the user who added you |
steam_small_avatarstring |
The avatar URL of the user who added you | vac_bannedbool |
Whether or not the user who added you is VAC banned |
steam_countrystring |
The country set of the Steam user's profile who added you | steam_register_datestring |
The Steam registration date of the user who added you |
insert_datetimestring |
The date when this user added you |
Successful Response
{
"meta" : {
"status_code" : 200,
"success" : true,
"message" : "",
"api_limit_usage" : 20,
"api_limit" : 500,
"total_results" : 2,
"href" : "https://api.idlesteam.com/v1/friendRequests/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754",
"docs_url" : "https://docs.idlesteam.com/"
},
"data" : [
{
"source" : 71561198029431137,
"accept_friend_request" : true,
"accept_friend_request_minimum_level" : 150,
"accepted" : true,
"steam_level" : 250,
"steam_username" : "Idling while at work!",
"steam_small_avatar" : "http://cdn.edgecast.steamstatic.com/steamcommunity/public/images/avatars/88/88251592cb4973d6c89667bb1ae74a054fa948c3.jpg",
"vac_banned" : false,
"steam_country" : "United States",
"steam_register_date" : "2014-06-04",
"insert_datetime" : "24-10-07 08:14:36"
},
{
"source" : 71561198029431137,
"accept_friend_request" : true,
"accept_friend_request_minimum_level" : 150,
"accepted" : false,
"steam_level" : 102,
"steam_username" : "Stidler is great",
"steam_small_avatar" : "http://cdn.edgecast.steamstatic.com/steamcommunity/public/images/avatars/88/88251592cb4973d6c89667bb1ae74a054fa948c3.jpg",
"vac_banned" : false,
"steam_country" : "Jelenia Gora, Poland",
"steam_register_date" : "2012-01-14",
"insert_datetime" : "24-10-07 06:43:15"
}
]
}
Steam Account Errors
Retrieve idle errors for a Steam Account
GET /v1/errors/:steam_id
URL Parameters
:steam_id required string Your generated Steam ID from /steamAccounts/ method
GET Parameters
api_key required string Your API Key generated in your Settings page
Code Examples
- CURL
- PHP (CURL)
- PHP
- RUBY
- PYTHON
- NODE
curl --request GET \
--url 'https://api.idlesteam.com/v1/errors/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754'
<?php
$method = '/errors/';
$value = '13f71bf7e41d1ca2d00f0bb3b169f126';
$api_key = '82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754';
// BEGIN API Request code
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.idlesteam.com/v1' . $method . $value . '?api_key=' . $api_key);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$json = curl_exec($ch);
curl_close ($ch);
$data = json_decode($json);
// END API Request code
echo '<pre>' . print_r( $data , true ) . '</pre>';
<?php
$method = '/errors/';
$value = '13f71bf7e41d1ca2d00f0bb3b169f126';
$api_key = '82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754';
$url = 'https://api.idlesteam.com/v1' . $method . $value . '?api_key=' . $api_key;
$data = file_get_contents($url);
if ($data !== false) {
$data = json_decode($data);
echo '<pre>' . print_r( $data , true ) . '</pre>';
} else {
echo 'Failed, for more information visit the requested url in your browser: ' . htmlentities($url);
}
require 'net/http'
require 'json'
uri = URI.parse('https://api.idlesteam.com/v1/errors/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri.request_uri)
response = http.request(request)
data = JSON[response.body]
puts data
import json
import requests
url = 'https://api.idlesteam.com/v1/errors/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754'
response = requests.request('GET', url)
data = json.loads(response.text);
print( data )
const https = require('https');
https.get('https://api.idlesteam.com/v1/errors/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754', (resp) => {
let data = '';
resp.on('data', (chunk) => {
data += chunk;
});
resp.on('end', () => {
console.log(data);
});
}).on('error', (err) => {
console.log('Error: ' + err.message);
});
Returned Field Data
error_numberinteger |
The Steam Error number | error_number_extendedinteger |
The Steam extended Error number (Usually the same as error_number) |
sourceinteger |
The Steam ID of the user who received the error | insert_datetimestring |
When the error was received |
error_titlestring |
The error title that shows in your Control Panel | error_descriptionstring |
The error description that shows in your Control Panel |
Successful Response
{
"meta" : {
"status_code" : 200,
"success" : true,
"message" : "",
"api_limit_usage" : 21,
"api_limit" : 500,
"total_results" : 3,
"href" : "https://api.idlesteam.com/v1/errors/13f71bf7e41d1ca2d00f0bb3b169f126?api_key=82f3e92-587ab42-9bdfb7c-42d1c92-1e3f754",
"docs_url" : "https://docs.idlesteam.com/"
},
"data" : [
{
"error_number" : 6,
"error_number_extended" : 6,
"source" : 76561198029431138,
"insert_datetime" : "2018-01-18 12:49:45",
"error_title" : "Logged in elsewhere",
"error_description" : "Steam service is temporarily unavailable due to a Steam update"
},
{
"error_number" : 6,
"error_number_extended" : 6,
"source" : 76561198029431138,
"insert_datetime" : "2018-01-17 11:23:20",
"error_title" : "Logged in elsewhere",
"error_description" : "Your idle was interrupted"
},
{
"error_number" : 20,
"error_number_extended" : 20,
"source" : 76561198029431138,
"insert_datetime" : "2018-01-10 09:19:32",
"error_title" : "Service Unavailable",
"error_description" : "Steam service is temporarily unavailable due to a Steam update"
}
]
}