Get-SteamFriendList
SYNOPSIS
Returns the friend list of any Steam user.
SYNTAX
Get-SteamFriendList [-SteamID64] <Int64> [[-Relationship] <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Returns the friend list of any Steam user, provided their Steam Community profile visibility is set to “Public”.
EXAMPLES
EXAMPLE 1
Get-SteamFriendList -SteamID64 76561197960435530
Outputs the user’s friends list, as an array of friends.
EXAMPLE 2
Get-SteamFriendList -SteamID64 76561197960435530 | ConvertFrom-Json
Outputs the user’s friends list, as an array of friends and converts it from Json to PSCustomObjects.
PARAMETERS
-ProgressAction
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Relationship
Relationship filter. Possibles values: all, friend.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SteamID64
64 bit Steam ID to return friend list for.
Type: Int64
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
System.Int64
OUTPUTS
PSCustomObject. It returns the following properties:
- SteamID64: The friend’s 64-bit Steam ID.
- Relationship: The qualifier of the relationship.
- FriendSince: The Unix timestamp indicating when the relationship was established.
NOTES
Author: Frederik Hjorslev Nylander