IFamilyGroupsService – Steam Web API Documentation

UNDOCUMENTEDPOST

CancelFamilyGroupInvite

Cancel a pending invite to the specified family group

https://api.steampowered.com/IFamilyGroupsService/CancelFamilyGroupInvite/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
steamid_to_cancel		fixed64	No

UNDOCUMENTEDPOST

ClearCooldownSkip

https://api.steampowered.com/IFamilyGroupsService/ClearCooldownSkip/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		fixed64	No
invite_id		uint64	No

UNDOCUMENTEDPOST

ConfirmInviteToFamilyGroup

https://api.steampowered.com/IFamilyGroupsService/ConfirmInviteToFamilyGroup/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
invite_id		uint64	No
nonce		uint64	No

UNDOCUMENTEDPOST

ConfirmJoinFamilyGroup

https://api.steampowered.com/IFamilyGroupsService/ConfirmJoinFamilyGroup/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
invite_id		uint64	No
nonce		uint64	No

UNDOCUMENTEDPOST

CreateFamilyGroup

Creates a new family group

https://api.steampowered.com/IFamilyGroupsService/CreateFamilyGroup/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
name		string	No
steamid		fixed64	No	(Support only) User to create this family group for and add to the group.

UNDOCUMENTEDPOST

DeleteFamilyGroup

Delete the specified family group

https://api.steampowered.com/IFamilyGroupsService/DeleteFamilyGroup/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No

UNDOCUMENTEDPOST

ForceAcceptInvite

https://api.steampowered.com/IFamilyGroupsService/ForceAcceptInvite/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
steamid		fixed64	No

UNDOCUMENTEDPOST

GetChangeLog

Return a log of changes made to this family group

https://api.steampowered.com/IFamilyGroupsService/GetChangeLog/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No

UNDOCUMENTED

GetFamilyGroup

Retrieves family group info

https://api.steampowered.com/IFamilyGroupsService/GetFamilyGroup/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
send_running_apps		bool	No

UNDOCUMENTED

GetFamilyGroupForUser

Gets the family group id for the authenticated user or a user specified by a support account

https://api.steampowered.com/IFamilyGroupsService/GetFamilyGroupForUser/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		uint64	No	Actually optional. This should only be set when support or admin accounts needs to fetch the family group for another user. Outside of the support tool it should be omitted.
include_family_group_response		bool	No

UNDOCUMENTED

GetInviteCheckResults

https://api.steampowered.com/IFamilyGroupsService/GetInviteCheckResults/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
steamid		fixed64	No

UNDOCUMENTEDPOST

GetPlaytimeSummary

Get the playtimes in all apps from the shared library for the whole family group.

https://api.steampowered.com/IFamilyGroupsService/GetPlaytimeSummary/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		fixed64	No

UNDOCUMENTED

GetPreferredLenders

https://api.steampowered.com/IFamilyGroupsService/GetPreferredLenders/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No

UNDOCUMENTED

GetPurchaseRequests

Get pending purchase requests for the family

https://api.steampowered.com/IFamilyGroupsService/GetPurchaseRequests/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
include_completed		bool	No
request_ids[0]		uint64[]	No
rt_include_completed_since		uint32	No

UNDOCUMENTED

GetSharedLibraryApps

Return a list of apps available from other members

https://api.steampowered.com/IFamilyGroupsService/GetSharedLibraryApps/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		fixed64	No
include_own		bool	No
include_excluded		bool	No
include_free		bool	No
language		string	No
max_apps		uint32	No
include_non_games		bool	No
steamid		fixed64	No

UNDOCUMENTED

GetUsersSharingDevice

Get lenders or borrowers sharing device with

https://api.steampowered.com/IFamilyGroupsService/GetUsersSharingDevice/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
client_session_id		int32	No
client_instance_id		uint64	No

UNDOCUMENTEDPOST

InviteToFamilyGroup

Invites an account to a family group

https://api.steampowered.com/IFamilyGroupsService/InviteToFamilyGroup/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
receiver_steamid		fixed64	No
receiver_role		int32	No	enum

UNDOCUMENTEDPOST

JoinFamilyGroup

Join the specified family group

https://api.steampowered.com/IFamilyGroupsService/JoinFamilyGroup/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
nonce		uint64	No

UNDOCUMENTEDPOST

ModifyFamilyGroupDetails

Modify the details of the specified family group

https://api.steampowered.com/IFamilyGroupsService/ModifyFamilyGroupDetails/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
name		string	No	If present, set the family name to the current value

UNDOCUMENTEDPOST

RemoveFromFamilyGroup

Remove the specified account from the specified family group

https://api.steampowered.com/IFamilyGroupsService/RemoveFromFamilyGroup/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
steamid_to_remove		fixed64	No

UNDOCUMENTEDPOST

RequestPurchase

Request purchase of the specified cart

https://api.steampowered.com/IFamilyGroupsService/RequestPurchase/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No	Requester's family group id'
gidshoppingcart		uint64	No	The shopping cart with items to purchase.
store_country_code		string	No	The store country code of the requestor.
use_account_cart		bool	No	Request the contents of the account cart instead of gidshoppingcart?

UNDOCUMENTEDPOST

ResendInvitationToFamilyGroup

https://api.steampowered.com/IFamilyGroupsService/ResendInvitationToFamilyGroup/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
steamid		uint64	No

UNDOCUMENTEDPOST

RespondToRequestedPurchase

Act on a purchase request

https://api.steampowered.com/IFamilyGroupsService/RespondToRequestedPurchase/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No	Purchase requester's family group id'
purchase_requester_steamid		fixed64	No	Purchase requester's steam id'
action		int32	No	Action being taken
request_id		uint64	No	Unique purchase request ID

UNDOCUMENTEDPOST

RollbackFamilyGroup

https://api.steampowered.com/IFamilyGroupsService/RollbackFamilyGroup/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
rtime32_target		uint32	No

UNDOCUMENTEDPOST

SetFamilyCooldownOverrides

Set the number of times a family group's cooldown time should be ignored for joins.

https://api.steampowered.com/IFamilyGroupsService/SetFamilyCooldownOverrides/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No	The family group to set the cooldown overrides on
cooldown_count		uint32	No	How many cooldown overrides this family group should have

UNDOCUMENTEDPOST

SetPreferredLender

https://api.steampowered.com/IFamilyGroupsService/SetPreferredLender/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No
appid		uint32	No
lender_steamid		fixed64	No

UNDOCUMENTEDPOST

UndeleteFamilyGroup

https://api.steampowered.com/IFamilyGroupsService/UndeleteFamilyGroup/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
family_groupid		uint64	No