HollaEx

https://docs.hollaex.com
Admin
HollaEx is an open-source white-label crypto exchange software that allows businesses and developers...
Tokens:100,617
Snippets:1,337
Trust Score:9.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start Web Development Environment

Source: https://docs.hollaex.com/developers/run-dev-mode.md

Run this command in the /web directory to install dependencies and launch the local development server.

```bash
npm start
```

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

### Plugin Installation Response Example

Source: https://docs.hollaex.com/plugins/installing-plugin.md

Example of a successful 200 response body returned after installing a plugin.

```javascript
{
    "name": "hello-exchange",
    "version": 1,
    "author": "bitHolla",
    "enabled": true,
    "description": "Demo plugin for proof of concept",
    "bio": "Demo plugin",
    "public_meta": { ... },
    "web_view": null,
    "updated_at": "2021-03-08T04:06:03.357Z",
    "created_at": "2021-03-08T04:06:03.357Z",
    "documentation": null,
    "logo": null,
    "icon": null,
    "url": null,
    "enabled_admin_view": false
```

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

### Start the exchange server

Source: https://docs.hollaex.com/get-started/cli-how-tos/start-exchange.md

Initializes the exchange server and applies settings. Run this after the setup process or to restart a stopped server.

```bash
hollaex server --start
```

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

### Start the exchange web server

Source: https://docs.hollaex.com/get-started/cli-how-tos/start-exchange.md

Starts the web interface for the exchange. This must be executed after the web setup procedure is complete.

```bash
hollaex web --start
```

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

### Run the CLI installer

Source: https://docs.hollaex.com/get-started/on-premise-exchange-setup/installation.md

Executes the installation script to set up the HollaEx CLI tool.

```bash
bash install.sh
```

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

### Install Plugin Dependencies

Source: https://docs.hollaex.com/plugins/develop-plugins/web-view-development/getting-started.md

Commands to install dependencies for the main project and the web directory.

```bash
npm install
cd web/ && npm install
```

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

### Configure and Start Server

Source: https://docs.hollaex.com/developers/run-dev-mode.md

Commands to navigate the directory, prepare the environment file, and launch the server containers.

```bash
cd hollaex-kit/
cd server/
mv tools/hollaex-kit.env.local.example tools/hollaex-kit.env.local
docker-compose up
docker ps
docker exec -it server_hollaex-kit-server_1 /bin/bash
```

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

### Verify HollaEx CLI installation

Source: https://docs.hollaex.com/get-started/on-premise-exchange-setup/installation.md

Checks the installed versions of the HollaEx CLI and the Kit to ensure successful setup.

```bash
hollaex version
```

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

### Setup web server on Kubernetes

Source: https://docs.hollaex.com/get-started/run-exchange-on-kubernetes.md

Initialize the web server component on the Kubernetes cluster.

```bash
hollaex web --setup --kube
```

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

### Full hollacloud.json Configuration Example

Source: https://docs.hollaex.com/advanced/customizing-your-frontend-projects-with-hollacloud-json.md

A comprehensive example demonstrating SPA fallback, URL normalization, redirects, rewrites, and custom header injection.

```json
{
  "site": {
    "spa": true
  },
  "lowercaseUrls": true,
  "trailingSlash": false,
  "redirects": [
    {
      "source": "/old-blog",
      "destination": "/blog"
    },
    {
      "source": "/docs/:path*",
      "destination": "/help/:path*"
    },
    {
      "source": "/u/:id",
      "destination": "/users/:id"
    },
    {
      "source": "/sale",
      "destination": "/summer-sale",
      "statusCode": 302
    },
    {
      "source": "/chat",
      "destination": "https://discord.gg/your-invite"
    }
  ],
  "rewrites": [
    {
      "source": "/app/:path*",
      "destination": "/index.html"
    }
  ],
  "headers": [
    {
      "source": "/assets/:path*",
      "headers": [
        {
          "key": "Cache-Control",
          "value": "public, max-age=86400"
        }
      ]
    },
    {
      "source": "/:path*",
      "headers": [
        {
          "key": "X-Frame-Options",
          "value": "DENY"
        }
      ]
    }
  ]
}
```

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

### Initialize Production Environment

Source: https://docs.hollaex.com/get-started/on-premise-exchange-setup/use-custom-domain.md

Starts the production exchange process via the HollaEx CLI.

```bash
hollaex prod
```

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

### Setup exchange on Kubernetes

Source: https://docs.hollaex.com/get-started/run-exchange-on-kubernetes.md

Initialize the exchange environment on the Kubernetes cluster.

```bash
hollaex server --setup --kube
```

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

### Install Homebrew on macOS

Source: https://docs.hollaex.com/advanced/hollaex-on-non-linux/hollaex-on-macos.md

Execute this command in the Terminal to install the Homebrew package manager.

```bash
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```

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

### Query documentation via HTTP GET

Source: https://docs.hollaex.com/llms.txt

Perform a GET request to the documentation index with an ask parameter to receive a direct answer and relevant excerpts.

```http
GET https://docs.hollaex.com/master.md?ask=<question>&goal=<end_goal>
```

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

### Start Development Mode

Source: https://docs.hollaex.com/plugins/develop-plugins/simple-wallet-example.md

Command to launch the exchange in development mode for the specific plugin.

```jsx
npm start --plugin=my-simple-wallet
```

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

### Start Development Mode

Source: https://docs.hollaex.com/plugins/develop-plugins/web-view-development/basic-tutorial-hello-exchange-plugin-web-view.md

Commands to run the development server and the Hollaex kit plugin development mode.

```bash
npm start --plugin=hello-exchange
```

```bash
npm run dev:plugin --plugin=hello-exchange
```

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

### Start exchange on Kubernetes

Source: https://docs.hollaex.com/get-started/run-exchange-on-kubernetes.md

Launch the exchange services within the Kubernetes cluster.

```bash
hollaex server --start --kube
```

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

### Query Documentation via HTTP GET

Source: https://docs.hollaex.com/how-tos/configure-pair-parameters

Perform a GET request to the documentation index to retrieve answers based on a specific question and optional goal.

```http
GET https://docs.hollaex.com/how-tos/assets-and-trading-pairs/configure-pair-parameters.md?ask=<question>&goal=<end_goal>
```

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

### Start the plugin in development mode

Source: https://docs.hollaex.com/plugins/develop-plugins/development-walkthrough-hello-plugin/web-view.md

Execute this command within the hollaex-kit/plugins directory to initiate the plugin compilation process.

```bash
npm start --plugin=hello-plugin
```

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

### POST /plugins

Source: https://docs.hollaex.com/plugins/installing-plugin.md

Install a new plugin by providing the plugin configuration details in the request body.

```APIDOC
## POST https://<API_URL>/plugins

### Description
Install a plugin into the system.

### Method
POST

### Endpoint
https://<API_URL>/plugins

### Headers
- **authorization** (string) - Required - Bearer token

### Request Body
- **public_meta** (object) - Optional - Plugin public_meta object
- **type** (string) - Optional - Plugin type
- **enabled** (boolean) - Optional - Enable/disable the plugin on installation
- **name** (string) - Required - Name of plugin
- **version** (number) - Required - Plugin version
- **script** (string) - Optional - Plugin script
- **meta** (object) - Optional - Plugin meta object
- **prescript** (object) - Optional - Plugin prescript object. Valid keys: install, run
- **postscript** (object) - Optional - Plugin postscript object. Valid keys: run
- **icon** (string) - Optional - Plugin icon url
- **documentation** (string) - Optional - Plugin markdown documentation
- **url** (string) - Optional - Plugin url
- **bio** (string) - Optional - Plugin simplified bio
- **logo** (string) - Optional - Plugin logo url
- **description** (string) - Optional - Plugin long description
- **author** (string) - Required - Plugin author
- **admin_view** (string) - Optional - Plugin admin_view
- **web_view** (string) - Optional - Plugin web_view

### Response
#### Success Response (200)
- **name** (string) - Name of plugin
- **version** (number) - Plugin version
- **author** (string) - Plugin author
- **enabled** (boolean) - Plugin enabled status
- **description** (string) - Plugin description
- **bio** (string) - Plugin bio
- **public_meta** (object) - Plugin public_meta
- **web_view** (string) - Plugin web_view
- **updated_at** (string) - Timestamp of update
- **created_at** (string) - Timestamp of creation
- **documentation** (string) - Plugin documentation
- **logo** (string) - Plugin logo
- **icon** (string) - Plugin icon
- **url** (string) - Plugin url
- **enabled_admin_view** (boolean) - Admin view status
```

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

### Kit Configuration Structure

Source: https://docs.hollaex.com/plugins/develop-plugins/advanced/advanced-tutorial-using-the-user-meta-field.md

Example of how the user meta field appears within the Kit configuration object.

```json
// KIT CONFIG

{
    ...,
    "user_meta": {
        "trade_count_plugin-latest_trade": {
            "type": "date-time",
            "required": false,
            "description": "Last trade timestamp used for trade-count plugin"
        }
    },
    ...
}
```

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

### Define Plugin Strings

Source: https://docs.hollaex.com/plugins/develop-plugins/web-view-development/getting-started.md

Example structure for the strings.json file to define localized strings.

```json
{
  "en": {
    "title": "Hello exchange"
  }
}
```

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

### Example config.json structure

Source: https://docs.hollaex.com/plugins/develop-plugins/advanced/config.md

A template showing the required fields and object structure for a plugin configuration file.

```json
{
	"name": "Plugin Name",
	"version": 1,
	"type": null,
	"author": "Author",
	"bio": "Short description shown in admin panel",
	"description": "Description shown on plugin page",
	"documentation": null,
	"logo": null,
	"icon": null,
	"url": null,
	"public_meta": {
		"public_value": {
			...
		}
	},
	"meta": {
		"private_value": {
			...
		}
	},
	"prescript": {
		"install": ["hello-world-npm"],
		"run": null
	},
	"postscript": {
		"run": null
	}
}
```

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

### Git Configuration Hint

Source: https://docs.hollaex.com/get-started/cli-how-tos/upgrade-exchange.md

Example output provided by Git when divergent branches require a reconciliation strategy.

```text
hint: You have divergent branches and need to specify how to reconcile them.
hint: You can do so by running one of the following commands sometime before
hint: your next pull:
hint:
hint:   git config pull.rebase false  # merge
hint:   git config pull.rebase true   # rebase
hint:   git config pull.ff only       # fast-forward only
hint:
hint: You can replace "git config" with "git config --global" to set a default
hint: preference for all repositories. You can also pass --rebase, --no-rebase,
hint: or --ff-only on the command line to override the configured default per
hint: invocation.
```

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

### Serve web view bundles

Source: https://docs.hollaex.com/plugins/develop-plugins/web-view-development/advanced-tutorial-kyc-plugin-web-views.md

Run this command in the plugin starter kit web directory to watch and serve bundles.

```bash
npm start --plugin=kyc
```

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

### Initialize Exchange Server

Source: https://docs.hollaex.com/get-started/on-premise-exchange-setup/setup.md

Run this command to begin the setup process, which includes network selection and account authentication.

```bash
hollaex server --setup
```

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

### Initialize hello-plugin

Source: https://docs.hollaex.com/plugins/develop-plugins/development-walkthrough-hello-plugin/initialization.md

Run the npm command to scaffold the hello-plugin directory with the specified type.

```bash
npm run add:plugin --plugin=hello-plugin --type=page
```

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

### Stop the exchange server

Source: https://docs.hollaex.com/get-started/cli-how-tos/stop-exchange.md

Stops the exchange server that was previously started with the start command.

```bash
hollaex server --stop
```

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

### Initialize KYC plugin web view

Source: https://docs.hollaex.com/plugins/develop-plugins/web-view-development/advanced-tutorial-kyc-plugin-web-views.md

Run these commands in the web directory to initialize the plugin structure.

```bash
cd web/
npm run add-plugin --plugin=kyc --type=kyc
```

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

### Install HollaEx Node Library

Source: https://docs.hollaex.com/developers/api-guide.md

Command to install the required npm package for HollaEx API interaction.

```bash
npm install hollaex-node-lib
```

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

### Initialize KYC Plugin Components

Source: https://docs.hollaex.com/plugins/develop-plugins/web-view-development/advanced-tutorial-kyc-plugin-web-views.md

Create the necessary directory structure and component files for the KYC plugin.

```bash
mkdir src/plugins/kyc/views/home/components
touch src/plugins/kyc/views/home/components/Documents.js
touch src/plugins/kyc/views/home/components/Identity.js
```

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

### Stop the exchange web server

Source: https://docs.hollaex.com/get-started/cli-how-tos/stop-exchange.md

Stops the exchange web server that was previously started with the web start command.

```bash
hollaex web --stop
```

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

### Initialize the web client

Source: https://docs.hollaex.com/get-started/on-premise-exchange-setup/web-setup.md

Builds the web client Docker image and performs initialization tasks.

```bash
hollaex web --setup
```

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

### Generated Fees Output Example

Source: https://docs.hollaex.com/advanced/the-network-tool-library/getting-more-interesting-orders-with-the-tools/settling-fees.md

Example JSON output returned by the getGeneratedFees command showing fee details for USDT and XHT.

```javascript
       //generated fees for USDT
    [ { id: 70,
       transaction_id: '60014cde-aff0-455a-9068-ca0d0f5e6e6a',
       amount: 0.003312,
       currency: 'usdt',
       network_fee: 0.003312,
       trade_id: 330100,
       timestamp: '2022-06-27T17:48:17.884Z',
       exchange_id: 935,
       user_id: 2228 }, //this is where these fees have gone 
       
       //generated fees for XHT
     { id: 71,
       transaction_id: '78c16133-abba-4e84-a48c-afc29c3f4afc',
       amount: 0.003,
       currency: 'xht',
       network_fee: 0.003,
       trade_id: 330100,
       timestamp: '2022-06-27T17:48:17.884Z',
       exchange_id: 935,
       user_id: 2228 } ] }
```

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

### Initialize Verification Component Files

Source: https://docs.hollaex.com/plugins/develop-plugins/web-view-development/advanced-tutorial-kyc-plugin-web-views.md

Use these shell commands to create the necessary directory structure and files for the KYC verification components.

```bash
mkdir src/plugins/kyc/views/verification/components
touch src/plugins/kyc/views/verification/components/Documents.js
touch src/plugins/kyc/views/verification/components/Identity.js
touch src/plugins/kyc/views/verification/components/HeaderSection.js
```

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

### GET /logout

Source: https://docs.hollaex.com/developers/build-a-new-front-end-interface.md

Logs out the user session.

```APIDOC
## GET /logout

### Description
Logs out the current user session. Requires an Authorization header.

### Method
GET

### Endpoint
/logout
```

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

### GET /plugins/cmc/orderbook

Source: https://docs.hollaex.com/plugins/use-plugins/coinmarketcap-market-data-integration.md

Retrieves the orderbook data for the exchange.

```APIDOC
## GET /plugins/cmc/orderbook

### Description
Retrieves the orderbook data for the exchange.

### Method
GET

### Endpoint
<yourexchange_api_url>/plugins/cmc/orderbook
```

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

### GET /plugins/cobo/health

Source: https://docs.hollaex.com/plugins/use-plugins/cobo-wallet-custody-integration-waas-2.0.md

Checks the health status of the Cobo plugin.

```APIDOC
## GET /plugins/cobo/health

### Description
Returns the health status of the Cobo plugin integration.

### Method
GET

### Endpoint
/plugins/cobo/health

### Request Example
GET https://<your exchange url>/plugins/cobo/health
```

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

### GET /plugins/cmc/trades

Source: https://docs.hollaex.com/plugins/use-plugins/coinmarketcap-market-data-integration.md

Retrieves recent trade data from the exchange.

```APIDOC
## GET /plugins/cmc/trades

### Description
Retrieves recent trade data from the exchange.

### Method
GET

### Endpoint
<yourexchange_api_url>/plugins/cmc/trades
```

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

### init

Source: https://docs.hollaex.com/advanced/the-network-tool-library/functions.md

Initializes the Kit for the HollaEx Network. Requires an activation_code to be passed in the constructor.

```APIDOC
## init

### Description
Initialize your Kit for HollaEx Network. Must have passed activation_code in constructor.

### Parameters
- **opts** (Object) - Required - Object with additional params
- **opts.additionalHeaders** (Object) - Optional - Object containing additional headers to send with request
```

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

### GET /plugins/cmc/assets

Source: https://docs.hollaex.com/plugins/use-plugins/coinmarketcap-market-data-integration.md

Retrieves the list of assets available on the exchange.

```APIDOC
## GET /plugins/cmc/assets

### Description
Retrieves the list of assets available on the exchange.

### Method
GET

### Endpoint
<yourexchange_api_url>/plugins/cmc/assets
```

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

### Build Initial Plugin

Source: https://docs.hollaex.com/plugins/develop-plugins/web-view-development/basic-tutorial-hello-exchange-plugin-web-view.md

Commands to build the plugin with a default view.

```bash
cd ..
npm run build --plugin=hello-exchange
```

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

### Initialize Plugin Web View

Source: https://docs.hollaex.com/plugins/develop-plugins/web-view-development/basic-tutorial-hello-exchange-plugin-web-view.md

Commands to initialize the plugin web view structure.

```bash
cd web/
npm run add-plugin --plugin=hello-exchange --type=page
```

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

### GET /verify

Source: https://docs.hollaex.com/developers/build-a-new-front-end-interface.md

Resends the email verification code to the user.

```APIDOC
## GET /verify

### Description
Resends the email verification code to the specified email address.

### Method
GET

### Endpoint
/verify

### Query Parameters
- **email** (string) - Required - User email address
- **resend** (boolean) - Required - Set to true to trigger resend
```

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

### Trade Data Response

Source: https://docs.hollaex.com/advanced/the-network-tool-library/functions/websocket.md

Example of a partial trade update payload.

```json
 {
 	"topic": "trade",
 	"action": "partial",
 	"symbol": "xht-usdt",
 	"data": [
 		{
 			"size": 0.012,
 			"price": 300,
 			"side": "buy",
 			"timestamp": "2020-12-15T07:25:28.887Z"
 		},
 		...
 	],
 	"time": 1608015328
 }
```

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

### Initialize a new plugin template

Source: https://docs.hollaex.com/plugins/develop-plugins/advanced/initialization.md

Run this command in the /plugins directory to generate the folder structure for a specific plugin type.

```bash
npm run add:plugin --plugin=<PLUGIN_NAME> --type=<PLUGIN_TYPE>
```

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

### Orderbook Data Response

Source: https://docs.hollaex.com/advanced/the-network-tool-library/functions/websocket.md

Example of a partial orderbook update payload.

```json
{
 	"topic": "orderbook",
 	"action": "partial",
 	"symbol": "xht-usdt",
 	"data": {
 		"bids": [
 			[0.1, 0.1],
 			...
 		],
 		"asks": [
 			[1, 1],
 			...
 		],
 		"timestamp": "2020-12-15T06:45:27.766Z"
 	},
 	"time": 1608015328
 }
```

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

### GET /plugins/cmc/tickers

Source: https://docs.hollaex.com/plugins/use-plugins/coinmarketcap-market-data-integration.md

Retrieves ticker information for trading pairs on the exchange.

```APIDOC
## GET /plugins/cmc/tickers

### Description
Retrieves ticker information for trading pairs on the exchange.

### Method
GET

### Endpoint
<yourexchange_api_url>/plugins/cmc/tickers
```

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

### Initialize Plugin Environment

Source: https://docs.hollaex.com/plugins/develop-plugins/simple-wallet-example.md

Commands to navigate to the plugins directory and initialize a new page-type plugin.

```jsx
cd plugins/
```

```jsx
npm run add:plugin --plugin=my-simple-wallet --type=page
```
Tokens:
Raw