---
url: /apidocs/gamification.md
---
## Gamification API

| Endpoint | Method | Description |
|-----|-----|-----|
| ~~[gamification:addEasterEggProp](#gamification-add-easter-egg-prop)~~ | websocket | Gamification: add easter egg prop |
| [gamification:setEasterEggProp](#gamification-set-easter-egg-prop) | websocket | Gamification: set easter egg prop |
| [gamification:removeEasterEggProp](#gamification-remove-easter-egg-prop) | websocket | Gamification: remove easter egg prop |
| [gamification:getEasterEggProps](#gamification-get-easter-egg-props) | websocket | Gamification: get easter egg props |
| [gamification:tryDiscoverProp](#gamification-try-discover-prop) | websocket | Gamification: try discover prop |
| [gamification:getRanking](#gamification-get-ranking) | websocket | Gamification: get ranking |
| [gamification:deleteUserRanking](#gamification-delete-user-ranking) | websocket | Gamification: delete user ranking |
| [gamification:deleteAllRankings](#gamification-delete-all-rankings) | websocket | Gamification: delete all rankings |
| [gamification:points](#user-points-event) | websocketEvent | User points event |
| [gamification:easterEggPropAdded](#on-easter-egg-prop-added-event) | websocketEvent | On easter egg prop added event |
| [gamification:easterEggPropRemoved](#on-easter-egg-prop-removed-event) | websocketEvent | On easter egg prop removed event |

### Gamification: add easter egg prop

**Method:** websocket

**Endpoint:** gamification:addEasterEggProp

**DEPRECATED**

**Request:**

**Response:**

### Gamification: set easter egg prop

**Method:** websocket

**Endpoint:** gamification:setEasterEggProp

**Request:**

**Response:**

### Gamification: remove easter egg prop

**Method:** websocket

**Endpoint:** gamification:removeEasterEggProp

**Request:**

**Response:**

### Gamification: get easter egg props

**Method:** websocket

**Endpoint:** gamification:getEasterEggProps

**Request:**

**Response:**

### Gamification: try discover prop

**Method:** websocket

**Endpoint:** gamification:tryDiscoverProp

**Request:**

**Response:**

### Gamification: get ranking

**Method:** websocket

**Endpoint:** gamification:getRanking

**Description:** If own rank equals 0, it means that user is not participating in ranking because he doesn't have any points yet.

**Request:**

**Response:**

### Gamification: delete user ranking

**Method:** websocket

**Endpoint:** gamification:deleteUserRanking

**Request:**

**Response:**

### Gamification: delete all rankings

**Method:** websocket

**Endpoint:** gamification:deleteAllRankings

**Request:**

**Response:**

### User points event

**Event:** gamification:points

**Data:**

### On easter egg prop added event

**Event:** gamification:easterEggPropAdded

**Data:**

### On easter egg prop removed event

**Event:** gamification:easterEggPropRemoved

**Data:**

## Models

#### User Simple