Tap Titans 2 API

https://tt2-docs.gamehivegames.com/
Admin
Tap Titans 2 API provides REST and Socket documentation for developers to integrate with the Tap...
Tokens:9,568
Snippets:29
Trust Score:1.4
Update:8 months ago
Show doc for...
Tokens:
Raw
### Start Attack Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Start attack log. You receive this event for the clan you have registered to.

```APIDOC
## Start Attack Event

### Description
Start attack log. You receive this event for the clan you have registered to.

### Method
EVENT

### Endpoint
`/start_attack`

### Parameters
#### Request Body
- **payload** (object) - Required - The start attack payload.
  - **clan_code** (string) - Required - The code of the clan.
  - **raid_id** (integer) - Required - The ID of the raid.
  - **player** (object) - Required - Information about the player.
    - **player_id** (string) - Required - The unique identifier for the player.
    - **name** (string) - Required - The player's name.
  - **cards** (array) - Required - A list of cards used in the attack.
    - Each item in the array should be a string representing a card enum.
  - **started_at** (string) - Required - The timestamp when the attack started (ISO 8601 format).

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN123",
    "raid_id": 101,
    "player": {
      "player_id": "PLAYER456",
      "name": "Gamer1"
    },
    "cards": ["CARD_A", "CARD_B"],
    "started_at": "2023-10-27T10:00:00Z"
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Start Raid Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Start raid log. You receive this event for the clan you have registered to.

```APIDOC
## Start Raid Event

### Description
Start raid log. You receive this event for the clan you have registered to.

### Method
EVENT

### Endpoint
`/start`

### Parameters
#### Request Body
- **payload** (object) - Required - The start raid payload.
  - **clan_code** (string) - Required - The code of the clan.
  - **raid_id** (integer) - Required - The ID of the raid.
  - **player** (object) - Required - Information about the player.
    - **player_id** (string) - Required - The unique identifier for the player.
    - **name** (string) - Required - The player's name.
  - **keys_remaining** (integer) - Required - The number of keys remaining for the player (0-2).
  - **morale** (object) - Required - Morale information.
    - **current_morale** (integer) - Required - The current morale level.
    - **max_morale** (integer) - Required - The maximum morale level.
  - **raid** (object) - Required - Raid seed information.
    - **seed** (integer) - Required - The raid seed value.
  - **start_at** (string) - Required - The timestamp when the raid started (ISO 8601 format).

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN123",
    "raid_id": 101,
    "player": {
      "player_id": "PLAYER456",
      "name": "Gamer1"
    },
    "keys_remaining": 2,
    "morale": {
      "current_morale": 100,
      "max_morale": 100
    },
    "raid": {
      "seed": 12345
    },
    "start_at": "2023-10-27T09:00:00Z"
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Subscribe Start Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Start raid log. This event is sent when you subscribe to a new clan.

```APIDOC
## Subscribe Start Event

### Description
Start raid log. This event is sent when you subscribe to a new clan.

### Method
EVENT

### Endpoint
`/sub_start`

### Parameters
#### Request Body
- **payload** (object) - Required - The subscribe start payload.
  - **clan_code** (string) - Required - The code of the clan.
  - **raid_id** (integer) - Required - The ID of the raid.
  - **keys_remaining** (integer) - Required - The number of keys remaining for the player (0-2).

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN456",
    "raid_id": 102,
    "keys_remaining": 1
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Kick Clan Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Get kicked from a clan log. You receive this event for the clan you have registered to.

```APIDOC
## Kick Clan Event

### Description
Get kicked from a clan log. You receive this event for the clan you have registered to.

### Method
EVENT

### Endpoint
`/kick`

### Parameters
#### Request Body
- **payload** (object) - Required - The kick clan payload.
  - **clan_code** (string) - Required - The code of the clan.
  - **player_id** (string) - Required - The ID of the player who was kicked.

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN123",
    "player_id": "PLAYER789"
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Join Clan Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Join a clan log. You receive this event for the clan you have registered to.

```APIDOC
## Join Clan Event

### Description
Join a clan log. You receive this event for the clan you have registered to.

### Method
EVENT

### Endpoint
`/join`

### Parameters
#### Request Body
- **payload** (object) - Required - The join clan payload.
  - **clan_code** (string) - Required - The code of the clan.
  - **player_id** (string) - Required - The ID of the player who joined.
  - **player_name** (string) - Required - The name of the player who joined.

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN123",
    "player_id": "PLAYER789",
    "player_name": "NewPlayer"
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### API Authentication

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Details on how to authenticate API requests using an API key.

```APIDOC
## API Authentication

### Description
All API requests must be authenticated using an API key provided in the request header.

### Method
N/A (Authentication Scheme)

### Endpoint
N/A (Authentication Scheme)

### Parameters
#### Header Parameters
- **API-Authenticate** (string) - Required - Your unique API authentication key.

### Request Example
```
GET /api/some/endpoint
Host: api.example.com
API-Authenticate: YOUR_API_KEY
```

### Response
#### Success Response (200)
N/A (Authentication Scheme)

#### Response Example
N/A (Authentication Scheme)
```

--------------------------------

### Leave Clan Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Leave a clan log. You receive this event for the clan you have registered to.

```APIDOC
## Leave Clan Event

### Description
Leave a clan log. You receive this event for the clan you have registered to.

### Method
EVENT

### Endpoint
`/leave`

### Parameters
#### Request Body
- **payload** (object) - Required - The leave clan payload.
  - **clan_code** (string) - Required - The code of the clan.
  - **player_id** (string) - Required - The ID of the player who left.

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN123",
    "player_id": "PLAYER456"
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Raid Channel API

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

This section details the WebSocket connection and subscription for the Raid channel. It includes information on query parameters for establishing the connection and the various messages that can be subscribed to.

```APIDOC
## SUBSCRIBE /raid

### Description
Allows clients to subscribe to real-time updates and events related to the game's raid system. This includes starting attacks, receiving attack data, and managing clan synchronization.

### Method
SUBSCRIBE (WebSocket)

### Endpoint
/raid

### Parameters
#### Query Parameters
- **autoConnect** (boolean) - Optional - Advised to set it to false and manually connect during development. Default: true
- **reconnectionAttempts** (integer) - Optional - Advised to not set this to a high value to avoid rate limiting.
- **transports** (array<string>) - Required - Must be `["websocket"]`.
- **extraHeaders** (object) - Required - Contains authentication headers.
  - **API-Authenticate** (string) - Required - Your Application Token.

### Request Example
```json
{
  "autoConnect": false,
  "reconnectionAttempts": 5,
  "transports": ["websocket"],
  "extraHeaders": {
    "API-Authenticate": "YOUR_API_TOKEN"
  }
}
```

### Response
#### Success Response (200)
- **connected** (object) - Event emitted when the connection has been established. No payload returned.
- **disconnect** (string) - Event emitted when the client is disconnected.
- **error** (object) - General error handler event.
- **connect_error** (object) - Event emitted when there is an error during connection.
- **unsub_clan** (object) - Event related to unsubscribing from clan updates.
- **start_attack** (object) - Event indicating the start of an attack.
- **attack** (object) - Event containing attack data.
- **start** (object) - General start event.
- **sub_start** (object) - Event related to starting subscriptions.
- **end** (object) - Event indicating the end of an action.
- **retire** (object) - Event related to retiring from an action.
- **cycle_reset** (object) - Event indicating a cycle reset.
- **sub_cycle** (object) - Event related to cycle subscriptions.
- **target** (object) - Event containing target information.
- **join** (object) - Event indicating a player joining.
- **leave** (object) - Event indicating a player leaving.
- **kick** (object) - Event indicating a player being kicked.
- **morale** (object) - Event containing morale data.
- **clan_sync** (object) - Event for clan synchronization.

#### Response Example
```json
{
  "event": "connected"
}
```
```

--------------------------------

### Card Enum

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Enumeration of all available cards that can be used in the game.

```APIDOC
## Card Enum

### Description
Lists all the unique cards available for players to use within the game.

### Method
N/A (Schema Definition)

### Endpoint
N/A (Schema Definition)

### Parameters
N/A (Schema Definition)

### Request Example
```json
"MoonBeam"
```

### Response
#### Success Response (200)
N/A (Schema Definition)

#### Response Example
N/A (Schema Definition)
```

--------------------------------

### Cycle Reset Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Cycle reset log. You receive this event for the clan you have registered to.

```APIDOC
## Cycle Reset Event

### Description
Cycle reset log. You receive this event for the clan you have registered to.

### Method
EVENT

### Endpoint
`/cycle_reset`

### Parameters
#### Request Body
- **payload** (object) - Required - The cycle reset payload.
  - **clan_code** (string) - Required - The code of the clan.
  - **raid_id** (integer) - Required - The ID of the raid.

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN123",
    "raid_id": 101
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Clan Sync Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Resync clan when some event is happening. You receive this event for the clan you have registered to.

```APIDOC
## Clan Sync Event

### Description
Resync clan when some event is happening. You receive this event for the clan you have registered to.

### Method
EVENT

### Endpoint
`/clan_sync`

### Parameters
#### Request Body
- **payload** (object) - Required - The clan sync payload.
  - **clan_code** (string) - Required - The code of the clan.

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN123"
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Enemy Name Enum

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Enumeration of the names for different enemy types.

```APIDOC
## Enemy Name Enum

### Description
Lists the display names corresponding to each enemy identifier.

### Method
N/A (Schema Definition)

### Endpoint
N/A (Schema Definition)

### Parameters
N/A (Schema Definition)

### Request Example
```json
"Lojak"
```

### Response
#### Success Response (200)
N/A (Schema Definition)

#### Response Example
N/A (Schema Definition)
```

--------------------------------

### Player Channel API

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

This section describes the WebSocket connection for the Player channel, allowing clients to receive player-specific events and status updates.

```APIDOC
## SUBSCRIBE /player

### Description
Allows clients to subscribe to real-time updates and events related to player status, connection, and errors.

### Method
SUBSCRIBE (WebSocket)

### Endpoint
/player

### Parameters
#### Query Parameters
- **autoConnect** (boolean) - Optional - Advised to set it to false and manually connect during development. Default: true
- **reconnectionAttempts** (integer) - Optional - Advised to not set this to a high value to avoid rate limiting.
- **transports** (array<string>) - Required - Must be `["websocket"]`.
- **extraHeaders** (object) - Required - Contains authentication headers.
  - **API-Authenticate** (string) - Required - Your Application Token.

### Request Example
```json
{
  "autoConnect": false,
  "reconnectionAttempts": 5,
  "transports": ["websocket"],
  "extraHeaders": {
    "API-Authenticate": "YOUR_API_TOKEN"
  }
}
```

### Response
#### Success Response (200)
- **connected** (object) - Event emitted when the connection has been established. No payload returned.
- **disconnect** (string) - Event emitted when the client is disconnected.
- **error** (object) - General error handler event.
- **connect_error** (object) - Event emitted when there is an error during connection.

#### Response Example
```json
{
  "event": "connected"
}
```
```

--------------------------------

### Morale Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Morale collection log. You receive this event for the clan you have registered to.

```APIDOC
## Morale Event

### Description
Morale collection log. You receive this event for the clan you have registered to.

### Method
EVENT

### Endpoint
`/morale`

### Parameters
#### Request Body
- **payload** (object) - Required - The morale payload.
  - **clan_code** (string) - Required - The code of the clan.
  - **raid_id** (integer) - Required - The ID of the raid.
  - **current_morale** (integer) - Required - The current morale level.
  - **max_morale** (integer) - Required - The maximum morale level.

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN123",
    "raid_id": 101,
    "current_morale": 120,
    "max_morale": 150
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Attack Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Raid attack log. You receive this event for the clan you have registered to.

```APIDOC
## Attack Event

### Description
Raid attack log. You receive this event for the clan you have registered to.

### Method
EVENT

### Endpoint
`/attack`

### Parameters
#### Request Body
- **payload** (object) - Required - The attack payload.
  - **clan_code** (string) - Required - The code of the clan.
  - **raid_id** (integer) - Required - The ID of the raid.
  - **cycle** (integer) - Required - The current raid cycle.
  - **player** (object) - Required - Information about the player.
    - **player_id** (string) - Required - The unique identifier for the player.
    - **name** (string) - Required - The player's name.
    - **attack_power** (integer) - Required - The player's attack power.
  - **attack_log** (object) - Required - Details of the attack.
    - **attack_id** (string) - Required - The unique identifier for the attack.
    - **damage** (integer) - Required - The damage dealt by the attack.
    - **timestamp** (string) - Required - The timestamp of the attack (ISO 8601 format).
  - **raid_state** (object) - Required - The current state of the raid.
    - **current_health** (integer) - Required - The remaining health of the raid boss.
    - **max_health** (integer) - Required - The maximum health of the raid boss.
    - **cycle** (integer) - Required - The current raid cycle.

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN123",
    "raid_id": 101,
    "cycle": 1,
    "player": {
      "player_id": "PLAYER456",
      "name": "Gamer1",
      "attack_power": 1500
    },
    "attack_log": {
      "attack_id": "ATTACK789",
      "damage": 500,
      "timestamp": "2023-10-27T10:05:00Z"
    },
    "raid_state": {
      "current_health": 9500,
      "max_health": 10000,
      "cycle": 1
    }
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Subscribe Cycle Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Cycle reset log. This event is sent when you subscribe to a new clan.

```APIDOC
## Subscribe Cycle Event

### Description
Cycle reset log. This event is sent when you subscribe to a new clan.

### Method
EVENT

### Endpoint
`/sub_cycle`

### Parameters
#### Request Body
- **payload** (object) - Required - The subscribe cycle payload.
  - **clan_code** (string) - Required - The code of the clan.
  - **raid_id** (integer) - Required - The ID of the raid.

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN456",
    "raid_id": 102
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Raid Operations

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

This section covers endpoints related to the lifecycle and state of a raid.

```APIDOC
## POST /api/raids/start

### Description
Initiates a new raid cycle. This endpoint is used to begin a raid, potentially setting initial conditions like morale and titan targets.

### Method
POST

### Endpoint
/api/raids/start

### Parameters
#### Request Body
- **clan_code** (string) - Required - The unique code of the clan initiating the raid.
- **raid_id** (integer) - Required - The identifier for the raid.
- **start_at** (string) - Optional - The timestamp when the raid is scheduled to start (ISO 8601 format).
- **morale** (object) - Optional - Initial morale object for the raid. See `#/components/schemas/objects/morale`.
- **raid** (object) - Optional - Raid seed details. See `#/components/schemas/objects/raid_seed`.
- **titan_target** (object) - Optional - Titan target details. See `#/components/schemas/objects/titan_target`.

### Request Example
```json
{
  "clan_code": "CLAN123",
  "raid_id": 1,
  "start_at": "2023-10-27T10:00:00Z",
  "morale": {
    "clan_code": "CLAN123",
    "player": {
      "id": "player1",
      "name": "Player One"
    },
    "amount": 1000,
    "total_amount": 5000
  },
  "raid": {
    "id": 1,
    "clan_code": "CLAN123"
  },
  "titan_target": {
    "id": "titan1",
    "clan_code": "CLAN123"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the raid has started.

#### Response Example
```json
{
  "message": "Raid started successfully."
}
```

## POST /api/raids/end

### Description
Concludes an ongoing raid. This endpoint is used to mark a raid as finished, recording the end time and remaining keys.

### Method
POST

### Endpoint
/api/raids/end

### Parameters
#### Request Body
- **clan_code** (string) - Required - The unique code of the clan whose raid is ending.
- **raid_id** (integer) - Required - The identifier for the raid.
- **ended_at** (string) - Required - The timestamp when the raid ended (ISO 8601 format).
- **keys_remaining** (integer) - Required - The number of keys remaining at the end of the raid. Must be between 0 and 2.
- **raid_summary** (object) - Optional - Summary details of the raid. See `#/components/schemas/objects/raid_summary`.

### Request Example
```json
{
  "clan_code": "CLAN123",
  "raid_id": 1,
  "ended_at": "2023-10-27T12:00:00Z",
  "keys_remaining": 1,
  "raid_summary": {
    "total_damage": 100000,
    "total_keys_used": 50
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the raid has ended.

#### Response Example
```json
{
  "message": "Raid ended successfully."
}
```

## POST /api/raids/cycle_reset

### Description
Resets the current raid cycle, preparing for a new sub-cycle or phase. This is typically used to refresh raid objectives or conditions.

### Method
POST

### Endpoint
/api/raids/cycle_reset

### Parameters
#### Request Body
- **clan_code** (string) - Required - The unique code of the clan.
- **raid_id** (integer) - Required - The identifier for the raid.
- **started_at** (string) - Required - The timestamp when the new cycle started (ISO 8601 format).
- **raid_started_at** (string) - Required - The timestamp when the overall raid started (ISO 8601 format).
- **next_reset_at** (string) - Required - The timestamp for the next cycle reset (ISO 8601 format).
- **morale** (object) - Optional - The updated morale object. See `#/components/schemas/objects/morale`.
- **card_bonuses** (array) - Optional - A list of card bonuses applied to this cycle. Each item should have an `id` (from `#/components/schemas/card_bonuses_enum`) and a `value` (number).

### Request Example
```json
{
  "clan_code": "CLAN123",
  "raid_id": 1,
  "started_at": "2023-10-27T11:00:00Z",
  "raid_started_at": "2023-10-27T10:00:00Z",
  "next_reset_at": "2023-10-27T13:00:00Z",
  "morale": {
    "clan_code": "CLAN123",
    "player": {
      "id": "player1",
      "name": "Player One"
    },
    "amount": 1200,
    "total_amount": 5000
  },
  "card_bonuses": [
    {
      "id": "bonus_type_1",
      "value": 1.5
    }
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the cycle reset.

#### Response Example
```json
{
  "message": "Raid cycle reset successfully."
}
```

## POST /api/raids/sub_cycle

### Description
Updates the state for a sub-cycle within a raid. This can be used to reflect changes in morale, raid progress, or titan targets during a raid.

### Method
POST

### Endpoint
/api/raids/sub_cycle

### Parameters
#### Request Body
- **clan_code** (string) - Required - The unique code of the clan.
- **raid_id** (integer) - Required - The identifier for the raid.
- **morale** (object) - Optional - The updated morale object. See `#/components/schemas/objects/morale`.
- **raid** (object) - Optional - Updated raid seed details. See `#/components/schemas/objects/raid_seed`.
- **titan_target** (object) - Optional - Updated titan target details. See `#/components/schemas/objects/titan_target`.
- **raid_started_at** (string) - Required - The timestamp when the overall raid started (ISO 8601 format).
- **next_reset_at** (string) - Required - The timestamp for the next cycle reset (ISO 8601 format).
- **card_bonuses** (array) - Optional - A list of card bonuses applied to this sub-cycle. Each item should have an `id` (from `#/components/schemas/card_bonuses_enum`) and a `value` (number).

### Request Example
```json
{
  "clan_code": "CLAN123",
  "raid_id": 1,
  "morale": {
    "clan_code": "CLAN123",
    "player": {
      "id": "player1",
      "name": "Player One"
    },
    "amount": 1500,
    "total_amount": 5000
  },
  "raid": {
    "id": 1,
    "clan_code": "CLAN123"
  },
  "titan_target": {
    "id": "titan1",
    "clan_code": "CLAN123"
  },
  "raid_started_at": "2023-10-27T10:00:00Z",
  "next_reset_at": "2023-10-27T13:00:00Z",
  "card_bonuses": [
    {
      "id": "bonus_type_2",
      "value": 2.0
    }
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the sub-cycle update.

#### Response Example
```json
{
  "message": "Raid sub-cycle updated successfully."
}
```

## POST /api/raids/target

### Description
Updates the target for a raid. This could involve changing the enemy ID or the state of the target.

### Method
POST

### Endpoint
/api/raids/target

### Parameters
#### Request Body
- **clan_code** (string) - Required - The unique code of the clan.
- **raid_id** (integer) - Required - The identifier for the raid.
- **updated_at** (string) - Required - The timestamp when the target was updated (ISO 8601 format).
- **player** (object) - Optional - Player information associated with the target update. See `#/components/schemas/objects/player`.
- **enemy_id** (string) - Required - The ID of the enemy being targeted.
- **state** (object) - Optional - The current state of the target. See `#/components/schemas/objects/state`.

### Request Example
```json
{
  "clan_code": "CLAN123",
  "raid_id": 1,
  "updated_at": "2023-10-27T10:30:00Z",
  "player": {
    "id": "player2",
    "name": "Player Two"
  },
  "enemy_id": "enemy_boss_1",
  "state": {
    "health": 50000,
    "max_health": 100000
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the target update.

#### Response Example
```json
{
  "message": "Raid target updated successfully."
}
```

## POST /api/raids/join

### Description
Allows a player to join an active raid.

### Method
POST

### Endpoint
/api/raids/join

### Parameters
#### Request Body
- **clan_code** (string) - Required - The unique code of the clan.
- **player** (object) - Required - The player joining the raid. See `#/components/schemas/objects/player`.

### Request Example
```json
{
  "clan_code": "CLAN123",
  "player": {
    "id": "player3",
    "name": "Player Three"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the player has joined.

#### Response Example
```json
{
  "message": "Player joined raid successfully."
}
```

## POST /api/raids/leave

### Description
Allows a player to leave an active raid.

### Method
POST

### Endpoint
/api/raids/leave

### Parameters
#### Request Body
- **clan_code** (string) - Required - The unique code of the clan.
- **player** (object) - Required - The player leaving the raid. See `#/components/schemas/objects/player`.

### Request Example
```json
{
  "clan_code": "CLAN123",
  "player": {
    "id": "player3",
    "name": "Player Three"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the player has left.

#### Response Example
```json
{
  "message": "Player left raid successfully."
}
```

## POST /api/raids/kick

### Description
Removes a player from an active raid by an executor.

### Method
POST

### Endpoint
/api/raids/kick

### Parameters
#### Request Body
- **clan_code** (string) - Required - The unique code of the clan.
- **player** (object) - Required - The player to be kicked. See `#/components/schemas/objects/player`.
- **executor** (object) - Required - The player performing the kick. See `#/components/schemas/objects/player`.

### Request Example
```json
{
  "clan_code": "CLAN123",
  "player": {
    "id": "player4",
    "name": "Player Four"
  },
  "executor": {
    "id": "player1",
    "name": "Player One"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the player has been kicked.

#### Response Example
```json
{
  "message": "Player kicked from raid successfully."
}
```

## POST /api/raids/morale

### Description
Updates the morale level for a raid, potentially influenced by player actions or raid events.

### Method
POST

### Endpoint
/api/raids/morale

### Parameters
#### Request Body
- **clan_code** (string) - Required - The unique code of the clan.
- **player** (object) - Optional - The player whose actions influenced morale. See `#/components/schemas/objects/player`.
- **amount** (integer) - Required - The change in morale amount. Must be non-negative.
- **total_amount** (integer) - Required - The total morale after the change. Must be non-negative.

### Request Example
```json
{
  "clan_code": "CLAN123",
  "player": {
    "id": "player5",
    "name": "Player Five"
  },
  "amount": 50,
  "total_amount": 1550
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the morale update.

#### Response Example
```json
{
  "message": "Raid morale updated successfully."
}
```

## POST /api/clans/sync

### Description
Synchronizes clan information, potentially updating clan name or other metadata.

### Method
POST

### Endpoint
/api/clans/sync

### Parameters
#### Request Body
- **clan_code** (string) - Required - The unique code of the clan.
- **clan_name** (string) - Required - The name of the clan.

### Request Example
```json
{
  "clan_code": "CLAN123",
  "clan_name": "The Gamehive Heroes"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the clan sync.

#### Response Example
```json
{
  "message": "Clan synced successfully."
}
```

## POST /api/clans/unsub

### Description
Unsubscribes a clan from a specific namespace or service.

### Method
POST

### Endpoint
/api/clans/unsub

### Parameters
#### Request Body
- **clan_code** (string) - Required - The unique code of the clan.
- **namespace** (string) - Required - The namespace to unsubscribe from.

### Request Example
```json
{
  "clan_code": "CLAN123",
  "namespace": "raid_notifications"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the clan has been unsubscribed.

#### Response Example
```json
{
  "message": "Clan unsubscribed successfully."
}
```
```

--------------------------------

### Unsubscribe from Clan Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Event received when your application has been kicked out from a room. This can happen if a player token has been revoked.

```APIDOC
## Unsubscribe from Clan Event

### Description
Event received when your application has been kicked out from a room. This can happen if a player token has been revoked.

### Method
EVENT

### Endpoint
`/unsub_clan`

### Parameters
#### Request Body
- **payload** (object) - Required - The unsubscribe clan payload.
  - **clan_code** (string) - Required - The code of the clan from which the user was unsubscribed.

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN123"
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Retire Raid Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Retire raid log. You receive this event for the clan you have registered to.

```APIDOC
## Retire Raid Event

### Description
Retire raid log. You receive this event for the clan you have registered to.

### Method
EVENT

### Endpoint
`/retire`

### Parameters
#### Request Body
- **payload** (object) - Required - The retire raid payload.
  - **clan_code** (string) - Required - The code of the clan.
  - **raid_id** (integer) - Required - The ID of the raid.

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN123",
    "raid_id": 101
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Target Change Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Titan targets change log. You receive this event for the clan you have registered to.

```APIDOC
## Target Change Event

### Description
Titan targets change log. You receive this event for the clan you have registered to.

### Method
EVENT

### Endpoint
`/target`

### Parameters
#### Request Body
- **payload** (object) - Required - The target change payload.
  - **clan_code** (string) - Required - The code of the clan.
  - **raid_id** (integer) - Required - The ID of the raid.
  - **target_id** (string) - Required - The ID of the new target.

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN123",
    "raid_id": 101,
    "target_id": "TITAN007"
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Damage Log Item Schema

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Defines the structure for an item within the damage log, referencing a common schema.

```APIDOC
## Damage Log Item Schema

### Description
Represents a single entry in the damage log, detailing a specific damage event.

### Method
N/A (Schema Definition)

### Endpoint
N/A (Schema Definition)

### Parameters
N/A (Schema Definition)

### Request Example
```json
{
  "$ref": "#/components/schemas/objects/damage_log_item"
}
```

### Response
#### Success Response (200)
N/A (Schema Definition)

#### Response Example
N/A (Schema Definition)
```

--------------------------------

### Card Bonuses Enum

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Enumeration of available card bonuses that can be applied in the game.

```APIDOC
## Card Bonuses Enum

### Description
Defines the set of possible bonus effects that can be granted by cards.

### Method
N/A (Schema Definition)

### Endpoint
N/A (Schema Definition)

### Parameters
N/A (Schema Definition)

### Request Example
```json
"TeamTacticsClanMoraleBoost"
```

### Response
#### Success Response (200)
N/A (Schema Definition)

#### Response Example
N/A (Schema Definition)
```

--------------------------------

### Target State Part Enum

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Enumeration of specific parts of a target that can have their state defined.

```APIDOC
## Target State Part Enum

### Description
Lists the individual parts of a target that can have their state tracked or modified.

### Method
N/A (Schema Definition)

### Endpoint
N/A (Schema Definition)

### Parameters
N/A (Schema Definition)

### Request Example
```json
"Head"
```

### Response
#### Success Response (200)
N/A (Schema Definition)

#### Response Example
N/A (Schema Definition)
```

--------------------------------

### End Raid Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

End raid log. You receive this event for the clan you have registered to.

```APIDOC
## End Raid Event

### Description
End raid log. You receive this event for the clan you have registered to.

### Method
EVENT

### Endpoint
`/end`

### Parameters
#### Request Body
- **payload** (object) - Required - The end raid payload.
  - **clan_code** (string) - Required - The code of the clan.
  - **raid_id** (integer) - Required - The ID of the raid.

### Request Example
```json
{
  "payload": {
    "clan_code": "CLAN123",
    "raid_id": 101
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Titan Part Enum

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Enumeration of all possible titan parts that can be targeted or affected.

```APIDOC
## Titan Part Enum

### Description
Lists all the distinct parts of a titan that can be referenced in game logic.

### Method
N/A (Schema Definition)

### Endpoint
N/A (Schema Definition)

### Parameters
N/A (Schema Definition)

### Request Example
```json
"ArmorLegUpperRight"
```

### Response
#### Success Response (200)
N/A (Schema Definition)

#### Response Example
N/A (Schema Definition)
```

--------------------------------

### Error Handler Event

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

An event handler for connection errors. It's advised not to auto-reconnect and to carefully examine the error details.

```APIDOC
## Error Handler Event

### Description
Error handler event when something went wrong during connection. Do not auto-reconnect on this event and look properly at the error.

### Method
EVENT

### Endpoint
`/error`

### Parameters
#### Request Body
- **payload** (object) - Required - The error message payload.
  - **message** (string) - Required - The error message.

### Request Example
```json
{
  "payload": {
    "message": "Connection failed: Unexpected error."
  }
}
```

### Response
#### Success Response (200)
(No specific success response defined for this event)

#### Response Example
(No specific response example defined for this event)
```

--------------------------------

### Titan Target Schema

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Defines the structure for targeting specific parts of a titan, including enemy ID and state.

```APIDOC
## Titan Target Schema

### Description
Specifies the targeting information for a titan, including its ID and current state.

### Method
N/A (Schema Definition)

### Endpoint
N/A (Schema Definition)

### Parameters
#### Request Body
- **enemy_id** (string) - Required - The unique identifier of the enemy titan.
- **state** (object) - Required - The current state of the titan's targetable parts.
  - **id** (string) - Required - The identifier of the specific part being targeted.
  - **state** (string) - Required - The current state of the target part (e.g., 0, 1, 2).

### Request Example
```json
{
  "enemy_id": "Enemy1",
  "state": {
    "id": "Head",
    "state": "1"
  }
}
```

### Response
#### Success Response (200)
N/A (Schema Definition)

#### Response Example
N/A (Schema Definition)
```

--------------------------------

### Enemy ID Enum

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Enumeration of unique identifiers for different enemy types.

```APIDOC
## Enemy ID Enum

### Description
Provides a list of distinct identifiers for all enemy entities in the game.

### Method
N/A (Schema Definition)

### Endpoint
N/A (Schema Definition)

### Parameters
N/A (Schema Definition)

### Request Example
```json
"Enemy1"
```

### Response
#### Success Response (200)
N/A (Schema Definition)

#### Response Example
N/A (Schema Definition)
```

--------------------------------

### Target State Enum

Source: https://tt2-docs.gamehivegames.com/socket/asyncapi

Enumeration representing the state of a target (e.g., No target, Crossed, Checked).

```APIDOC
## Target State Enum

### Description
Defines the possible states a target can be in, with numerical codes representing each state.

### Method
N/A (Schema Definition)

### Endpoint
N/A (Schema Definition)

### Parameters
N/A (Schema Definition)

### Request Example
```json
"1"
```

### Response
#### Success Response (200)
N/A (Schema Definition)

#### Response Example
N/A (Schema Definition)
```
Tokens:
Raw