OpenXBL | An Xbox Live API

Get started for free! Sign up here

Instantly get access with 500 requests per hour. Options are available to increase this limit.

GET /account basic profile information

basic profile information

Response
PHP


{
	"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');

GET /account/{xuid} another's profile information

another's profile information

Response
PHP


{
	"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');

GET /friends get friends list

get friends list

Response
PHP


{
	"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');

GET /friends?xuid={xuid} get anthor's friends list

get another's friends list

Response
PHP


{
	"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}');

GET /friends/search?gt=OpenXBL Search for gamertag

Returns gamertag results, if any. gt parameter required.

Response
PHP


{
	"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');

GET /friends/add/{xuid} Add a friend

This will add a friend to your list.

Response
PHP


200 OK

use \OpenXBL\Api;

$xbox = new Api('API_KEY');

print $xbox->get('friends/add/2535473200000000');

GET /friends/remove/{xuid} Remove a friend

Will remove a friend from your friends list

Response
PHP


200 OK

use \OpenXBL\Api;

$xbox = new Api('API_KEY');

print $xbox->get('friends/remove/2535473200000000');

POST /friends/favorite Add a friend as favorite

This will add a friend to your list and mark them as favorite.
Payload: {"xuids":[2535473210914202]}

Response
PHP


200 OK

use \OpenXBL\Api;

$xbox = new Api('API_KEY');

print $xbox->post('friends/favorite', array('xuids' => array('2535473210914202')));

POST /friends/favorite/remove Remove friend from favorites

This will remove their favorite status and keep them as friends.
Payload: {"xuids":[2535473210914202]}

Response
PHP


200 OK

use \OpenXBL\Api;

$xbox = new Api('API_KEY');

print $xbox->post('friends/favorite/remove', array('xuids' => array('2535473210914202')));

GET /recent-players Gets recent players for this account

Lists all recent players.

Response
PHP


{
"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');

GET /presence get friend's presence

get friend's presence

GET /{xuid}/presence get multiple friend's presence

get multiple friend's presence
For example: /api/v2/1234567,8762567,9027469827/presence

GET /conversations/requests get message requests

get message requests

GET /conversations get conversations

get conversations

GET /conversations/{xuid} get a conversation

get a conversation

POST /conversations send a message to a single person

send a conversation
Payload: {"xuid": "2533274798000000","message": "This is an example payload."}

GET /group Get all group conversations.

Get all group conversations

GET /group/summary/{group id} Get a group chat summary.

gets a group chat summary

GET /group/messages/{group id} Get a group chats messages.

Get a group chats messages

POST /group/create Create a new message group.

Create a new message group.
Payload: {"participants":["2535428038000000","2533274802000000"]}

POST /generate/gamertag generate a random gamertag

generate a random gamertag
Payload: {"Algorithm":1,"Count":3,"Locale":"en-US","Seed":""}

POST /clubs/recommendations Club Recommendations

Return a list of clubs this user would be interested in joining.

GET /clubs/owned Clubs Owned (by this user)

return a list of clubs this user owns and manages.

POST /clubs/create Create a Club

Create a new club.

Payload: {"name":"Hello World", "type":"[public/private/hidden]"}

GET /clubs/find?q=my search query Find Clubs

Return a list of clubs matching a search query.

q= URL parameter must not be empty.

POST /clubs/reserve Check if Club Name is Available

Check to see if your name is available prior to sending a Create Club request.

Payload: {"name":"Hello World"}

GET /activity/feed Get Activity Feed

Return your activity feed.

POST /activity/feed Post to Activity Feed

Post a message to your activity feed.

GET /activity/history Get Activity History

Return your activity feed history.

GET /alerts Get Notifications/Alerts

Return your notifications / alerts. Does not set to 'viewed/seen' status on-request.

GET /player/summary Get Player Summary

Returns basic stats about the player. Basic multiplayer stats as well.

GET /dvr/gameclips Get Player Game Clips

Returns player game clip metadata

GET /dvr/screenshots Get Player Screenshots

Returns player screenshots metadata

GET /achievements Get Player Achievements List

Returns player achievements list

POST /achievements/stats/{titleId} Get user stats for a particular title

Get user stats for a particular title

GET /achievements/title/{titleId} Get Specific Game Achievements

returns 150 items at a time. To page more data run /achievements/title/{titleId}/{continuationToken}

GET /achievements/{titleId} Get Game Achievements history

returns game achievements history. If unsure of TitleId call /achievements first.

More games? use a comma like this: /achievements/100000,200000,300000

GET /party Returns session directory information

array of sessions the user is currently part of. I.e party chat rooms and their session config. values, summary of users in party.

Not finding what you're looking for?

Submit feedback to help make OpenXBL a better place for Xbox Developers!

GET /account basic profile information

GET /account/{xuid} another's profile information

GET /friends get friends list

GET /friends?xuid={xuid} get anthor's friends list

GET /friends/search?gt=OpenXBL Search for gamertag

GET /friends/add/{xuid} Add a friend

GET /friends/remove/{xuid} Remove a friend

POST /friends/favorite Add a friend as favorite

POST /friends/favorite/remove Remove friend from favorites

GET /recent-players Gets recent players for this account

GET /presence get friend's presence

GET /{xuid}/presence get multiple friend's presence

GET /conversations/requests get message requests

GET /conversations get conversations

GET /conversations/{xuid} get a conversation

POST /conversations send a message to a single person

GET /group Get all group conversations.

GET /group/summary/{group id} Get a group chat summary.

GET /group/messages/{group id} Get a group chats messages.

POST /group/create Create a new message group.

POST /generate/gamertag generate a random gamertag

POST /clubs/recommendations Club Recommendations

GET /clubs/owned Clubs Owned (by this user)

POST /clubs/create Create a Club

GET /clubs/find?q=my search query Find Clubs

POST /clubs/reserve Check if Club Name is Available

GET /activity/feed Get Activity Feed

POST /activity/feed Post to Activity Feed

GET /activity/history Get Activity History

GET /alerts Get Notifications/Alerts

GET /player/summary Get Player Summary

GET /dvr/gameclips Get Player Game Clips

GET /dvr/screenshots Get Player Screenshots

GET /achievements Get Player Achievements List

POST /achievements/stats/{titleId} Get user stats for a particular title

GET /achievements/title/{titleId} Get Specific Game Achievements

GET /achievements/{titleId} Get Game Achievements history

GET /party Returns session directory information

Learn

Contribute