Endpoints

Endpoints

Search

Can be used to search for users or tribes by Character name, Steam name or tribe name.

Endpoint: /Search?type=[Player|Tribe]&q=[String]

Parameter type: The search type can be set to player or tribe.

Parameter q: The string to search for.

Request example

Request

GET /Search?type=tribe&q=a
Authorization: Bearer b156070548054806a3c8095eb83a8ddbb9f0b725bc9b42548b76b4fd448c7f8a

Response Headers

Content-Length: 73 
Content-Type: application/json 
Server: Microsoft-HTTPAPI/2.0

Response Data

[
    {
        "Id": 1866265798,
        "Name": "Clan MacKenzie",
        "Owner": 305600117,
        "Members": 4
    }
]

Player

Used to get a full player profile by the player's id.

Endpoint: /Player/[long]

Parameter id: The user's profile id.

Request example

Request

GET /Player?id=305600117
Authorization: Bearer b156070548054806a3c8095eb83a8ddbb9f0b725bc9b42548b76b4fd448c7f8a

Response Headers

Content-Length: 537 
Content-Type: application/json 
Server: Microsoft-HTTPAPI/2.0

Response Data

{
    SteamId: "76561198001085316"
    Created: "2015-07-17T19:01:22+02:00"
    Tribe: {
        Id: 1866265798
        Name: "Clan MacKenzie"
        Owner: 305600117
        Members: 4
    }
    ProfileUrl: "http://steamcommunity.com/id/fean/"
    CommunityBanned: false
    VACBanned: false
    NumberOfVACBans: 0
    DaysSinceLastBan: 0
    NumberOfGameBans: 0
    Id: 305600117
    CharacterName: "Cpt. Awesome"
    SteamName: "Cpt. Awesome ™"
    AvatarUrl: "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/5a/5a5c2367b832b1917ca0e6d76d547ec67bebf632.jpg"
    Level: 60
    Online: false
}

Tribe

Used to get the full tribe information for a tribe by it's id.

Endpoint: /Tribe/[int]

Parameter id: Used to get the full tribe profile.

Request example

Request

GET /Tribe?id=1866265798
Authorization: Bearer b156070548054806a3c8095eb83a8ddbb9f0b725bc9b42548b76b4fd448c7f8a

Response Headers

Content-Length: 1263 
Content-Type: application/json 
Server: Microsoft-HTTPAPI/2.0

Response Data

{
     Owner: {
          Id: 305600117
          CharacterName: "Cpt. Awesome"
          SteamName: "Cpt. Awesome ™"
          AvatarUrl: "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/5a/5a5c2367b832b1917ca0e6d76d547ec67bebf632.jpg"
          Level: 60
          Online: false
    }
    Members: [
        {
             Id: 685837688
             CharacterName: "Joegasaki Kenji"
             SteamName: "Rambojesse"
             AvatarUrl: "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/36/36bc2adbe97d746f0c6c883c3eabfbb94beed79d.jpg"
             Level: 22
             Online: false
       },
       {
            Id: 305600117
            CharacterName: "Cpt. Awesome"
            SteamName: "Cpt. Awesome ™"
            AvatarUrl: "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/5a/5a5c2367b832b1917ca0e6d76d547ec67bebf632.jpg"
            Level: 60
            Online: false
      },
      {
           Id: 349808165
           CharacterName: "Robbyp"
           SteamName: "thefirekiller"
           AvatarUrl: "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/fe/fef49e7fa7e1997310d705b2a6158ff8dc1cdfeb.jpg"
           Level: 34
           Online: false
      },
      {
          Id: 200261748
          CharacterName: "richard"
          SteamName: "richard_van_diepen"
          AvatarUrl: "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/fe/fef49e7fa7e1997310d705b2a6158ff8dc1cdfeb.jpg"
          Level: 1
          Online: false
      }]
      Created: "2015-07-17T19:01:22+02:00"
      Id: 1866265798
      Name: "Clan MacKenzie"
}

Online Players

Get all simple profiles for the players that are online.

Endpoint: /Online

Request example

Request

GET /Online
Authorization: Bearer b156070548054806a3c8095eb83a8ddbb9f0b725bc9b42548b76b4fd448c7f8a

Response Headers

Content-Length: 128 
Content-Type: application/json 
Server: Microsoft-HTTPAPI/2.0

Response Data

[
    {
        Id: 349808165
        CharacterName: "Robbyp"
        SteamName: "thefirekiller"
        AvatarUrl: "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/fe/fef49e7fa7e1997310d705b2a6158ff8dc1cdfeb.jpg"
        Level: 34
        Online: true
    }
]