Get started for free! Sign up here
Instantly get access with 500 requests per hour. Options are available to increase this limit.
{
"profileUsers": [
{
"id": "2533274700000000",
"hostId": "2533274700000000",
"settings": [
{
"id": "GameDisplayPicRaw",
"value": "http://images-eds.xboxlive.com/image?url=wHwbXKif8cus8csoZ03RW_ES.ojiJijNBGRVUbTnZKsoCCCkjlsEJrrMqDkYqs3MBhMLdvWFHLCswKMlApTSbzvES1cjEAVPrczatfOc0jR0Ss4zHEy6ErElLAY8rAVFRNqPmGHxiumHSE9tZRnlghsACzaoisWEww1VSUd9Sx0-&format=png"
},
{
"id": "Gamerscore",
"value": "18850"
},
{
"id": "Gamertag",
"value": "xTACTICSx"
},
{
"id": "AccountTier",
"value": "Gold"
},
{
"id": "XboxOneRep",
"value": "GoodPlayer"
},
{
"id": "PreferredColor",
"value": "http://dlassets.xboxlive.com/public/content/ppl/colors/00003.json"
},
{
"id": "RealName",
"value": "David Regimbal"
},
{
"id": "Bio",
"value": ""
},
{
"id": "Location",
"value": "United States"
}
],
"isSponsoredUser": false
}
]
}
use \OpenXBL\Api; $xbox = new Api('API_KEY'); print $xbox->get('account');
{
"profileUsers": [
{
"id": "2535413400000000",
"hostId": "2535413400000000",
"settings": [
{
"id": "GameDisplayPicRaw",
"value": "http://images-eds.xboxlive.com/image?url=wHwbXKif8cus8csoZ03RW_ES.ojiJijNBGRVUbTnZKsoCCCkjlsEJrrMqDkYqs3MBhMLdvWFHLCswKMlApTSbzvES1cjEAVPrczatfOc0jR0Ss4zHEy6ErElLAY8rAVFRNqPmGHxiumHSE9tZRnlghsACzaoisWEww1VSUd9Sx0-&format=png"
},
{
"id": "Gamerscore",
"value": "6855"
},
{
"id": "Gamertag",
"value": "OpenXBL"
},
{
"id": "AccountTier",
"value": "Gold"
},
{
"id": "XboxOneRep",
"value": "GoodPlayer"
},
{
"id": "PreferredColor",
"value": "http://dlassets.xboxlive.com/public/content/ppl/colors/00003.json"
},
{
"id": "RealName",
"value": "David Regimbal"
},
{
"id": "Bio",
"value": "Xbox Live API"
},
{
"id": "Location",
"value": "United States"
}
],
"isSponsoredUser": false
}
]
}
use \OpenXBL\Api; $xbox = new Api('API_KEY'); print $xbox->get('account/2535413400000000');
{
"people": [
{
"xuid": "2535413400000000",
"isFavorite": true,
"isFollowingCaller": true,
"isFollowedByCaller": true,
"isIdentityShared": true,
"addedDateTimeUtc": "2016-01-03T20:29:06.850124Z",
"displayName": "OpenXBL",
"realName": "David Regimbal",
"displayPicRaw": "http://images-eds.xboxlive.com/image?url=8Oaj9Ryq1G1_p3lLnXlsaZgGzAie6Mnu24_PawYuDYIoH77pJ.X5Z.MqQPibUVTcS9jr0n8i7LY1tL3U7Aiafawv0hvLVTadAYM74jo2GRWfV4isnhJzSvaPwT_5QUO5&format=png",
"useAvatar": false,
"gamertag": "OpenXBL",
"gamerScore": "6855",
"xboxOneRep": "GoodPlayer",
"presenceState": "Offline",
"presenceText": "Offline",
"presenceDevices": null,
"isBroadcasting": false,
"isCloaked": null,
"isQuarantined": false,
"suggestion": null,
"recommendation": null,
"titleHistory": null,
"multiplayerSummary": {
"InMultiplayerSession": 0,
"InParty": 0
},
"recentPlayer": null,
"follower": null,
"preferredColor": {
"primaryColor": "193e91",
"secondaryColor": "101836",
"tertiaryColor": "102c69"
},
"presenceDetails": null,
"titlePresence": null,
"titleSummaries": null,
"presenceTitleIds": null,
"detail": null,
"communityManagerTitles": null,
"socialManager": {
"titleIds": [],
"pages": []
},
"broadcast": [],
"tournamentSummary": null,
"avatar": null
},
],
"recommendationSummary": null,
"friendFinderState": null
}
use \OpenXBL\Api; $xbox = new Api('API_KEY'); print $xbox->get('friends');
{
"people": [
{
"xuid": "2535413400000000",
"isFavorite": true,
"isFollowingCaller": true,
"isFollowedByCaller": true,
"isIdentityShared": true,
"addedDateTimeUtc": "2016-01-03T20:29:06.850124Z",
"displayName": "OpenXBL",
"realName": "David Regimbal",
"displayPicRaw": "http://images-eds.xboxlive.com/image?url=8Oaj9Ryq1G1_p3lLnXlsaZgGzAie6Mnu24_PawYuDYIoH77pJ.X5Z.MqQPibUVTcS9jr0n8i7LY1tL3U7Aiafawv0hvLVTadAYM74jo2GRWfV4isnhJzSvaPwT_5QUO5&format=png",
"useAvatar": false,
"gamertag": "OpenXBL",
"gamerScore": "6855",
"xboxOneRep": "GoodPlayer",
"presenceState": "Offline",
"presenceText": "Offline",
"presenceDevices": null,
"isBroadcasting": false,
"isCloaked": null,
"isQuarantined": false,
"suggestion": null,
"recommendation": null,
"titleHistory": null,
"multiplayerSummary": {
"InMultiplayerSession": 0,
"InParty": 0
},
"recentPlayer": null,
"follower": null,
"preferredColor": {
"primaryColor": "193e91",
"secondaryColor": "101836",
"tertiaryColor": "102c69"
},
"presenceDetails": null,
"titlePresence": null,
"titleSummaries": null,
"presenceTitleIds": null,
"detail": null,
"communityManagerTitles": null,
"socialManager": {
"titleIds": [],
"pages": []
},
"broadcast": [],
"tournamentSummary": null,
"avatar": null
},
],
"recommendationSummary": null,
"friendFinderState": null
}
use \OpenXBL\Api; $xbox = new Api('API_KEY'); print $xbox->get('friends?xuid={xuid}');
{
"profileUsers": [
{
"id": "2535473200000000",
"hostId": "2535473200000000",
"settings": [
{
"id": "GameDisplayPicRaw",
"value": "http://images-eds.xboxlive.com/image?url=8Oaj9Ryq1G1_p3lLnXlsaZgGzAie6Mnu24_PawYuDYIoH77pJ.X5Z.MqQPibUVTcS9jr0n8i7LY1tL3U7Aiafawv0hvLVTadAYM74jo2GRWfV4isnhJzSvaPwT_5QUO5&format=png"
},
{
"id": "Gamerscore",
"value": "0"
},
{
"id": "Gamertag",
"value": "OpenXBL"
},
{
"id": "AccountTier",
"value": "Silver"
},
{
"id": "XboxOneRep",
"value": "GoodPlayer"
},
{
"id": "PreferredColor",
"value": "http://dlassets.xboxlive.com/public/content/ppl/colors/00000.json"
},
{
"id": "RealName",
"value": ""
},
{
"id": "Bio",
"value": ""
},
{
"id": "TenureLevel",
"value": "0"
},
{
"id": "Watermarks",
"value": ""
},
{
"id": "Location",
"value": ""
},
{
"id": "ShowUserAsAvatar",
"value": "0"
}
],
"isSponsoredUser": false
}
]
}
use \OpenXBL\Api; $xbox = new Api('API_KEY'); print $xbox->get('friends/search?gt=OpenXBL');
200 OK
use \OpenXBL\Api; $xbox = new Api('API_KEY'); print $xbox->get('friends/add/2535473200000000');
200 OK
use \OpenXBL\Api; $xbox = new Api('API_KEY'); print $xbox->get('friends/remove/2535473200000000');
200 OK
use \OpenXBL\Api; $xbox = new Api('API_KEY'); print $xbox->post('friends/favorite', array('xuids' => array('2535473210914202')));
200 OK
use \OpenXBL\Api; $xbox = new Api('API_KEY'); print $xbox->post('friends/favorite/remove', array('xuids' => array('2535473210914202')));
{
"people": [
{
"xuid": "2533274828907431",
"isFavorite": false,
"isFollowingCaller": false,
"isFollowedByCaller": false,
"isIdentityShared": false,
"addedDateTimeUtc": null,
"displayName": "StonyLatino101",
"realName": "",
"displayPicRaw": "http://images-eds.xboxlive.com/image?url=8Oaj9Ryq1G1_p3lLnXlsaZgGzAie6Mnu24_PawYuDYIoH77pJ.X5Z.MqQPibUVTcS9jr0n8i7LY1tL3U7AiafR1uC9K9IBEincm3HQNvnsTj3od53NNvB4z1FSrAeTs.&format=png",
"showUserAsAvatar": "0",
"gamertag": "StonyLatino101",
"gamerScore": "91636",
"xboxOneRep": "GoodPlayer",
"presenceState": "Offline",
"presenceText": "Offline",
"presenceDevices": null,
"isBroadcasting": false,
"isCloaked": null,
"isQuarantined": false,
"suggestion": null,
"recommendation": null,
"titleHistory": null,
"multiplayerSummary": {
"InMultiplayerSession": 0,
"InParty": 0
},
"recentPlayer": {
"titles": [
{
"titleId": "1484511986",
"titleName": "Battlefield 4",
"lastPlayedWithDateTime": "2017-08-19T04:43:17.6293305Z"
}
],
"text": "Last met 1 year ago"
},
"follower": null,
"preferredColor": {
"primaryColor": "677488",
"secondaryColor": "222B38",
"tertiaryColor": "3e4b61"
},
"presenceDetails": null,
"titlePresence": null,
"titleSummaries": null,
"presenceTitleIds": null,
"detail": null,
"communityManagerTitles": null,
"socialManager": {
"titleIds": [],
"pages": [],
},
"broadcast": [],
"tournamentSummary": null,
"avatar": null
},
{
"xuid": "2533274884674512",
"isFavorite": false,
"isFollowingCaller": false,
"isFollowedByCaller": false,
"isIdentityShared": false,
"addedDateTimeUtc": null,
"displayName": "bugz6unny15",
"realName": "Qwenton Pippen",
"displayPicRaw": "http://images-eds.xboxlive.com/image?url=z951ykn43p4FqWbbFvR2Ec.8vbDhj8G2Xe7JngaTToBrrCmIEEXHC9UNrdJ6P7KIFXxmxGDtE9Vkd62rOpb7JQTCzxmbjUmjf26I9iWDnY.LUElEpm2wN7Xlmymxprvl&format=png",
"showUserAsAvatar": "1",
"gamertag": "bugz6unny15",
"gamerScore": "37665",
"xboxOneRep": "GoodPlayer",
"presenceState": "Online",
"presenceText": "TV",
"presenceDevices": null,
"isBroadcasting": false,
"isCloaked": null,
"isQuarantined": false,
"suggestion": null,
"recommendation": null,
"titleHistory": null,
"multiplayerSummary": {
"InMultiplayerSession": 0,
"InParty": 0
},
"recentPlayer": {
"titles": [
{
"titleId": "1484511986",
"titleName": "Battlefield 4",
"lastPlayedWithDateTime": "2017-08-19T04:43:17.6293305Z"
}
],
"text": "Last met 1 year ago"
},
"follower": null,
"preferredColor": {
"primaryColor": "e31123",
"secondaryColor": "471010",
"tertiaryColor": "851414"
},
"presenceDetails": null,
"titlePresence": null,
"titleSummaries": null,
"presenceTitleIds": null,
"detail": null,
"communityManagerTitles": null,
"socialManager": {
"titleIds": [],
"pages": [],
},
"broadcast": [],
"tournamentSummary": null,
"avatar": null
},
{
"xuid": "7036874425499677",
"isFavorite": false,
"isFollowingCaller": false,
"isFollowedByCaller": false,
"isIdentityShared": false,
"addedDateTimeUtc": null,
"displayName": "xTACTICSx(1)",
"realName": "",
"displayPicRaw": "http://images-eds.xboxlive.com/image?url=wHwbXKif8cus8csoZ03RW_ES.ojiJijNBGRVUbTnZKsoCCCkjlsEJrrMqDkYqs3MBhMLdvWFHLCswKMlApTSbzvES1cjEAVPrczatfOc0jR0Ss4zHEy6ErElLAY8rAVFRNqPmGHxiumHSE9tZRnlghsACzaoisWEww1VSUd9Sx0-&format=png",
"showUserAsAvatar": "0",
"gamertag": "xTACTICSx(1)",
"gamerScore": "19060",
"xboxOneRep": "GoodPlayer",
"presenceState": "Offline",
"presenceText": "Offline",
"presenceDevices": null,
"isBroadcasting": false,
"isCloaked": null,
"isQuarantined": false,
"suggestion": null,
"recommendation": null,
"titleHistory": null,
"multiplayerSummary": {
"InMultiplayerSession": 0,
"InParty": 0
},
"recentPlayer": {
"titles": [
{
"titleId": "345903534",
"titleName": "Minecraft: Xbox One Edition",
"lastPlayedWithDateTime": "2018-05-26T21:50:13.3625415Z"
}
],
"text": "Last met 37 weeks ago"
},
"follower": null,
"preferredColor": {
"primaryColor": "193e91",
"secondaryColor": "101836",
"tertiaryColor": "102c69"
},
"presenceDetails": null,
"titlePresence": null,
"titleSummaries": null,
"presenceTitleIds": null,
"detail": null,
"communityManagerTitles": null,
"socialManager": {
"titleIds": [],
"pages": [],
},
"broadcast": [],
"tournamentSummary": null,
"avatar": null
},
use \OpenXBL\Api; $xbox = new Api('API_KEY'); print $xbox->get('recent-players');
/achievements/title/{titleId}/{continuationToken}
/achievements
first./achievements/100000,200000,300000
/party
{"xuid": "000000", "sessionName": ""}
Not finding what you're looking for?
Submit feedback to help make OpenXBL a better place for developers!