v4

latestOpenAPI 3.1.02026-07-3196251302.5 KB

account

Find up to N shortest friend paths between two accounts

post/v1/account.findFriendPath

Request body

$schemastring uri

A URL to the JSON Schema for this object.

maxPathsinteger

Max number of paths to return (default 10, capped at 50). A direct friendship always returns a single path regardless of this value.

Example request

{
  "$schema": "https://api.steamsets.com/schemas/V1AccountFindFriendPathRequestBody.json",
  "exclude": [
    {
      "$schema": "https://api.steamsets.com/schemas/AccountSearch.json"
    }
  ],
  "from": {
    "$schema": "https://api.steamsets.com/schemas/AccountSearch.json"
  },
  "to": {
    "$schema": "https://api.steamsets.com/schemas/AccountSearch.json"
  }
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

foundboolean required

Whether any path was found

Example response

{
  "$schema": "https://api.steamsets.com/schemas/V1AccountFindFriendPathResponseBody.json",
  "paths": [
    {
      "path": [
        {
          "appCost": 123456,
          "apps": 123456,
          "avatar": "f1a1d2c3d0c9d1e1f2f3f4f5f6f7f8f9",
          "awardsGiven": 123456,
          "awardsReceived": 123456,
          "badges": 123456,
          "city": {
            "name": "Bad Krozingen"
          },
          "country": {
            "code": "DE",
            "name": "Germany"
          },
          "createdAt": "2023-01-01T00:00:00Z",
          "donated": 123456,
          "economyBan": "steam",
          "foilBadgeCost": 123456,
          "foilBadges": 123456,
          "friends": 123456,
          "level": 123456,
          "name": "steamsets",
          "normalBadgeCost": 123456,
          "normalBadges": 123456,
          "playtime": 123456,
          "pointsGiven": 123456,
          "pointsReceived": 123456,
          "privacy": "public",
          "region": {
            "name": "Europe"
          },
          "state": {
            "name": "Baden-Wurttemberg"
          },
          "steamId": "76561198842603734",
          "steamSetsVanity": "steamsets",
          "steamVanity": "steamsets",
          "xp": 123456
        }
      ]
    }
  ]
}