---
url: /apidocs/balance.md
---
## Balance API

| Endpoint | Method | Description |
|-----|-----|-----|
| [balance:getTransactions](#get-balance-transactions) | websocket | Get balance transactions |
| [balance:getTokenAction](#get-token-action) | websocket | Get token action |
| [balance:getTokenActionList](#get-token-action-list) | websocket | Get token action list |
| [balance:donateToken](#donate-token) | websocket | Donate token |
| [balance:addUserBalanceByAdmin](#add-user-balance-by-admin) | websocket | Add user balance by admin |
| [balance:getCurrencyExchangeRate](#get-currency-exchange-rate) | websocket | Get currency exchange rate |
| [balance:getProductSubscriptionOptions](#get-product-subscription-options) | websocket | Get product subscription options |
| [balance:createRoomSubscription](#create-room-subscription) | websocket | Create room subscription |
| [balance:expireRoomSubscription](#expire-room-subscription) | websocket | Expire room subscription |
| [user:balance](#user-balance-event) | websocketEvent | User balance event |

### Get balance transactions

**Method:** websocket

**Endpoint:** balance:getTransactions

**Request:**

**Response:**

### Get token action

**Method:** websocket

**Endpoint:** balance:getTokenAction

**Request:**

**Response:**

### Get token action list

**Method:** websocket

**Endpoint:** balance:getTokenActionList

**Request:**

**Response:**

### Donate token

**Method:** websocket

**Endpoint:** balance:donateToken

**Request:**

**Response:**

### Add user balance by admin

**Method:** websocket

**Endpoint:** balance:addUserBalanceByAdmin

**Description:** Api is available only for admin users. Balance could also be withdrawn if amount is provided with negative value.

**Request:**

**Response:**

### Get currency exchange rate

**Method:** websocket

**Endpoint:** balance:getCurrencyExchangeRate

**Request:**

**Response:**

### Get product subscription options

**Method:** websocket

**Endpoint:** balance:getProductSubscriptionOptions

**Description:** Api returns subscription options for product. If request contains non default currency, endpoint will return corresponding `altPrice` and `altCurrency` in result. Currency could be one of: `roomi` (Roomful crypto currency), `Valu` (ValuVerse crypto currency).

**Request:**

**Response:**

### Create room subscription

**Method:** websocket

**Endpoint:** balance:createRoomSubscription

**Request:**

**Response:**

### Expire room subscription

**Method:** websocket

**Endpoint:** balance:expireRoomSubscription

**Description:** Api is available only for network admin users

**Request:**

**Response:**

### User balance event

**Event:** user:balance

**Data:**