Tap Titans 2 API 1.0.0 documentation

Tap Titans 2 API 1.0.0

Documentation for Socket API. For more information about SocketIO, please visit the SocketIO website.
Click here to return on the main page.

Servers

tt2-public.gamehivegames.com/apiwssapi
Depending on your client language, the namespaces and the path are not defined in the same way. SocketIO is not a standard websocket library, you might required additional setting defined in channel bindings.
Security:
HTTP API key
Name: API-Authenticate
In: header

Operations

ON /raid
object
This data might be a bit different depending on which SocketIO client you're using. This example has been written using a Javascript SocketIO client. For more detail, please check with your SocketIO package documentation.

autoConnect
boolean
Advised to set it to false and manually connect during development.

Default value:true
reconnectionAttempts
integer
Advised to not set this to a high value if you don't want to be automatically banned due to the rate error rate limit (read the main page for more info on rate limit).

transports
required
array<string>
Const:["websocket"]
required
object
API-Authenticate
required
string
Your Application Token token must be used here.

Additional properties are NOT allowed.
Additional properties are NOT allowed.
Accepts one of the following messages:
- #0connected
  Event emitted when the connection has been established. No payload returned.
  
  Examples
- #1disconnect
  Event emitted when the client is disconnected by itself or by the server.
  
  Payload
  string
  Examples
  string
  
  This example has been generated automatically.
- #2error
  General error handler event.
  
  object
  message
  string
  Additional properties are NOT allowed.
  Examples
  { "message": "string" }
  
  This example has been generated automatically.
- #3connect_error
  Error handler event when something went wrong during connection. Do not auto-reconnect on this event and look properly at the error.
  
  object
  message
  string
  Additional properties are NOT allowed.
  Examples
  { "message": "string" }
  
  This example has been generated automatically.
- #4unsub_clan
  Event received when your application has been kicked out from a room. This can happen if a player token has been revoked.
  
  object
  clan_code
  string
  namespace
  string
  token
  string
  format: uuid
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "namespace": "string", "token": "b5507016-7da2-4777-a161-1e8042a6a377" }
  
  This example has been generated automatically.
- #5start_attack
  Start attack log. You receive this event for the clan you have registered to.
  
  object
  clan_code
  string
  raid_id
  integer
  object
  name
  string
  player_code
  string
  Additional properties are NOT allowed.
  array<string>
  Items:
  string
  uid: card_enum
  Allowed values:
  "MoonBeam"
  "Fragmentize"
  "SkullBash"
  "RazorWind"
  "WhipOfLightning"
  "BurstCount"
  "Purify"
  "LimbBurst"
  "FlakShot"
  "Haymaker"
  "ChainLightning"
  "MirrorForce"
  "CelestialStatic"
  "BurningAttack"
  "PoisonAttack"
  "DecayingAttack"
  "Fuse"
  "Shadow"
  "PlagueAttack"
  "Disease"
  "Swarm"
  "RuinousRust"
  "PowerBubble"
  "RuneAttack"
  "ExecutionersAxe"
  "CrushingVoid"
  "MentalFocus"
  "ImpactAttack"
  "InnerTruth"
  "FinisherAttack"
  "SuperheatMetal"
  "BurstBoost"
  "LimbSupport"
  "TotemFairySkill"
  "TeamTactics"
  "SpinalTap"
  started_at
  string
  format: date-time
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "raid_id": 0, "player": { "name": "string", "player_code": "string" }, "cards": [ "MoonBeam" ], "started_at": "2019-08-24T14:15:22Z" }
  
  This example has been generated automatically.
- #6attack
  Raid attack log. You receive this event for the clan you have registered to.
  
  object
  clan_code
  string
  raid_id
  integer
  cycle
  integer
  object
  name
  string
  player_code
  string
  raid_level
  integer
  attacks_remaining
  integer
  Additional properties are NOT allowed.
  object
  array<object>
  titan_index
  integer
  >= 0
  id
  string
  ID of the card, None for TapDamage
  
  array<object>
  id
  string
  uid: titan_part_enum
  Allowed values:
  "ArmorLegUpperRight"
  "ArmorHandLeft"
  "ArmorHandRight"
  "ArmorLegUpperLeft"
  "ArmorChestUpper"
  "ArmorArmUpperRight"
  "ArmorArmUpperLeft"
  "ArmorHead"
  "BodyLegUpperRight"
  "BodyHandLeft"
  "BodyHandRight"
  "BodyLegUpperLeft"
  "BodyChestUpper"
  "BodyArmUpperRight"
  "BodyArmUpperLeft"
  "BodyHead"
  "SkeletonLegUpperRight"
  "SkeletonHandLeft"
  "SkeletonHandRight"
  "SkeletonLegUpperLeft"
  "SkeletonChestUpper"
  "SkeletonArmUpperRight"
  "SkeletonArmUpperLeft"
  "SkeletonHead"
  value
  integer
  >= 0
  array<object>
  id
  string
  uid: card_enum
  Allowed values:
  "MoonBeam"
  "Fragmentize"
  "SkullBash"
  "RazorWind"
  "WhipOfLightning"
  "BurstCount"
  "Purify"
  "LimbBurst"
  "FlakShot"
  "Haymaker"
  "ChainLightning"
  "MirrorForce"
  "CelestialStatic"
  "BurningAttack"
  "PoisonAttack"
  "DecayingAttack"
  "Fuse"
  "Shadow"
  "PlagueAttack"
  "Disease"
  "Swarm"
  "RuinousRust"
  "PowerBubble"
  "RuneAttack"
  "ExecutionersAxe"
  "CrushingVoid"
  "MentalFocus"
  "ImpactAttack"
  "InnerTruth"
  "FinisherAttack"
  "SuperheatMetal"
  "BurstBoost"
  "LimbSupport"
  "TotemFairySkill"
  "TeamTactics"
  "SpinalTap"
  value
  integer
  >= 0
  attack_datetime
  string
  format: date-time
  Additional properties are NOT allowed.
  object
  titan_index
  integer
  >= 0
  object
  current_hp
  integer
  enemy_id
  string
  uid: enemy_id
  Allowed values:
  "Enemy1"
  "Enemy2"
  "Enemy3"
  "Enemy4"
  "Enemy5"
  "Enemy6"
  "Enemy7"
  "Enemy8"
  array<object>
  part_id
  string
  uid: titan_part_enum
  Allowed values:
  "ArmorLegUpperRight"
  "ArmorHandLeft"
  "ArmorHandRight"
  "ArmorLegUpperLeft"
  "ArmorChestUpper"
  "ArmorArmUpperRight"
  "ArmorArmUpperLeft"
  "ArmorHead"
  "BodyLegUpperRight"
  "BodyHandLeft"
  "BodyHandRight"
  "BodyLegUpperLeft"
  "BodyChestUpper"
  "BodyArmUpperRight"
  "BodyArmUpperLeft"
  "BodyHead"
  "SkeletonLegUpperRight"
  "SkeletonHandLeft"
  "SkeletonHandRight"
  "SkeletonLegUpperLeft"
  "SkeletonChestUpper"
  "SkeletonArmUpperRight"
  "SkeletonArmUpperLeft"
  "SkeletonHead"
  current_hp
  integer
  >= 0
  Additional properties are NOT allowed.
  Additional properties are NOT allowed.
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "raid_id": 0, "cycle": 0, "player": { "name": "string", "player_code": "string", "raid_level": 0, "attacks_remaining": 0 }, "attack_log": { "cards_damage": [ { "titan_index": 0, "id": "string", "damage_log": [ { "id": "ArmorLegUpperRight", "value": 0 } ] } ], "cards_level": [ { "id": "MoonBeam", "value": 0 } ], "attack_datetime": "2019-08-24T14:15:22Z" }, "raid_state": { "titan_index": 0, "current": { "current_hp": 0, "enemy_id": "Enemy1", "parts": [ { "part_id": "ArmorLegUpperRight", "current_hp": 0 } ] } } }
  
  This example has been generated automatically.
- #7start
  Start raid log. You receive this event for the clan you have registered to.
  
  object
  clan_code
  string
  raid_id
  integer
  object
  name
  string
  player_code
  string
  Additional properties are NOT allowed.
  keys_remaining
  integer
  [ 0 .. 2 ]
  object
  bonus_amount
  number
  format: float>= 0
  used
  integer
  >= 0
  Additional properties are NOT allowed.
  object
  level
  integer
  tier
  integer
  array<string>
  Items:
  string
  uid: enemy_name_enum
  Allowed values:
  "Lojak"
  "Takedar"
  "Jukk"
  "Sterl"
  "Mohaca"
  "Terro"
  "Klonk"
  "Priker"
  array<object>
  enemy_name
  string
  uid: enemy_name_enum
  Allowed values:
  "Lojak"
  "Takedar"
  "Jukk"
  "Sterl"
  "Mohaca"
  "Terro"
  "Klonk"
  "Priker"
  enemy_id
  string
  uid: enemy_id
  Allowed values:
  "Enemy1"
  "Enemy2"
  "Enemy3"
  "Enemy4"
  "Enemy5"
  "Enemy6"
  "Enemy7"
  "Enemy8"
  total_hp
  integer
  array<object>
  part_id
  string
  uid: titan_part_enum
  Allowed values:
  "ArmorLegUpperRight"
  "ArmorHandLeft"
  "ArmorHandRight"
  "ArmorLegUpperLeft"
  "ArmorChestUpper"
  "ArmorArmUpperRight"
  "ArmorArmUpperLeft"
  "ArmorHead"
  "BodyLegUpperRight"
  "BodyHandLeft"
  "BodyHandRight"
  "BodyLegUpperLeft"
  "BodyChestUpper"
  "BodyArmUpperRight"
  "BodyArmUpperLeft"
  "BodyHead"
  "SkeletonLegUpperRight"
  "SkeletonHandLeft"
  "SkeletonHandRight"
  "SkeletonLegUpperLeft"
  "SkeletonChestUpper"
  "SkeletonArmUpperRight"
  "SkeletonArmUpperLeft"
  "SkeletonHead"
  total_hp
  integer
  >= 0
  Additional properties are NOT allowed.
  start_at
  string
  format: date-time
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "raid_id": 0, "player": { "name": "string", "player_code": "string" }, "keys_remaining": 2, "morale": { "bonus_amount": 0.1, "used": 0 }, "raid": { "level": 0, "tier": 0, "spawn_sequence": [ "Lojak" ], "titans": [ { "enemy_name": "Lojak", "enemy_id": "Enemy1", "total_hp": 0, "parts": [ { "part_id": "ArmorLegUpperRight", "total_hp": 0 } ] } ] }, "start_at": "2019-08-24T14:15:22Z" }
  
  This example has been generated automatically.
- #8sub_start
  Start raid log. This event is sent when you subscribe to a new clan.
  
  object
  clan_code
  string
  raid_id
  integer
  keys_remaining
  integer
  [ 0 .. 2 ]
  object
  bonus_amount
  number
  format: float>= 0
  used
  integer
  >= 0
  Additional properties are NOT allowed.
  object
  level
  integer
  tier
  integer
  array<string>
  Items:
  string
  uid: enemy_name_enum
  Allowed values:
  "Lojak"
  "Takedar"
  "Jukk"
  "Sterl"
  "Mohaca"
  "Terro"
  "Klonk"
  "Priker"
  array<object>
  enemy_name
  string
  uid: enemy_name_enum
  Allowed values:
  "Lojak"
  "Takedar"
  "Jukk"
  "Sterl"
  "Mohaca"
  "Terro"
  "Klonk"
  "Priker"
  enemy_id
  string
  uid: enemy_id
  Allowed values:
  "Enemy1"
  "Enemy2"
  "Enemy3"
  "Enemy4"
  "Enemy5"
  "Enemy6"
  "Enemy7"
  "Enemy8"
  total_hp
  integer
  array<object>
  part_id
  string
  uid: titan_part_enum
  Allowed values:
  "ArmorLegUpperRight"
  "ArmorHandLeft"
  "ArmorHandRight"
  "ArmorLegUpperLeft"
  "ArmorChestUpper"
  "ArmorArmUpperRight"
  "ArmorArmUpperLeft"
  "ArmorHead"
  "BodyLegUpperRight"
  "BodyHandLeft"
  "BodyHandRight"
  "BodyLegUpperLeft"
  "BodyChestUpper"
  "BodyArmUpperRight"
  "BodyArmUpperLeft"
  "BodyHead"
  "SkeletonLegUpperRight"
  "SkeletonHandLeft"
  "SkeletonHandRight"
  "SkeletonLegUpperLeft"
  "SkeletonChestUpper"
  "SkeletonArmUpperRight"
  "SkeletonArmUpperLeft"
  "SkeletonHead"
  total_hp
  integer
  >= 0
  Additional properties are NOT allowed.
  array<object>
  enemy_id
  string
  uid: enemy_id
  Allowed values:
  "Enemy1"
  "Enemy2"
  "Enemy3"
  "Enemy4"
  "Enemy5"
  "Enemy6"
  "Enemy7"
  "Enemy8"
  array<object>
  id
  string
  uid: target_state_part
  Allowed values:
  "Head"
  "ChestUpper"
  "ArmUpperRight"
  "ArmUpperLeft"
  "LegUpperRight"
  "LegUpperLeft"
  "HandRight"
  "HandLeft"
  state
  string
  uid: target_state_enum
  0 = No target, 1 = Crossed, 2 = Checked.
  
  Allowed values:
  0
  1
  2
  start_at
  string
  format: date-time
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "raid_id": 0, "keys_remaining": 2, "morale": { "bonus_amount": 0.1, "used": 0 }, "raid": { "level": 0, "tier": 0, "spawn_sequence": [ "Lojak" ], "titans": [ { "enemy_name": "Lojak", "enemy_id": "Enemy1", "total_hp": 0, "parts": [ { "part_id": "ArmorLegUpperRight", "total_hp": 0 } ] } ] }, "titan_target": [ { "enemy_id": "Enemy1", "state": [ { "id": "Head", "state": 0 } ] } ], "start_at": "2019-08-24T14:15:22Z" }
  
  This example has been generated automatically.
- #9end
  End raid log. You receive this event for the clan you have registered to.
  
  object
  clan_code
  string
  raid_id
  integer
  ended_at
  string
  format: date-time
  keys_remaining
  integer
  [ 0 .. 2 ]
  array<object>
  player_code
  string
  name
  string
  num_attacks
  integer
  >= 0
  total_damage
  integer
  >= 0
  array<object>
  enemy_id
  string
  uid: enemy_id
  Allowed values:
  "Enemy1"
  "Enemy2"
  "Enemy3"
  "Enemy4"
  "Enemy5"
  "Enemy6"
  "Enemy7"
  "Enemy8"
  titan_index
  integer
  >= 0
  array<object>
  id
  string
  uid: titan_part_enum
  Allowed values:
  "ArmorLegUpperRight"
  "ArmorHandLeft"
  "ArmorHandRight"
  "ArmorLegUpperLeft"
  "ArmorChestUpper"
  "ArmorArmUpperRight"
  "ArmorArmUpperLeft"
  "ArmorHead"
  "BodyLegUpperRight"
  "BodyHandLeft"
  "BodyHandRight"
  "BodyLegUpperLeft"
  "BodyChestUpper"
  "BodyArmUpperRight"
  "BodyArmUpperLeft"
  "BodyHead"
  "SkeletonLegUpperRight"
  "SkeletonHandLeft"
  "SkeletonHandRight"
  "SkeletonLegUpperLeft"
  "SkeletonChestUpper"
  "SkeletonArmUpperRight"
  "SkeletonArmUpperLeft"
  "SkeletonHead"
  value
  integer
  >= 0
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "raid_id": 0, "ended_at": "2019-08-24T14:15:22Z", "keys_remaining": 2, "raid_summary": [ { "player_code": "string", "name": "string", "num_attacks": 0, "total_damage": 0, "log": [ { "enemy_id": "Enemy1", "titan_index": 0, "damage_log": [ { "id": "ArmorLegUpperRight", "value": 0 } ] } ] } ] }
  
  This example has been generated automatically.
- #10retire
  Retire raid log. You receive this event for the clan you have registered to.
  
  object
  clan_code
  string
  raid_id
  integer
  retired_at
  string
  format: date-time
  object
  name
  string
  player_code
  string
  Additional properties are NOT allowed.
  keys_remaining
  integer
  [ 0 .. 2 ]
  array<object>
  player_code
  string
  name
  string
  num_attacks
  integer
  >= 0
  total_damage
  integer
  >= 0
  array<object>
  enemy_id
  string
  uid: enemy_id
  Allowed values:
  "Enemy1"
  "Enemy2"
  "Enemy3"
  "Enemy4"
  "Enemy5"
  "Enemy6"
  "Enemy7"
  "Enemy8"
  titan_index
  integer
  >= 0
  array<object>
  id
  string
  uid: titan_part_enum
  Allowed values:
  "ArmorLegUpperRight"
  "ArmorHandLeft"
  "ArmorHandRight"
  "ArmorLegUpperLeft"
  "ArmorChestUpper"
  "ArmorArmUpperRight"
  "ArmorArmUpperLeft"
  "ArmorHead"
  "BodyLegUpperRight"
  "BodyHandLeft"
  "BodyHandRight"
  "BodyLegUpperLeft"
  "BodyChestUpper"
  "BodyArmUpperRight"
  "BodyArmUpperLeft"
  "BodyHead"
  "SkeletonLegUpperRight"
  "SkeletonHandLeft"
  "SkeletonHandRight"
  "SkeletonLegUpperLeft"
  "SkeletonChestUpper"
  "SkeletonArmUpperRight"
  "SkeletonArmUpperLeft"
  "SkeletonHead"
  value
  integer
  >= 0
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "raid_id": 0, "retired_at": "2019-08-24T14:15:22Z", "player": { "name": "string", "player_code": "string" }, "keys_remaining": 2, "raid_summary": [ { "player_code": "string", "name": "string", "num_attacks": 0, "total_damage": 0, "log": [ { "enemy_id": "Enemy1", "titan_index": 0, "damage_log": [ { "id": "ArmorLegUpperRight", "value": 0 } ] } ] } ] }
  
  This example has been generated automatically.
- #11cycle_reset
  Cycle reset log. You receive this event for the clan you have registered to.
  
  object
  clan_code
  string
  raid_id
  integer
  started_at
  string
  format: date-time
  raid_started_at
  string
  format: date-time
  next_reset_at
  string
  format: date-time
  object
  bonus_amount
  number
  format: float>= 0
  used
  integer
  >= 0
  Additional properties are NOT allowed.
  array<object>
  id
  string
  uid: card_bonuses_enum
  Allowed values:
  "TeamTacticsClanMoraleBoost"
  "MirrorForceBoost"
  value
  number
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "raid_id": 0, "started_at": "2019-08-24T14:15:22Z", "raid_started_at": "2019-08-24T14:15:22Z", "next_reset_at": "2019-08-24T14:15:22Z", "morale": { "bonus_amount": 0.1, "used": 0 }, "card_bonuses": [ { "id": "TeamTacticsClanMoraleBoost", "value": 0 } ] }
  
  This example has been generated automatically.
- #12sub_cycle
  Cycle reset log. This event is sent when you subscribe to a new clan.
  
  object
  clan_code
  string
  raid_id
  integer
  object
  bonus_amount
  number
  format: float>= 0
  used
  integer
  >= 0
  Additional properties are NOT allowed.
  object
  level
  integer
  tier
  integer
  array<string>
  Items:
  string
  uid: enemy_name_enum
  Allowed values:
  "Lojak"
  "Takedar"
  "Jukk"
  "Sterl"
  "Mohaca"
  "Terro"
  "Klonk"
  "Priker"
  array<object>
  enemy_name
  string
  uid: enemy_name_enum
  Allowed values:
  "Lojak"
  "Takedar"
  "Jukk"
  "Sterl"
  "Mohaca"
  "Terro"
  "Klonk"
  "Priker"
  enemy_id
  string
  uid: enemy_id
  Allowed values:
  "Enemy1"
  "Enemy2"
  "Enemy3"
  "Enemy4"
  "Enemy5"
  "Enemy6"
  "Enemy7"
  "Enemy8"
  total_hp
  integer
  array<object>
  part_id
  string
  uid: titan_part_enum
  Allowed values:
  "ArmorLegUpperRight"
  "ArmorHandLeft"
  "ArmorHandRight"
  "ArmorLegUpperLeft"
  "ArmorChestUpper"
  "ArmorArmUpperRight"
  "ArmorArmUpperLeft"
  "ArmorHead"
  "BodyLegUpperRight"
  "BodyHandLeft"
  "BodyHandRight"
  "BodyLegUpperLeft"
  "BodyChestUpper"
  "BodyArmUpperRight"
  "BodyArmUpperLeft"
  "BodyHead"
  "SkeletonLegUpperRight"
  "SkeletonHandLeft"
  "SkeletonHandRight"
  "SkeletonLegUpperLeft"
  "SkeletonChestUpper"
  "SkeletonArmUpperRight"
  "SkeletonArmUpperLeft"
  "SkeletonHead"
  total_hp
  integer
  >= 0
  Additional properties are NOT allowed.
  array<object>
  enemy_id
  string
  uid: enemy_id
  Allowed values:
  "Enemy1"
  "Enemy2"
  "Enemy3"
  "Enemy4"
  "Enemy5"
  "Enemy6"
  "Enemy7"
  "Enemy8"
  array<object>
  id
  string
  uid: target_state_part
  Allowed values:
  "Head"
  "ChestUpper"
  "ArmUpperRight"
  "ArmUpperLeft"
  "LegUpperRight"
  "LegUpperLeft"
  "HandRight"
  "HandLeft"
  state
  string
  uid: target_state_enum
  0 = No target, 1 = Crossed, 2 = Checked.
  
  Allowed values:
  0
  1
  2
  raid_started_at
  string
  format: date-time
  next_reset_at
  string
  format: date-time
  array<object>
  id
  string
  uid: card_bonuses_enum
  Allowed values:
  "TeamTacticsClanMoraleBoost"
  "MirrorForceBoost"
  value
  number
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "raid_id": 0, "morale": { "bonus_amount": 0.1, "used": 0 }, "raid": { "level": 0, "tier": 0, "spawn_sequence": [ "Lojak" ], "titans": [ { "enemy_name": "Lojak", "enemy_id": "Enemy1", "total_hp": 0, "parts": [ { "part_id": "ArmorLegUpperRight", "total_hp": 0 } ] } ] }, "titan_target": [ { "enemy_id": "Enemy1", "state": [ { "id": "Head", "state": 0 } ] } ], "raid_started_at": "2019-08-24T14:15:22Z", "next_reset_at": "2019-08-24T14:15:22Z", "card_bonuses": [ { "id": "TeamTacticsClanMoraleBoost", "value": 0 } ] }
  
  This example has been generated automatically.
- #13target
  Titan targets change log. You receive this event for the clan you have registered to.
  
  object
  clan_code
  string
  raid_id
  integer
  updated_at
  string
  format: date-time
  object
  name
  string
  player_code
  string
  Additional properties are NOT allowed.
  enemy_id
  string
  uid: enemy_id
  Allowed values:
  "Enemy1"
  "Enemy2"
  "Enemy3"
  "Enemy4"
  "Enemy5"
  "Enemy6"
  "Enemy7"
  "Enemy8"
  array<object>
  id
  string
  uid: target_state_part
  Allowed values:
  "Head"
  "ChestUpper"
  "ArmUpperRight"
  "ArmUpperLeft"
  "LegUpperRight"
  "LegUpperLeft"
  "HandRight"
  "HandLeft"
  state
  string
  uid: target_state_enum
  0 = No target, 1 = Crossed, 2 = Checked.
  
  Allowed values:
  0
  1
  2
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "raid_id": 0, "updated_at": "2019-08-24T14:15:22Z", "player": { "name": "string", "player_code": "string" }, "enemy_id": "Enemy1", "state": [ { "id": "Head", "state": 0 } ] }
  
  This example has been generated automatically.
- #14join
  Join a clan log. You receive this event for the clan you have registered to.
  
  object
  clan_code
  string
  object
  name
  string
  player_code
  string
  Additional properties are NOT allowed.
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "player": { "name": "string", "player_code": "string" } }
  
  This example has been generated automatically.
- #15leave
  Leave a clan log. You receive this event for the clan you have registered to.
  
  object
  clan_code
  string
  object
  name
  string
  player_code
  string
  Additional properties are NOT allowed.
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "player": { "name": "string", "player_code": "string" } }
  
  This example has been generated automatically.
- #16kick
  Get kicked from a clan log. You receive this event for the clan you have registered to.
  
  object
  clan_code
  string
  object
  name
  string
  player_code
  string
  Additional properties are NOT allowed.
  object
  name
  string
  player_code
  string
  Additional properties are NOT allowed.
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "player": { "name": "string", "player_code": "string" }, "executor": { "name": "string", "player_code": "string" } }
  
  This example has been generated automatically.
- #17morale
  Morale collection log. You receive this event for the clan you have registered to.
  
  object
  clan_code
  string
  object
  name
  string
  player_code
  string
  Additional properties are NOT allowed.
  amount
  number
  format: integer>= 0
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "player": { "name": "string", "player_code": "string" }, "amount": 0 }
  
  This example has been generated automatically.
- #18clan_sync
  Resync clan when some event is happening. You receive this event for the clan you have registered to.
  
  object
  clan_code
  string
  clan_name
  string
  Additional properties are NOT allowed.
  Examples
  { "clan_code": "string", "clan_name": "string" }
  
  This example has been generated automatically.
ON /player
object
This data might be a bit different depending on which SocketIO client you're using. This example has been written using a Javascript SocketIO client. For more detail, please check with your SocketIO package documentation.

autoConnect
boolean
Advised to set it to false and manually connect during development.

Default value:true
reconnectionAttempts
integer
Advised to not set this to a high value if you don't want to be automatically banned due to the rate error rate limit (read the main page for more info on rate limit).

transports
required
array<string>
Const:["websocket"]
required
object
API-Authenticate
required
string
Your Application Token token must be used here.

Additional properties are NOT allowed.
Additional properties are NOT allowed.
Accepts one of the following messages:
- #0connected
  Event emitted when the connection has been established. No payload returned.
  
  Examples
- #1disconnect
  Event emitted when the client is disconnected by itself or by the server.
  
  Payload
  string
  Examples
  string
  
  This example has been generated automatically.
- #2error
  General error handler event.
  
  object
  message
  string
  Additional properties are NOT allowed.
  Examples
  { "message": "string" }
  
  This example has been generated automatically.
- #3connect_error
  Error handler event when something went wrong during connection. Do not auto-reconnect on this event and look properly at the error.
  
  object
  message
  string
  Additional properties are NOT allowed.
  Examples
  { "message": "string" }
  
  This example has been generated automatically.

Messages

#1connected
Event emitted when the connection has been established. No payload returned.
#2disconnect
Event emitted when the client is disconnected by itself or by the server.

Payload
string
#3error
General error handler event.

object
message
string
Additional properties are NOT allowed.
#4connect_error
Error handler event when something went wrong during connection. Do not auto-reconnect on this event and look properly at the error.

object
message
string
Additional properties are NOT allowed.
#5unsub_clan
Event received when your application has been kicked out from a room. This can happen if a player token has been revoked.

object
clan_code
string
namespace
string
token
string
format: uuid
Additional properties are NOT allowed.
#6start_attack
Start attack log. You receive this event for the clan you have registered to.
object
clan_code
string
raid_id
integer
object
name
string
player_code
string
Additional properties are NOT allowed.
array<string>
Items:
string
uid: card_enum
Allowed values:
"MoonBeam"
"Fragmentize"
"SkullBash"
"RazorWind"
"WhipOfLightning"
"BurstCount"
"Purify"
"LimbBurst"
"FlakShot"
"Haymaker"
"ChainLightning"
"MirrorForce"
"CelestialStatic"
"BurningAttack"
"PoisonAttack"
"DecayingAttack"
"Fuse"
"Shadow"
"PlagueAttack"
"Disease"
"Swarm"
"RuinousRust"
"PowerBubble"
"RuneAttack"
"ExecutionersAxe"
"CrushingVoid"
"MentalFocus"
"ImpactAttack"
"InnerTruth"
"FinisherAttack"
"SuperheatMetal"
"BurstBoost"
"LimbSupport"
"TotemFairySkill"
"TeamTactics"
"SpinalTap"
started_at
string
format: date-time
Additional properties are NOT allowed.
#7attack
Raid attack log. You receive this event for the clan you have registered to.
object
clan_code
string
raid_id
integer
cycle
integer
object
name
string
player_code
string
raid_level
integer
attacks_remaining
integer
Additional properties are NOT allowed.
object
array<object>
titan_index
integer
>= 0
id
string
ID of the card, None for TapDamage

array<object>
id
string
uid: titan_part_enum
Allowed values:
"ArmorLegUpperRight"
"ArmorHandLeft"
"ArmorHandRight"
"ArmorLegUpperLeft"
"ArmorChestUpper"
"ArmorArmUpperRight"
"ArmorArmUpperLeft"
"ArmorHead"
"BodyLegUpperRight"
"BodyHandLeft"
"BodyHandRight"
"BodyLegUpperLeft"
"BodyChestUpper"
"BodyArmUpperRight"
"BodyArmUpperLeft"
"BodyHead"
"SkeletonLegUpperRight"
"SkeletonHandLeft"
"SkeletonHandRight"
"SkeletonLegUpperLeft"
"SkeletonChestUpper"
"SkeletonArmUpperRight"
"SkeletonArmUpperLeft"
"SkeletonHead"
value
integer
>= 0
array<object>
id
string
uid: card_enum
Allowed values:
"MoonBeam"
"Fragmentize"
"SkullBash"
"RazorWind"
"WhipOfLightning"
"BurstCount"
"Purify"
"LimbBurst"
"FlakShot"
"Haymaker"
"ChainLightning"
"MirrorForce"
"CelestialStatic"
"BurningAttack"
"PoisonAttack"
"DecayingAttack"
"Fuse"
"Shadow"
"PlagueAttack"
"Disease"
"Swarm"
"RuinousRust"
"PowerBubble"
"RuneAttack"
"ExecutionersAxe"
"CrushingVoid"
"MentalFocus"
"ImpactAttack"
"InnerTruth"
"FinisherAttack"
"SuperheatMetal"
"BurstBoost"
"LimbSupport"
"TotemFairySkill"
"TeamTactics"
"SpinalTap"
value
integer
>= 0
attack_datetime
string
format: date-time
Additional properties are NOT allowed.
object
titan_index
integer
>= 0
object
current_hp
integer
enemy_id
string
uid: enemy_id
Allowed values:
"Enemy1"
"Enemy2"
"Enemy3"
"Enemy4"
"Enemy5"
"Enemy6"
"Enemy7"
"Enemy8"
array<object>
part_id
string
uid: titan_part_enum
Allowed values:
"ArmorLegUpperRight"
"ArmorHandLeft"
"ArmorHandRight"
"ArmorLegUpperLeft"
"ArmorChestUpper"
"ArmorArmUpperRight"
"ArmorArmUpperLeft"
"ArmorHead"
"BodyLegUpperRight"
"BodyHandLeft"
"BodyHandRight"
"BodyLegUpperLeft"
"BodyChestUpper"
"BodyArmUpperRight"
"BodyArmUpperLeft"
"BodyHead"
"SkeletonLegUpperRight"
"SkeletonHandLeft"
"SkeletonHandRight"
"SkeletonLegUpperLeft"
"SkeletonChestUpper"
"SkeletonArmUpperRight"
"SkeletonArmUpperLeft"
"SkeletonHead"
current_hp
integer
>= 0
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
#8start
Start raid log. You receive this event for the clan you have registered to.
object
clan_code
string
raid_id
integer
object
name
string
player_code
string
Additional properties are NOT allowed.
keys_remaining
integer
[ 0 .. 2 ]
object
bonus_amount
number
format: float>= 0
used
integer
>= 0
Additional properties are NOT allowed.
object
level
integer
tier
integer
array<string>
Items:
string
uid: enemy_name_enum
Allowed values:
"Lojak"
"Takedar"
"Jukk"
"Sterl"
"Mohaca"
"Terro"
"Klonk"
"Priker"
array<object>
enemy_name
string
uid: enemy_name_enum
Allowed values:
"Lojak"
"Takedar"
"Jukk"
"Sterl"
"Mohaca"
"Terro"
"Klonk"
"Priker"
enemy_id
string
uid: enemy_id
Allowed values:
"Enemy1"
"Enemy2"
"Enemy3"
"Enemy4"
"Enemy5"
"Enemy6"
"Enemy7"
"Enemy8"
total_hp
integer
array<object>
part_id
string
uid: titan_part_enum
Allowed values:
"ArmorLegUpperRight"
"ArmorHandLeft"
"ArmorHandRight"
"ArmorLegUpperLeft"
"ArmorChestUpper"
"ArmorArmUpperRight"
"ArmorArmUpperLeft"
"ArmorHead"
"BodyLegUpperRight"
"BodyHandLeft"
"BodyHandRight"
"BodyLegUpperLeft"
"BodyChestUpper"
"BodyArmUpperRight"
"BodyArmUpperLeft"
"BodyHead"
"SkeletonLegUpperRight"
"SkeletonHandLeft"
"SkeletonHandRight"
"SkeletonLegUpperLeft"
"SkeletonChestUpper"
"SkeletonArmUpperRight"
"SkeletonArmUpperLeft"
"SkeletonHead"
total_hp
integer
>= 0
Additional properties are NOT allowed.
start_at
string
format: date-time
Additional properties are NOT allowed.
#9sub_start
Start raid log. This event is sent when you subscribe to a new clan.
object
clan_code
string
raid_id
integer
keys_remaining
integer
[ 0 .. 2 ]
object
bonus_amount
number
format: float>= 0
used
integer
>= 0
Additional properties are NOT allowed.
object
level
integer
tier
integer
array<string>
Items:
string
uid: enemy_name_enum
Allowed values:
"Lojak"
"Takedar"
"Jukk"
"Sterl"
"Mohaca"
"Terro"
"Klonk"
"Priker"
array<object>
enemy_name
string
uid: enemy_name_enum
Allowed values:
"Lojak"
"Takedar"
"Jukk"
"Sterl"
"Mohaca"
"Terro"
"Klonk"
"Priker"
enemy_id
string
uid: enemy_id
Allowed values:
"Enemy1"
"Enemy2"
"Enemy3"
"Enemy4"
"Enemy5"
"Enemy6"
"Enemy7"
"Enemy8"
total_hp
integer
array<object>
part_id
string
uid: titan_part_enum
Allowed values:
"ArmorLegUpperRight"
"ArmorHandLeft"
"ArmorHandRight"
"ArmorLegUpperLeft"
"ArmorChestUpper"
"ArmorArmUpperRight"
"ArmorArmUpperLeft"
"ArmorHead"
"BodyLegUpperRight"
"BodyHandLeft"
"BodyHandRight"
"BodyLegUpperLeft"
"BodyChestUpper"
"BodyArmUpperRight"
"BodyArmUpperLeft"
"BodyHead"
"SkeletonLegUpperRight"
"SkeletonHandLeft"
"SkeletonHandRight"
"SkeletonLegUpperLeft"
"SkeletonChestUpper"
"SkeletonArmUpperRight"
"SkeletonArmUpperLeft"
"SkeletonHead"
total_hp
integer
>= 0
Additional properties are NOT allowed.
array<object>
enemy_id
string
uid: enemy_id
Allowed values:
"Enemy1"
"Enemy2"
"Enemy3"
"Enemy4"
"Enemy5"
"Enemy6"
"Enemy7"
"Enemy8"
array<object>
id
string
uid: target_state_part
Allowed values:
"Head"
"ChestUpper"
"ArmUpperRight"
"ArmUpperLeft"
"LegUpperRight"
"LegUpperLeft"
"HandRight"
"HandLeft"
state
string
uid: target_state_enum
0 = No target, 1 = Crossed, 2 = Checked.

Allowed values:
0
1
2
start_at
string
format: date-time
Additional properties are NOT allowed.
#10end
End raid log. You receive this event for the clan you have registered to.
object
clan_code
string
raid_id
integer
ended_at
string
format: date-time
keys_remaining
integer
[ 0 .. 2 ]
array<object>
player_code
string
name
string
num_attacks
integer
>= 0
total_damage
integer
>= 0
array<object>
enemy_id
string
uid: enemy_id
Allowed values:
"Enemy1"
"Enemy2"
"Enemy3"
"Enemy4"
"Enemy5"
"Enemy6"
"Enemy7"
"Enemy8"
titan_index
integer
>= 0
array<object>
id
string
uid: titan_part_enum
Allowed values:
"ArmorLegUpperRight"
"ArmorHandLeft"
"ArmorHandRight"
"ArmorLegUpperLeft"
"ArmorChestUpper"
"ArmorArmUpperRight"
"ArmorArmUpperLeft"
"ArmorHead"
"BodyLegUpperRight"
"BodyHandLeft"
"BodyHandRight"
"BodyLegUpperLeft"
"BodyChestUpper"
"BodyArmUpperRight"
"BodyArmUpperLeft"
"BodyHead"
"SkeletonLegUpperRight"
"SkeletonHandLeft"
"SkeletonHandRight"
"SkeletonLegUpperLeft"
"SkeletonChestUpper"
"SkeletonArmUpperRight"
"SkeletonArmUpperLeft"
"SkeletonHead"
value
integer
>= 0
Additional properties are NOT allowed.
#11retire
Retire raid log. You receive this event for the clan you have registered to.
object
clan_code
string
raid_id
integer
retired_at
string
format: date-time
object
name
string
player_code
string
Additional properties are NOT allowed.
keys_remaining
integer
[ 0 .. 2 ]
array<object>
player_code
string
name
string
num_attacks
integer
>= 0
total_damage
integer
>= 0
array<object>
enemy_id
string
uid: enemy_id
Allowed values:
"Enemy1"
"Enemy2"
"Enemy3"
"Enemy4"
"Enemy5"
"Enemy6"
"Enemy7"
"Enemy8"
titan_index
integer
>= 0
array<object>
id
string
uid: titan_part_enum
Allowed values:
"ArmorLegUpperRight"
"ArmorHandLeft"
"ArmorHandRight"
"ArmorLegUpperLeft"
"ArmorChestUpper"
"ArmorArmUpperRight"
"ArmorArmUpperLeft"
"ArmorHead"
"BodyLegUpperRight"
"BodyHandLeft"
"BodyHandRight"
"BodyLegUpperLeft"
"BodyChestUpper"
"BodyArmUpperRight"
"BodyArmUpperLeft"
"BodyHead"
"SkeletonLegUpperRight"
"SkeletonHandLeft"
"SkeletonHandRight"
"SkeletonLegUpperLeft"
"SkeletonChestUpper"
"SkeletonArmUpperRight"
"SkeletonArmUpperLeft"
"SkeletonHead"
value
integer
>= 0
Additional properties are NOT allowed.
#12cycle_reset
Cycle reset log. You receive this event for the clan you have registered to.
object
clan_code
string
raid_id
integer
started_at
string
format: date-time
raid_started_at
string
format: date-time
next_reset_at
string
format: date-time
object
bonus_amount
number
format: float>= 0
used
integer
>= 0
Additional properties are NOT allowed.
array<object>
id
string
uid: card_bonuses_enum
Allowed values:
"TeamTacticsClanMoraleBoost"
"MirrorForceBoost"
value
number
Additional properties are NOT allowed.
#13sub_cycle
Cycle reset log. This event is sent when you subscribe to a new clan.
object
clan_code
string
raid_id
integer
object
bonus_amount
number
format: float>= 0
used
integer
>= 0
Additional properties are NOT allowed.
object
level
integer
tier
integer
array<string>
Items:
string
uid: enemy_name_enum
Allowed values:
"Lojak"
"Takedar"
"Jukk"
"Sterl"
"Mohaca"
"Terro"
"Klonk"
"Priker"
array<object>
enemy_name
string
uid: enemy_name_enum
Allowed values:
"Lojak"
"Takedar"
"Jukk"
"Sterl"
"Mohaca"
"Terro"
"Klonk"
"Priker"
enemy_id
string
uid: enemy_id
Allowed values:
"Enemy1"
"Enemy2"
"Enemy3"
"Enemy4"
"Enemy5"
"Enemy6"
"Enemy7"
"Enemy8"
total_hp
integer
array<object>
part_id
string
uid: titan_part_enum
Allowed values:
"ArmorLegUpperRight"
"ArmorHandLeft"
"ArmorHandRight"
"ArmorLegUpperLeft"
"ArmorChestUpper"
"ArmorArmUpperRight"
"ArmorArmUpperLeft"
"ArmorHead"
"BodyLegUpperRight"
"BodyHandLeft"
"BodyHandRight"
"BodyLegUpperLeft"
"BodyChestUpper"
"BodyArmUpperRight"
"BodyArmUpperLeft"
"BodyHead"
"SkeletonLegUpperRight"
"SkeletonHandLeft"
"SkeletonHandRight"
"SkeletonLegUpperLeft"
"SkeletonChestUpper"
"SkeletonArmUpperRight"
"SkeletonArmUpperLeft"
"SkeletonHead"
total_hp
integer
>= 0
Additional properties are NOT allowed.
array<object>
enemy_id
string
uid: enemy_id
Allowed values:
"Enemy1"
"Enemy2"
"Enemy3"
"Enemy4"
"Enemy5"
"Enemy6"
"Enemy7"
"Enemy8"
array<object>
id
string
uid: target_state_part
Allowed values:
"Head"
"ChestUpper"
"ArmUpperRight"
"ArmUpperLeft"
"LegUpperRight"
"LegUpperLeft"
"HandRight"
"HandLeft"
state
string
uid: target_state_enum
0 = No target, 1 = Crossed, 2 = Checked.

Allowed values:
0
1
2
raid_started_at
string
format: date-time
next_reset_at
string
format: date-time
array<object>
id
string
uid: card_bonuses_enum
Allowed values:
"TeamTacticsClanMoraleBoost"
"MirrorForceBoost"
value
number
Additional properties are NOT allowed.
#14target
Titan targets change log. You receive this event for the clan you have registered to.
object
clan_code
string
raid_id
integer
updated_at
string
format: date-time
object
name
string
player_code
string
Additional properties are NOT allowed.
enemy_id
string
uid: enemy_id
Allowed values:
"Enemy1"
"Enemy2"
"Enemy3"
"Enemy4"
"Enemy5"
"Enemy6"
"Enemy7"
"Enemy8"
array<object>
id
string
uid: target_state_part
Allowed values:
"Head"
"ChestUpper"
"ArmUpperRight"
"ArmUpperLeft"
"LegUpperRight"
"LegUpperLeft"
"HandRight"
"HandLeft"
state
string
uid: target_state_enum
0 = No target, 1 = Crossed, 2 = Checked.

Allowed values:
0
1
2
Additional properties are NOT allowed.
#15join
Join a clan log. You receive this event for the clan you have registered to.

object
clan_code
string
object
name
string
player_code
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
#16leave
Leave a clan log. You receive this event for the clan you have registered to.

object
clan_code
string
object
name
string
player_code
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
#17kick
Get kicked from a clan log. You receive this event for the clan you have registered to.

object
clan_code
string
object
name
string
player_code
string
Additional properties are NOT allowed.
object
name
string
player_code
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
#18morale
Morale collection log. You receive this event for the clan you have registered to.

object
clan_code
string
object
name
string
player_code
string
Additional properties are NOT allowed.
amount
number
format: integer>= 0
Additional properties are NOT allowed.
#19clan_sync
Resync clan when some event is happening. You receive this event for the clan you have registered to.

object
clan_code
string
clan_name
string
Additional properties are NOT allowed.

Schemas

payloads
any
uid: payloads
objects
any
uid: objects
titan_part_enum
string
uid: titan_part_enum
Allowed values:
"ArmorLegUpperRight"
"ArmorHandLeft"
"ArmorHandRight"
"ArmorLegUpperLeft"
"ArmorChestUpper"
"ArmorArmUpperRight"
"ArmorArmUpperLeft"
"ArmorHead"
"BodyLegUpperRight"
"BodyHandLeft"
"BodyHandRight"
"BodyLegUpperLeft"
"BodyChestUpper"
"BodyArmUpperRight"
"BodyArmUpperLeft"
"BodyHead"
"SkeletonLegUpperRight"
"SkeletonHandLeft"
"SkeletonHandRight"
"SkeletonLegUpperLeft"
"SkeletonChestUpper"
"SkeletonArmUpperRight"
"SkeletonArmUpperLeft"
"SkeletonHead"
card_bonuses_enum
string
uid: card_bonuses_enum
Allowed values:
"TeamTacticsClanMoraleBoost"
"MirrorForceBoost"
card_enum
string
uid: card_enum
Allowed values:
"MoonBeam"
"Fragmentize"
"SkullBash"
"RazorWind"
"WhipOfLightning"
"BurstCount"
"Purify"
"LimbBurst"
"FlakShot"
"Haymaker"
"ChainLightning"
"MirrorForce"
"CelestialStatic"
"BurningAttack"
"PoisonAttack"
"DecayingAttack"
"Fuse"
"Shadow"
"PlagueAttack"
"Disease"
"Swarm"
"RuinousRust"
"PowerBubble"
"RuneAttack"
"ExecutionersAxe"
"CrushingVoid"
"MentalFocus"
"ImpactAttack"
"InnerTruth"
"FinisherAttack"
"SuperheatMetal"
"BurstBoost"
"LimbSupport"
"TotemFairySkill"
"TeamTactics"
"SpinalTap"
enemy_id
string
uid: enemy_id
Allowed values:
"Enemy1"
"Enemy2"
"Enemy3"
"Enemy4"
"Enemy5"
"Enemy6"
"Enemy7"
"Enemy8"
enemy_name_enum
string
uid: enemy_name_enum
Allowed values:
"Lojak"
"Takedar"
"Jukk"
"Sterl"
"Mohaca"
"Terro"
"Klonk"
"Priker"
target_state_enum
string
uid: target_state_enum
0 = No target, 1 = Crossed, 2 = Checked.

Allowed values:
0
1
2
target_state_part
string
uid: target_state_part
Allowed values:
"Head"
"ChestUpper"
"ArmUpperRight"
"ArmUpperLeft"
"LegUpperRight"
"LegUpperLeft"
"HandRight"
"HandLeft"

Tap Titans 2 API 1.0.0

Servers

Security:

Operations

ON /raid

Examples

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

ON /player

Examples

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Messages

Schemas