NAV
Python cURL

Introduction

This is the documentation for the Areix API endpoints, which can get information in our database.

Authentication

To get the authentication token, use this code:

import requests

username = ''
refresh_token = ''
# auth_endpoint = 'https://ckj6sgs1dd.execute-api.ap-east-1.amazonaws.com/dev'
auth_endpoint = 'https://auth.areix-ai.com'

res = requests.put(auth_endpoint+"/refresh_token", json={'username': username, 'refresh_token': refresh_token})
id_token = res.json()['data']['id_token']
print(id_token)

To authorize, use this code:

import requests

id_token = ''
headers = {'Authorization': f"Bearer {id_token}"}

res = requests.get('https://api-dev.areix-ai.com/symbols/spot', headers=headers)
print(res.json())

# With shell, you can just pass the correct header with each request
curl "https://api-dev.areix-ai.com/symbols/spot" \
  -H "Authorization: Bearer id_token"

Make sure to replace refresh_token with the return from login API

You could use the below code to invoke all Areix apis:

import requests
from areixlib import get_logger

logger = get_logger('./xxxx.log')

username = ''
id_token = ''
refresh_token = ''
# auth_endpoint = 'https://ckj6sgs1dd.execute-api.ap-east-1.amazonaws.com/dev'
auth_endpoint = 'https://auth.areix-ai.com'

def query(url, method, headers=None, params=None, data=None, proxies=None, bypass=True):
  global id_token
  if bypass:
      try:
          decoded = jwt.decode(id_token, options={"verify_signature": False, "verify_aud": False, "exp": True})
          if time.time() - decoded['exp'] > 100 * 60:
              res = query(auth_endpoint+"/refresh_token", 'put', data={'username': username, 'refresh_token': refresh_token}, bypass=False)
              id_token = res['data']['id_token']
              logger.info('Token renewed')
      except Exception as e:
          logger.error(f"Fail to retrieve id token, will refersh: {e}")
          res = query(auth_endpoint+"/refresh_token", 'put', data={'username': username, 'refresh_token': refresh_token}, bypass=False)
          id_token = res['data']['id_token']
          logger.info('Token renewed')

      headers = {'Authorization': f"Bearer {id_token}"}
  try:
      resp = requests.request(
          method,
          url,
          headers=headers,
          params=params,
          json=data,
          proxies=proxies,
      )
      # Break if request failed with other status code
      status_code = resp.status_code
      if status_code // 100 != 2:
          if status_code == 504:
              time.sleep(3)
              res = query(url, method, headers, params, data, proxies, bypass)
              logger.info(f'Recall. {res}')
          try:
              logger.error(f"Failed to retrieve data. End Point:{url}. Status code: {status_code}. Msg: {resp.json()}")
          except:
              logger.error(f"Failed to retrieve data. End Point:{url}. Status code: {status_code}. Msg: {resp.text}")
          return {}
      else:
          if status_code == 204:
              data = {}
          else:
              data = resp.json()
              if not data:
                  msg = f"Data is empty"
                  logger.error(msg)
                  return {}
          return data
  except Exception as e:
      logger.exception(e)
      return {}

Areix uses Bearer token to allow access to the API

Areix expects for the id_token to be included in all API requests to the server in a header that looks like the following:

Authorization: Bearer id_token

Frontend Shows Binance Bybit Eqonex
Dated Futures Yes No Yes
Perpetual Yes Yes Yes
Inverse Perpetual Yes Yes No
Inverse Dated Futures Yes Yes No
Frontend Shows Binance Bybit Eqonex
Spot Yes Yes Yes
Saving / Earn No Yes No
Future Yes Yes Yes
Inverse Future Yes Yes No

OlaWealth Platform

endpoint:

TBC:

Get All Spot Symbols



Response:

{
    "data": {
        "BINANCE": {    // exchange
            "BTCUSDT": {   // symbol
                "asset_type": "SPOT",
                "exchange": "BINANCE",
                "extra": {},
                "history_data": true,
                "min_notional": 10.0,
                "min_volume": 1e-05,
                "name": "BTC/USDT",
                "pricetick": 0.01,
                "product": "spot",
                "quote_currency": "USDT",
                "symbol": "BTCUSDT"
            },
        },
        "BYBIT": {
            "BTCUSDT": {
                "asset_type": "SPOT",
                "exchange": "BYBIT",
                "extra": null,
                "history_data": null,
                "min_notional": 10.0,
                "min_volume": 1e-06,
                "name": "BTC/USDT",
                "pricetick": 0.01,
                "product": "spot",
                "quote_currency": "USDT",
                "symbol": "BTCUSDT"
            },
            ...
        }
    },
    "error": false,
    "msg": "return symbols",
    "success": true
}

This endpoint retrieves all symbols and related information from exchanges.

HTTP Request

GET /symbols/spot

Response Parameters

Parameter Type Description
asset_type String Possible values: "SPOT", "PERPETUAL", "DATED_FUTURE", "INVERSE_PERPETUAL", "INVERSE_DATED_FUTURE"
exchange String Possible values: "BINANCE", "BYBIT", "EQONEX"
instrument_id String The instrument identifier
history_data Boolean Historial data or not
min_notional Decimal Min notional
min_volume Decimal Min volumn
symbol String Trading pair
name String The name of crypto

Get All Supplement Spot Symbols



Response:

{
    "data": {
        "stable_coin": [
            "USDT",
            "BUSD",
            "USDC",
            "DAI",
            "UST",
            "USDD",
            "TUSD"
        ],
        "symbol_fullname": {
            "$CUFFIES": "Cuffies",
            "$DOGEALLY": "Doge Alliance",
            "$mart": "ArtMeta",
            "$mecha": "MechaChain",
            "0xBTC": "0xBitcoin",
            "1INCH": "1inch",
            "1WO": "1World",
            "AAC": "Acute Angle Cloud",
            "AAMMUSDC": "Aave AMM USDC",
            "AAVE": "Aave",
            "ABBC": "ABBC Coin",
            ...
            "BABYDOGE": "Save Baby Doge",
            "BAC": "Basis Cash",
            "BADGER": "Badger DAO",
            "BAL": "Balancer",
            "BANCA": "Banca",
            "BAND": "Band Protocol",
            "BANK": "Bankless DAO",
            "BAO": "BAO token",
            ...
        },
        "symbol_icon": {
            "$PAC": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/$pac.png",
            "0XBTC": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/0xbtc.png",
            "2GIVE": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/2give.png",
            "AAVE": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/aave.png",
            "ABT": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/abt.png",
            "ACT": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/act.png",
            "ACTN": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/actn.png",
            "ADA": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/ada.png",
            "ADD": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/add.png",
            "ADX": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/adx.png",
            "AE": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/ae.png",
            "AEON": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/aeon.png",
            "AEUR": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/aeur.png",
            "AGI": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/agi.png",
            "AGRS": "https://areix.s3.ap-east-1.amazonaws.com/crypto_icons/agrs.png",
            ...
        }
    },
    "error": false,
    "msg": "return symbols",
    "success": true
}

This endpoint retrieves all supplement symbols name and image from crypto.

HTTP Request

GET /symbols/spot-supp

Response Parameters

Parameter Type Description
stable_coin String Possible values: "USDT", "BUSD", "USDC", "DAI", "TUSD"
symbol_fullname String The full name of symbol
symbol_icon String The symbol icon picture

Get All Exchanges



Response:

{
    "data": {
        "BINANCE": {
            "commission_scheme": {
                "discount": {
                    "maker_fee": 0.00075,
                    "required": "BNB/USDT",
                    "taker_fee": 0.00075
                },
                "maker_fee": 0.001,
                "taker_fee": 0.001
            },
            "exchanges": "BINANCE",
            "interval": {
                "12h": "12h",
                "15m": "15m",
                "1M": "1M",
                "1d": "1d",
                "1h": "1h",
                "1m": "1m",
                "1w": "1w",
                "2h": "2h",
                "30m": "30m",
                "3d": "3d",
                "3m": "3m",
                "4h": "4h",
                "5m": "5m",
                "6h": "6h",
                "8h": "8h"
            },
            "order_types": [
                "LIMIT",
                "LIMIT_MAKER",
                "MARKET",
                "STOP_LOSS",
                "STOP_LOSS_LIMIT",
                "TAKE_PROFIT",
                "TAKE_PROFIT_LIMIT",
                "OCO"
            ],
            ...
    },
    "error": false,
    "msg": "return symbols",
    "success": true
}

This endpoint return all crypto exchanges

HTTP Request

GET /exchanges

Response Parameters

Parameter Type Description
exchange String Possible values: "BINANCE", "BYBIT", "EQONEX"
interval String Time Interval
order_types String Possible values: "MARKET", "LIMIT", "STOP_LIMIT", "STOP_LOSS"
maker_fee Decimal Maker commission
taker_fee Decimal Taker commission

Get All Derivatives Symbols



Response:

{
    "data": {
        "BINANCE": {
            "1000LUNCBUSD": {
                "asset_type": "PERPETUAL",
                "exchange": "BINANCE",
                "extra": {},
                "history_data": true,
                "min_notional": 1.0,
                "min_volume": 1.0,
                "name": "1000LUNCBUSD",
                "pricetick": 0.0001,
                "product": "future",
                "quote_currency": "BUSD",
                "symbol": "1000LUNCBUSD"
            },
            ...
    },
    "error": false,
    "msg": "return symbols",
    "success": true
}

This endpoint return all crypto derivatives symbol

HTTP Request

GET /symbols/derivative

Response Parameters

Parameter Type Description
asset_type String Possible values: "PERPETUAL", "DATED_FUTURE", "INVERSE_PERPETUAL", "INVERSE_DATED_FUTURE"
exchange String Possible values: "BINANCE", "BYBIT", "EQONEX"
instrument_id String The instrument identifier
history_data Boolean Historial data or not
min_notional Decimal Min notional
min_volume Decimal Min volumn
name String The name of crypto
symbol String Trading pair

Get All Open Orders


Response:

{
    "data": [
        {
            "asset_type": "SPOT",
            "datetime": "2022-06-29 07:32:07.921000+08:00",
            "exchange": "BYBIT",
            "executed_quantity": "0",
            "name": "BTC/USDT",
            "order_id": "x-220629-153207814-00001",
            "ori_order_id": "1189101356575748096",
            "price": 10000.0,
            "quantity": 0.0005,
            "side": "BUY",
            "status": "NEW",
            "symbol": "BTCUSDT",
            "type": "LIMIT"
        },
        ....
    ],
    "error": false,
    "msg": "Open order fetch succeed.",
    "success": true
}

This endpoint return all user current open orders

HTTP Request

GET /orders/<psid>?exchange=<exchange>&asset_type=<asset_type>

URL Parameters

Parameter Description
psid The user unique identifier

Query Parameters

Parameter Description
exchange Possible values: "BINANCE", "BYBIT", "EQONEX"
asset_type Possible values: "SPOT", "FUTURE", "INVERSE_FUTURE"

Response Parameters

Parameter Type Description
exchange String Possible values: "BINANCE", "BYBIT", "EQONEX"
asset_type String Possible values: "SPOT", "FUTURE", "INVERSE_FUTURE"
datetime Datetime The order date and time
executed_quantity Decimal Order Executed Quantity
order_id String Order Identifier
price Decimal Order Price
quantity Decimal Order Quantity
side Enum Buy/sell direction: SELL, BUY
type Enum Order Type: LIMIT (Only support LIMIT)
symbol String Trading pair

Exchange Account Status

Response:

{
    "data": [
        {
            "account_id": "binance254737492",
            "connection_id": "binance82551253753",
            "status": "active",
            "updated_at": "2022-07-04 15:01:05.161494+08:00"
        },
        {
            "account_id": "bybit3214541447260",
            "connection_id": "bybit2433710347775",
            "status": "active",
            "updated_at": "2022-07-04 16:26:50.016547+08:00"
        }
    ],
    "error": false,
    "msg": "",
    "success": true
}

This endpoint return user account status.

HTTP Request

GET /exchange/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Response Parameters

Parameter Type Description
account_id String The account unique identifier
connection_id String The connction unique identifier
status String Possible values: "active"
updated_at Time The updated time

Exchange Account Login

Payload:

{
    "key":"key",
    "secret":"secret"
}

Response:

{
    "error": false,
    "success": true,
    "data": None,
    "msg": "Account setup succeed."
}

This endpoint login user crypto exchange account.

HTTP Request

POST /exchange/<exchange>/<psid>

URL Parameters

Parameter Description
psid The user unique identifier
exchange Possible values: "binance", "bybit", "eqonex"

Data Parameters

Parameter Required Description
key true User crypto exchange account API key
secret true User crypto exchange account API secret
userid false This field is only available for eqonex

Exchange Account Logout

Response:


This endpoint logout user crypto exchange account.

HTTP Request

DELETE /exchange/<exchange>/<psid>

URL Parameters

Parameter Description
psid The user unique identifier
exchange Possible values: "binance", "bybit", "eqonex"

Response Parameters

Parameter Description

All Exchange Account Logout

Response:

{
    "data": null,
    "error": false,
    "msg": "You've successfully logout connection - bybit2433710347775",
    "success": true
}

This endpoint logout user all crypto exchange account.

HTTP Request

DELETE /exchange/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Exchange Renew

Payload:

{
    "key":"key",
    "secret":"secret"
}

Response:

{
    "error": false,
    "success": true,
    "data": None,
    "msg": "Account renew succeed."
}

This endpoint renew crypto exchange.

HTTP Request

PUT /exchange/<exchange>/<psid>

URL Parameters

Parameter Description
psid The user unique identifier
exchange Possible values: "binance", "bybit", "eqonex"

Data Parameters

Parameter Required Description
key true User crypto exchange account API key
secret true User crypto exchange account API secret
userid false This field is only available for eqonex

Get Open Order

Response:

{
    "data": [],
    "error": false,
    "msg": "Open order fetch succeed.",
    "success": true
}

This endpoint get all open orders

HTTP Request

GET /orders/<psid>?exchange=<exchange>&asset_type=<asset_type>

URL Parameters

Parameter Description
psid The user unique identifier

Query Parameters

Parameter Description
exchange Possible values: "BINANCE", "BYBIT", "EQONEX"
asset_type Possible values: "SPOT", "FUTURE", "INVERSE_FUTURE"

Get Trade

Response:

{
    "data": [
        {
            "asset_type": "PERPETUAL",
            "commission": 0.11378,
            "commission_asset": "USDT",
            "datetime": "2022-07-05 07:19:47.898000+08:00",
            "exchange": "BYBIT",
            "name": "BTCUSDT",
            "order_id": "",
            "ori_order_id": "7a9a5454-c04d-4411-a0f4-c2e375227cd4",
            "price": 20300.0,
            "quantity": 0.056,
            "reix_bonus": 0,
            "side": "Sell",
            "symbol": "BTCUSDT"
        },
        ...
    ],
    "error": false,
    "msg": "Trades fetch succeed.",
    "success": true`
}

This endpoint get all trade

HTTP Request

GET /trades/<psid>?exchange=<exchange>&asset_type=<asset_type>

URL Parameters

Parameter Description
psid The user unique identifier

Query Parameters

Parameter Description
exchange Possible values: "BINANCE", "BYBIT", "EQONEX"
asset_type Possible values: "SPOT", "FUTURE", "INVERSE_FUTURE"

Response Parameters

Parameter Type Description
asset_type String Possible values: "PERPETUAL", "DATED_FUTURE", "INVERSE_PERPETUAL", "INVERSE_DATED_FUTURE"
exchange String Possible values: "BINANCE", "BYBIT", "EQONEX"
commission Decimal Commission
name String The name of crypto
datetime Datetime The order date and time
order_id String Order Identifier
price Decimal Order Price
reix_bonus Decimal Reix Bonus
side Enum Buy/sell direction: SELL, BUY
symbol String Trading pair

Get Account

Response:

{
    "data": [
        {
            "asset_type": "SPOT",
            "available": 11161.203308,
            "balance": 11170.811948,
            "exchange": "EQONEX",
            "frozen": 9.608640000000001,
            "market_value": 11170.811948,
            "symbol": "USDC"
        },
        .....
    ],
    "error": false,
    "msg": "Account fetch succeed.",
    "success": true
}

This endpoint get all account

HTTP Request

GET /account/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Query Parameters

Parameter Description
exchange Possible values: "BINANCE", "BYBIT", "EQONEX"
asset_type Possible values: "SPOT", "FUTURE", "INVERSE_FUTURE"

Response Parameters

Parameter Type Description
asset_type String Possible values: "PERPETUAL", "DATED_FUTURE", "INVERSE_PERPETUAL", "INVERSE_DATED_FUTURE"
exchange String Possible values: "BINANCE", "BYBIT", "EQONEX"
symbol String Trading pair

Get Position

Response:

{
    "data": [
        {
            "asset_type": "PERPETUAL",
            "auto_add_margin": false,
            "bust_price": null,
            "entry_price": 40970.9,
            "initial_margin": null,
            "is_isolated": false,
            "leverage": 0.09,
            "liq_price": null,
            "maintenance_margin": null,
            "name": "BTCUSDC",
            "position_margin": 176.77,
            "position_value": 270.14,
            "realised_pnl": 2.99,
            "side": "SHORT",
            "size": 0.0003,
            "symbol": "BTC/USDC[F]",
            "unrealised_pnl": -3.97
        },
        {
            "asset_type": "DATED_FUTURE",
            "auto_add_margin": false,
            "bust_price": null,
            "entry_price": 36915.1,
            "initial_margin": null,
            "is_isolated": false,
            "leverage": 0.09,
            "liq_price": null,
            "maintenance_margin": null,
            "name": "BTCUSDC221230",
            "position_margin": 176.77,
            "position_value": 270.14,
            "realised_pnl": 0.0,
            "side": "LONG",
            "size": 0.0006,
            "symbol": "BTC/USDC[221230]",
            "unrealised_pnl": -3.97
        }
    ],
    "error": false,
    "msg": "Position fetch succeed.",
    "success": true
}

This endpoint get all position

HTTP Request

GET /position/<psid>?exchange=<exchange>&asset_type=<asset_type>

URL Parameters

Parameter Description
psid The user unique identifier

Query Parameters

Parameter Description
exchange Possible values: "BINANCE", "BYBIT", "EQONEX"
asset_type Possible values: "SPOT", "FUTURE", "INVERSE_FUTURE"

Response Parameters

Parameter Type Description
asset_type String Possible values: "PERPETUAL", "DATED_FUTURE", "INVERSE_PERPETUAL", "INVERSE_DATED_FUTURE"
auto_add_margin Boolean Add auto margin or not
entry_price Decimal The price at which an investor buys or sells
initial_margin Decimal The margin ratio in initial
maintenance_margin Decimal Maintenance Margin Ratio
liq_price Decimal Liquid Price
is_isolated Boolean Be isolated or not
leverage Decimal The rate of exposure increasing to the market
position_margin Decimal Position Margin Ratio
position_value Decimal Position Value
side Enum Direction: long, short
symbol String Trading pair
name String The name of crypto

Place Orders

Payload:

{
    "symbol":"ETHUSD",
    "quantity":10.0,
    "side":"buy",
    "order_type":"LIMIT",
    "price":2800.1,
    "asset_type": "inverse_future",
    "leverage": "5.0",
    "is_isolated": "true",
    "reduce_only" : "false",
    "is_signal_exec" : "false",
    "source_id" : "348444",
    "signal_id" : "9355295527818",
    "source" : "follow"
}

Response:


This endpoint place order

HTTP Request

POST /order/<exchange>/<psid>

URL Parameters

Parameter Description
psid The user unique identifier
exchange Possible values: "binance", "bybit", "eqonex"

Data Parameters

Parameter Reqiure Description
symbol True Trading pair
quantity True Order Quantity
side True Buy/sell direction: SELL, BUY
order_type True The type of order
price True Order Price
asset_type True The type of asset
leverage True Leverage
is_isolated True Be isolated or not
reduce_only True Only reduce
is_signal_exec True Exceuted signal or not
source_id False The sourece identifier
signal_id False The signal identifier
source False Follow or Normal

Cancel Orders

Payload:

{
    "symbol": "BTC/USDC",
    "order_id": "4417744522",
    "asset_type": "SPOT"
}

Response:


This endpoint cancel order

HTTP Request

DELETE /order/<exchange>/<psid>

URL Parameters

Parameter Description
psid The user unique identifier
exchange Possible values: "binance", "bybit", "eqonex"

Data Parameters

Parameter Reqiure Description
symbol True Trading pair
order_id True The order identifier
asset_type True The type of asset

User

Response:

{
    "data": {
        "account_data": [
            {
                "avg_open_price": 1.976,
                "is_still_open": false,
                "net_investment": 458.995376,
                "net_position": -12.7,
                "realized_pnl": 372.505424,
                "symbol": "ADA",
                "total_commission": 0.11741201,
                "total_pnl": 372.505424,
                "unrealized_pnl": 0.0
            },
            ...
        ],
        "balance_by_day": {
            "aggregated": {}
        },
        "followers": {
            "687173": {
                "amount": {
                    "Binance": 100.0
                },
                "followed_at": "2022-06-26 17:31:55.812370+08:00",
                "is_approved": true,
                "proportion": {
                    "binance": 889.6
                },
                "user_code": "687173"
            },
            ...
        },
        "following": {
            "824705": {
                "amount": {
                    "Binance": 100.0
                },
                "followed_at": "2022-06-28 01:32:31.610972+08:00",
                "is_approved": true,
                "proportion": {
                    "binance": 9.69
                },
                "user_code": "824705"
            },
            ...
        },
        "inception_date": "2022-07-05",
        "model_subscriptions": {
            "tmm423578397": {
                "amount": {
                    "Binance": 100.0
                },
                "followed_at": "2022-07-02 22:50:05.801102+08:00",
                "model_id": "tmm423578397",
                "proportion": {
                    "binance": 2615.54
                }
            },
            ...
        },
        "performance": {
            "annualized_return": null,
            "annualized_volatility": null,
            "avg_annualy_pnl": 0.0,
            "avg_annualy_pnl($)": 0.0,
            "avg_daily_pnl": 0.0,
            "avg_daily_pnl($)": 0.0,
            "avg_daily_trades": 1.02,
            "avg_monthly_pnl": 0.0,
            "avg_monthly_pnl($)": 0.0,
            "avg_monthly_trades": 21.21,
            "avg_quarterly_pnl": 0.0,
            "avg_quarterly_pnl($)": 0.0,
            "avg_weekly_pnl": 0.0,
            "avg_weekly_pnl($)": 0.0,
            "avg_weekly_trades": 5.07,
            "ending_balance": 0.0,
            "gross_loss": 0.0,
            "gross_profit": 0.0,
            "loss_days": 0.0,
            "max_consecutive_loss_days": 0.0,
            "max_consecutive_win_days": 0.0,
            "max_drawdown": 0.0,
            "max_drawdown_duration": null,
            "max_drawdown_period": [],
            "max_loss_in_day": 0.0,
            "max_return": 0.0,
            "max_win_in_day": 0.0,
            "min_return": 0.0,
            "number_trades": 806.0,
            "profit_factor": 0.0,
            "sharpe_ratio": null,
            "total_commission": 424.22210478497,
            "total_net_profit": 0.0,
            "total_return": 0.0,
            "win_days": 0.0
        },
        "position_by_day": {
            "aggregated": {}
        },
        "psid": "dc80b547-fab1-11eb-bd86-1d8712ff722d",
        "reix_bonus": null,
        "status": "ola_plus",
        "user_code": "687173"
    },
    "error": false,
    "msg": "",
    "success": true
}

This endpoint return user all information.

HTTP Request

GET /user/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Response Parameters

Parameter Type Description
psid String The user unique identifier
usercode String The user identify code
account_data String The account trading detail
followers String The follower status and features
avg_open_price Decimal Average Open Price
is_still_open Boolean Open or not
net_investment Decimal The net investment amount
net_position Decimal The net position
realized_pnl Decimal Realized Profit and Loss
symbol String Trading pair
total_commission Decimal Total Commission
total_pnl Decimal The total profit and loss
unrealized_pnl Decimal Unrealized profit and loss
is_approve Boolean Is approve to follow or not
followed_at Datetime Following date and time
user_code String The user identify code
total_pnl Decimal The total profit and loss
performance Dict User Performance
annualized_return Decimal Return in over a year
annualized_volatility Decimal The volatility in over a year
avg_annualy_pnl Decimal Annual Average Profit and Loss
avg_daily_pnl Decimal Daily Average Profit and Loss
avg_weekly_pnl Decimal Weekly Average Profit and Loss
avg_monthly_pnl Decimal Monthly Average Profit and Loss
avg_quarterly_pnl Decimal Quarterly Average Profit and Loss
avg_daily_trades Decimal Average Daily Trades
avg_weekly_trades Decimal Average Weekly Trades
avg_monthly_trades Decimal Average Monthly Trades
ending_balance Decimal Account ending balance
gross_loss Decimal Total Loss
gross_profit Decimal Total Profit
max_consecutive_loss_days Decimal Max Consecutive Loss by day
max_consecutive_win_days Decimal Max Consecutive Win by day
max_drawdown Decimal Max Drawdown Amount
max_drawdown_duration Decimal Max Drawdown Duration
max_loss_in_day Decimal Max Loss in day
max_return Decimal Max Return of completed tradw
max_win_in_day Decimal Max Win in day
min_return Decimal Min Return of completed tradw
number_trades Decimal The number of trade

Backtest

Response:

{
    {
    "data": {
        "additional_capitals": {},
        "alpha": -0.69292,
        "annualized_return": -0.706116,
        "annualized_volatility": 0.494821,
        "available_balance": 91.403344,
        "avg_annualy_pnl": null,
        "avg_annualy_pnl($)": null,
        "avg_daily_pnl": -0.003007,
        "avg_daily_pnl($)": -0.324,
        "avg_daily_risk_score": 2.31,
        "avg_daily_trades": 0.56,
        "avg_losing_trades_pnl": -4.104,
        "avg_monthly_pnl": 0.019518,
        "avg_monthly_pnl($)": 1.7842,
        "avg_monthly_trades": 5.0,
        "avg_profit_per_trade": -0.041,
        "avg_profit_per_trade($)": -4.104,
        "avg_quarterly_pnl": 0.019518,
        "avg_quarterly_pnl($)": 1.7842,
        "avg_risk_score_past_7days": 3.0,
        "avg_weekly_pnl": 0.007517,
        "avg_weekly_pnl($)": 0.5979,
        "avg_weekly_trades": 1.67,
        "avg_winning_trades_pnl": 0.0,
        "base_currency": "USDT",
        "beginning_balance": 100.0,
        "benchmark": "BTC/USDT",
        "beta": -0.088275,
        "calmar_ratio": -5.413132,
        "capital": 100.0,
        "daily_changes": {
            "2022-06-14 00:00:00": 0.0,
            "2022-06-15 00:00:00": 0.0,
            "2022-06-16 00:00:00": 0.0,
            "2022-06-17 00:00:00": 0.0,
            "2022-06-18 00:00:00": 0.0,
            "2022-06-19 00:00:00": 0.0,
            "2022-06-20 00:00:00": -0.08597,
            "2022-06-21 00:00:00": 0.0,
            ...
        },
        "downside_risk": 0.4008,
        "duration": "21 days 00:00:00",
        "end": "2022-07-04 08:00:00+08:00",
        "ending_balance": 93.19702,
        "expected_value": -4.104,
        "frequently_traded": [
            {
                "asset_type": "PERPETUAL",
                "avg_loss": -0.0414,
                "avg_profit": 0.0,
                "number_trades": 4,
                "profitable": 0.0,
                "symbol": "ETHUSDT"
            },
            {
                "asset_type": "INVERSE_PERPETUAL",
                "avg_loss": 0,
                "avg_profit": 0,
                "number_trades": 1,
                "profitable": 0,
                "symbol": "BTCUSD"
            }
        ],
        "gross_loss": -14.1042,
        "gross_profit": 7.3012,
        "gross_trades_loss": -8.208,
        "gross_trades_profit": 0.0,
        "holding_values": 1.79367,
        "information_ratio": 0.024136,
        "interval": "1d",
        "largest_loss_losing_trade": -6.3495,
        "largest_profit_winning_trade": null,
        "loss_days": 4,
        "loss_ratio": 1.0,
        "max_consecutive_loss_days": 3,
        "max_consecutive_win_days": 2,
        "max_drawdown": 0.130445,
        "max_drawdown_duration": "14 days 00:00:00",
        "max_drawdown_period": [
            "2022-06-18 08:00:00+08:00",
            "2022-07-02 08:00:00+08:00"
        ],
        "max_loss_in_day": -8.5967,
        "max_return": 0.0,
        "max_win_in_day": 5.8144,
        "min_return": -0.130445,
        "monthly_avg_risk_score": {
            "2022-06-30 08:00:00": 2.13,
            "2022-07-04 08:00:00": 3.08
        },
        "monthly_changes": {
            "2022-06-29 08:00:00": 0.0,
            "2022-07-04 08:00:00": 0.00794
        },
        "net_investment": 126.0,
        "number_closed_trades": 2,
        "number_losing_trades": 2,
        "number_trades": 5,
        "number_winning_trades": 0,
        "omega_ratio": 0.567989,
        "past_24hr_apr": 24.2871,
        "past_24hr_pnl": 5.8144,
        "past_24hr_roi": 0.06654,
        "pnl": [
            {
                "assets_value": 91.40334,
                "available_balance": 91.40334,
                "benchmark": -0.07741,
                "benchmark_pct": 0.08451,
                "datetime": "2022-06-19 08:00:00+08:00",
                "holding_value": 0.0,
                "pct_returns": -0.08597,
                "pnl_cumsum": -8.59666,
                "pnl_net": -8.59666,
                "pnl_net_pct_returns": 0.0,
                "position_count": 0,
                "positions": [
                    {
                        "aio_position_id": "ETHUSDT|BYBIT|SHORT",
                        "aio_symbol": "ETHUSDT|BYBIT",
                        "asset_type": "PERPETUAL",
                        "avg_price": 1058.6,
                        "code": "ETHUSDT",
                        "created_at": "2022-06-19 08:00:00+08:00",
                        "exchange": "BYBIT",
                        "initial_margin": 0.0,
                        "is_open": false,
                        "latest_price": 0.0,
                        "leverage": 1,
                        "liq_price": 0.0,
                        "maintenance_margin": 0.0,
                        "market_value": 0.0,
                        "net_investment": 95.274,
                        "notional_value": 0.0,
                        "pnl": -8.208,
                        "position_margin": 0.0,
                        "quantity": 0.0,
                        "realized_pnl": -8.208,
                        "side": "SHORT",
                        "symbol": "ETHUSDT",
                        "total_commission": 0.388656,
                        "unrealized_pnl": 0.0,
                        "updated_at": "2022-06-19 08:00:00+08:00",
                        "weight": 0.0,
                        "weight_wo_cash": 0.0
                    }
                ],
                "risk_scores": 3.72,
                "total_commission": 0.0,
                "total_net_investment": 0.0,
                "total_pnl": 0.0,
                "total_realized_pnl": 0.0,
                "total_unrealized_pnl": 0.0
            },
            ...
        ] 
    }
    "error": false,
    "msg": "",
    "success": true

}

This endpoint return backtesting trading details

HTTP Request

GET /backtest/<model_id>

URL Parameters

Parameter Description
model_id The model unique identifier

Response Parameters

Parameter Type Description
asset_type String Possible values: "SPOT", "PERPETUAL", "DATED_FUTURE", "INVERSE_PERPETUAL", "INVERSE_DATED_FUTURE"
exchange String Possible values: "BINANCE", "BYBIT", "EQONEX"
avg_annualy_pnl Decimal Annual average profit and loss
is_open Boolean Open or not
net_investment Decimal The net investment amount
net_position Decimal The net position
duration String Length of trading time
datetime Time The order date and time
executed_quantity Decimal Order Executed Quantity
order_id List Order Identifier
price Decimal Order Price
quantity Decimal Order Quantity
type Enum Order Type: LIMIT (Only support LIMIT)
annualized_return Decimal Return in over a year
annualized_volatility Decimal The volatility in over a year
available_balance Decimal Account available balance
avg_annualy_pnl Decimal Annual Average Profit and Loss
avg_daily_pnl Decimal Daily Average Profit and Loss
avg_weekly_pnl Decimal Weekly Average Profit and Loss
avg_monthly_pnl Decimal Monthly Average Profit and Loss
avg_quarterly_pnl Decimal Quarterly Average Profit and Loss
avg_daily_trades Decimal Average Daily Trades
avg_weekly_trades Decimal Average Weekly Trades
avg_monthly_trades Decimal Average Monthly Trades
base_currency String Base asset type
beginning_balance Decimal Account beginning balance
ending_balance Decimal Account ending balance
calmar_ratio Decimal risk-adjusted returns ratio
gross_loss Decimal Total Loss
gross_profit Decimal Total Profit
max_consecutive_loss_days Decimal Max Consecutive Loss by day
max_consecutive_win_days Decimal Max Consecutive Win by day
max_drawdown Decimal Max Drawdown Amount
max_drawdown_duration Decimal Max Drawdown Duration
max_loss_in_day Decimal Max Loss in day
max_return Decimal Max Return of completed tradw
max_win_in_day Decimal Max Win in day
min_return Decimal Min Return of completed tradw
number_trades Decimal The number of trade
initial_margin Decimal The margin ratio in initial
maintenance_margin Decimal Maintenance Margin Ratio
unrealized_pnl Decimal Unrealized profit and loss
realized_pnl Decimal Realized profit and loss
is_open Boolean Open or not
updated_at Datetime The update time
liq_price Decimal Liquid Price
is_isolated Boolean Be isolated or not
leverage Decimal The rate of exposure increasing to the market
position_margin Decimal Position Margin Ratio
position_value Decimal Position Value
side Enum Direction: long, short
symbol String Trading pair
risk_score Decimal The score of model risk

Models

Response:

{
    "data": [
        {
            "annualized_volatility": 3.14351990011395,
            "base_currency": "USDT",
            "exchanges": [
                "binance"
            ],
            "max_drawdown": 0.42884083284194974,
            "model_id": "tmm423578397",
            "model_name": "DeFi in Binance",
            "model_type": "Thematic Model",
            "past_24hr_apr": 16.18199350907779,
            "past_24hr_roi": 0.044334228791993946,
            "risk_score": 29.74,
            "sharpe_ratio": 3.214358181302606,
            "total_return": 25.178187291736744,
            "trade_mode": "Multiple Token",
            "trading_pairs": [
                "UNI/USDT",
                "AAVE/USDT",
                "MKR/USDT",
                "RUNE/USDT",
                "CAKE/USDT",
                "LRC/USDT",
                "CRV/USDT",
                "KAVA/USDT",
                "GNO/USDT",
                "AMP/USDT",
                "COMP/USDT",
                "1INCH/USDT",
                "ZRX/USDT"
            ]
        },
        ...
    ],
    "error": false,
    "msg": "",
    "success": true
}

This endpoint return backtesting trading details

HTTP Request

GET /models

Response Parameters

Parameter Type Description
annualized_volatility Decimal The volatility in over a year
base_currency String Possible value: "USDT"
exchange String Possible values: "BINANCE", "BYBIT", "EQONEX"
max_drawdown Decimal Max Drawdown Amount
model_id String The model identifier
model_name String The name of model
model_type String The type of model used
trading_pairs String Traded for each other on an exchange
risk_score Decimal The score of model risk
sharpe_ratio Decimal Sharpe ratio
total_return Decimal The total return of completed trade

Model Detail

Response:

{
    "data":{
        "backtest_snapshot": {
            "additional_capitals": {
                "2022-01-02 08:00:00": 10000,
                "2022-01-09 08:00:00": 10000,
                "2022-01-16 08:00:00": 10000,
                "2022-01-23 08:00:00": 10000,
                "2022-01-30 08:00:00": 10000,
                "2022-02-06 08:00:00": 10000,
                "2022-02-20 08:00:00": 10000,
                ...
            },
            "alpha": 5715.564009,
            "annualized_return": 542.882016,
            "annualized_volatility": 2.211583,
            "available_balance": 9488.91767,
            "avg_annualy_pnl": null,
            "avg_annualy_pnl($)": null,
            "avg_daily_pnl": 0.022342,
            "avg_daily_pnl($)": 819.9169,
            "avg_daily_risk_score": 35.04,
            "avg_daily_trades": 2.19,
            ...
            "daily_changes": {
                "2022-01-02 00:00:00": 0.0,
                "2022-01-03 00:00:00": 1.01748,
                "2022-01-04 00:00:00": 0.00691,
                "2022-01-05 00:00:00": 0.01218,
                "2022-01-06 00:00:00": -0.02145,
                "2022-01-07 00:00:00": 0.00364,
                "2022-01-08 00:00:00": -0.03107,
                "2022-01-09 00:00:00": -0.04089,
                ...
            },
            "downside_risk": 0.589929,
            "duration": "150 days 00:00:00",
            "end": "2022-05-31 08:00:00+08:00",
            "ending_balance": 132978.34867,
            "expected_value": -1205.4116146666668,
            "frequently_traded": [
                {
                    "asset_type": "SPOT",
                    "avg_loss": -0.1333,
                    "avg_profit": 0.0138,
                    "number_trades": 29,
                    "profitable": 0.125,
                    "symbol": "AR/USDT"
                },
                ...
            ]
            "gross_loss": -14.1042,
            "gross_profit": 7.3012,
            "gross_trades_loss": -8.208,
            "gross_trades_profit": 0.0,
            "holding_values": 1.79367,
            "information_ratio": 0.024136,
            "interval": "1d",
            "largest_loss_losing_trade": -6.3495,
            "largest_profit_winning_trade": null,
            "loss_days": 4,
            "loss_ratio": 1.0,
            "max_consecutive_loss_days": 3,
            "max_consecutive_win_days": 2,
            "max_drawdown": 0.130445,
            "max_drawdown_duration": "14 days 00:00:00",
            "max_drawdown_period": [
                "2022-06-18 08:00:00+08:00",
                "2022-07-02 08:00:00+08:00"
            ]
            "pnl":[
                {
                    "assets_value": 9990.81495,
                    "available_balance": 805.76545,
                    "benchmark": 0.0,
                    "benchmark_pct": 0.0,
                    "datetime": "2022-01-01 08:00:00+08:00",
                    "holding_value": 9185.0495,
                    "pct_returns": 0.0,
                    "pnl_cumsum": 0.0,
                    "pnl_net": 0.0,
                    "pnl_net_pct_returns": 0.0,
                    "position_count": 8,
                    "positions": [
                        {
                            "aio_position_id": "AR/USDT|LOCAL|LONG",
                            "aio_symbol": "AR/USDT|LOCAL",
                            "asset_type": "SPOT",
                            "avg_price": 66.05,
                            "code": "AR/USDT",
                            "created_at": "2022-01-01 08:00:00+08:00",
                            "exchange": "LOCAL",
                            "initial_margin": 0.0,
                            "is_open": true,
                            "latest_price": 66.05,
                            "leverage": 1,
                            "liq_price": 0.0,
                            "maintenance_margin": 0.0,
                            "market_value": 569.351,
                            "net_investment": 569.351,
                            "notional_value": 569.351,
                            "pnl": 0.0,
                            "position_margin": null,
                            "quantity": 8.62,
                            "realized_pnl": 0.0,
                            "side": "LONG",
                            "symbol": "AR/USDT",
                            "total_commission": 0.569351,
                            "unrealized_pnl": 0.0,
                            "updated_at": "2022-01-01 08:00:00+08:00",
                            "weight": 0.057,
                            "weight_wo_cash": 0.062
                        },
                        ...
                    ],
                    "risk_scores": 0.0,
                    "total_commission": 9.18505,
                    "total_net_investment": 9185.0495,
                    "total_pnl": 0.0,
                    "total_realized_pnl": 0.0,
                    "total_unrealized_pnl": 0.0
                },
                ...
            ],
            "profit_factor": 1.613374,
            "return_on_capital": 0.585655,
            "return_on_initial_capital": 12.298753,
            "return_on_investment": 0.858226,
            "risk_score": 21.2,
            "sharpe_ratio": 3.675096,
            "sortino_ratio": 13.731864,
            "sqn": -5.788113,
            "stability_of_timeseries": 0.760142,
            "start": "2022-01-01 08:00:00+08:00",
            "tail_ratio": 2.21693,
            "total_commission": 1597.029029,
            "total_net_profit": 122987.53372,
            "total_return": 12.31006,
            "trade":[
                {
                    "actual_traded_at": "2022-01-01 08:00:00+08:00",
                    "aio_symbol": "AR/USDT|LOCAL",
                    "asset_type": "SPOT",
                    "avg_open_price": 66.05,
                    "code": "AR/USDT",
                    "commission": 0.569351,
                    "commission_asset": null,
                    "exchange": "LOCAL",
                    "gross_amount": 569.351,
                    "is_open": true,
                    "net_amount": 569.920351,
                    "order_id": "220101-080000000-00001",
                    "pnl": 0,
                    "pnl_net": -0.569351,
                    "price": 66.05,
                    "quantity": 8.62,
                    "roi": 0.0,
                    "side": "BUY",
                    "symbol": "AR/USDT",
                    "traded_at": "2022-01-01 08:00:00+08:00"
                },
                ...
            ]
        ...
    }
}

The endpoint return the model all detail and features

HTTP Request

GET /model/<model_id>/<psid>

URL Parameters

Parameter Description
model_id The model unique identifier
psid The user unique identifier

Response Parameters

Parameter Type Description
additional_capitals Dict Addition Capital of records
duration String Length of trading time
asset_type String Possible values: "SPOT", "PERPETUAL", "DATED_FUTURE", "INVERSE_PERPETUAL", "INVERSE_DATED_FUTURE"
exchange String Possible values: "BINANCE", "BYBIT", "EQONEX"
avg_annualy_pnl Decimal Annual average profit and loss
annualized_return Decimal Return in over a year
annualized_volatility Decimal The volatility in over a year
available_balance Decimal Account available balance
avg_annualy_pnl Decimal Annual Average Profit and Loss
avg_daily_pnl Decimal Daily Average Profit and Loss
avg_weekly_pnl Decimal Weekly Average Profit and Loss
avg_monthly_pnl Decimal Monthly Average Profit and Loss
avg_quarterly_pnl Decimal Quarterly Average Profit and Loss
avg_daily_trades Decimal Average Daily Trades
avg_weekly_trades Decimal Average Weekly Trades
avg_monthly_trades Decimal Average Monthly Trades
avg_loss = Decimal Average Loss
avg_profit Decimal Average Profit
base_currency String Base asset type
beginning_balance Decimal Account beginning balance
ending_balance Decimal Account ending balance
calmar_ratio Decimal risk-adjusted returns ratio
gross_loss Decimal Total Loss
gross_profit Decimal Total Profit
gross_trades_loss Decimal Total Trade Loss
gross_trades_profit Decimal Total Trade Profit
information_ratio Decimal Information Ratio
largest_loss_losing_trade Decimal The largest loss in losing trade
largest_profit_winning_trade Decimal The largest profit in winning trade
loss_days Integer Total losing days
loss_ratio Decimal Loss Ratio of completed trade
max_consecutive_loss_days Decimal Max Consecutive Loss by day
max_consecutive_win_days Decimal Max Consecutive Win by day
max_drawdown Decimal Max Drawdown Amount
max_drawdown_duration Decimal Max Drawdown Duration
max_loss_in_day Decimal Max Loss in day
max_return Decimal Max Return of completed tradw
max_win_in_day Decimal Max Win in day
min_return Decimal Min Return of completed tradw
number_trades Decimal The number of trade
initial_margin Decimal The margin ratio in initial
is_still_open Boolean Open or not
maintenance_margin Decimal Maintenance Margin Ratio
unrealized_pnl Decimal Unrealized profit and loss
is_open Boolean Open or not
updated_at The update time
liq_price Decimal Liquid Price
is_isolated Boolean Be isolated or not
leverage Decimal The rate of exposure increasing to the market
position_margin Decimal Position Margin Ratio
position_value Decimal Position Value
net_investment Decimal The net investment amount
net_position Decimal The net position
realized_pnl Decimal The realized profit and loss
total_pnl Decimal The total profit and loss
datetime Time The order date and time
executed_quantity Decimal Order Executed Quantity
order_id List Order Identifier
price Decimal Order Price
quantity Decimal Order Quantity
side Enum Buy/sell direction: SELL, BUY
type Enum Order Type: LIMIT (Only support LIMIT)
symbol String Trading pair
risk_score Decimal The score of model risk

Model Subscribe

Payload:

{
    "amount": {
        "Binance": 100.0
    }
}

Response:

{
    "data": null,
    "error": false,
    "msg": "",
    "success": true
}

HTTP Request

POST /model/<model_id>/<psid>

URL Parameters

Parameter Description
model_id The model unique identifier
psid The user unique identifier

Data Parameters

Parameter Required Description
amount True The currency amount

Model Unubscribe

Response:

{
    "data": null,
    "error": false,
    "msg": "",
    "success": true
}

HTTP Request

DELETE /model/<model_id>/<psid>

URL Parameters

Parameter Description
model_id The model unique identifier
psid The user unique identifier

Signals

Payload:

{
    "sd" : "sd",
    "ed" : "ed"
}

Response:

{
    "data": [
        {
            "actual_traded_at": "2022-06-30 09:07:31.734000+08:00",
            "asset_type": "PERPETUAL",
            "avg_open_price": 19498.12977099,
            "code": "BTCUSDT",
            "datetime": "2022-07-03 01:28:50.915295+08:00",
            "exchange": "BYBIT",
            "is_executed": false,
            "is_live": false,
            "is_open": false,
            "pnl": -20.18834,
            "price": 19049.5,
            "product": "FUTURE",
            "quantity": 0.045,
            "roi": -0.0079,
            "side": "SELL",
            "signal_id": "9355295527818",
            "source": "follow",
            "source_id": "348444",
            "subscribed_exchange": null,
            "symbol": "BTCUSDT",
            "traded_at": "2022-07-02 17:24:00+08:00"
        },
        ...
    ],
    "error": false,
    "msg": "",
    "success": true
}

The endpoint return all signal

HTTP Request

GET /signals/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Data Parameters

Parameter Required Description
sd
ed

Response Parameters

Parameter Type Description
asset_type String Possible values: "SPOT", "PERPETUAL", "DATED_FUTURE", "INVERSE_PERPETUAL", "INVERSE_DATED_FUTURE"
exchange String Possible values: "BINANCE", "BYBIT", "EQONEX"
datetime Time The order date and time
avg_open_price Decimal Average Open Price
is_executed Boolean Can be exceuted or not
is_live Boolean Order is live or not
is_open Boolean Open or not
pnl Decimal Profit and Loss
price Decimal Order Price
product String currency type
roi Decimal Return on investment
side Enum Buy/sell direction: SELL, BUY
signal_id String The signal identifier
source String follow or unfollow
source_id String The source identifier
subscribed_exchange String Change subscription_detail

Notifications

Payload:

{
    "sd" : "sd",
    "ed" : "ed"
}

Response:

{
    "data": [
        {
            "content": {
                "en": "You have trading signal from model tmm73779620.",
                "zh": "你收到来自 model tmm73779620 的交易信号."
            },
            "datetime": "2022-06-14 08:00:13.932091+08:00",
            "notification_id": "366877075",
            "psid": "dc80b547-fab1-11eb-bd86-1d8712ff722d",
            "type": "normal"
        },
        {
            "content": {
                "en": "687173 unfollowed you.",
                "zh": "687173 取消關注你."
            },
            "datetime": "2022-06-19 17:33:42.310269+08:00",
            "notification_id": "325850013",
            "psid": "dc80b547-fab1-11eb-bd86-1d8712ff722d",
            "type": "unfollow"
        },
        ...
    ],
    "error": false,
    "msg": "",
    "success": true
}

The endpoint return follow trading notifications

HTTP Request

GET /notifications/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Data Parameters

Parameter Required Description
sd
ed

Response Parameters

Parameter Type Description
content Dict The notification content in English or Chinese
datetime Time The order date and time
notification_id String The notification unique identifier
psid String The user unique identifier
type String Possible value: "normal", "unfollow"

Trade Leaders

Response:

{
    "data": [
        {
            "aum_range": 100435.0,
            "avg_monthly_trades": 30.9,
            "capital": 100000,
            "commission_rate": 0.35,
            "cumulative_roi": 0.056045,
            "current_balance": 6410.0,
            "expected_value": 86.8488928,
            "follower_changes": 0.15,
            "follower_counts": {
                "2022-06-25": 0.0,
                "2022-06-26": 0.0,
                "2022-06-27": 0.0,
                "2022-06-28": 0.0,
                "2022-06-29": 0.0,
                "2022-06-30": 1.0
            },
            "follower_growth_daily_changes": 0.01,
            "follower_growth_monthly_changes": 0.11,
            "follower_numbers": 95.0,
            "followers": {
                "613301ec-490d-11ec-b6b9-23c43279ce5b": {
                    "amount": {
                        "Binance": 113.6
                    },
                    "followed_at": "2022-06-30 16:23:50.459130+08:00",
                    "is_autopilot": false,
                    "proportion": {
                        "binance": 56.43
                    },
                    "psid": "613301ec-490d-11ec-b6b9-23c43279ce5b",
                    "user_code": "702916"
                }
            },
            "investment_objectives": "The choice from an ex-Hedge Fund trading strategist ",
            "portfolio_name": "The Quant's selection ",
            "psid": "8d9986a0-fab1-11eb-b8d5-1d8712ff722d",
            "return_on_capital": 0.056045,
            "risk_score": 1.67,
            "sharpe_ratio": 0.171558,
            "signal_fee": 0.00016658994782608696,
            "updated_at": "2022-07-05 11:50:03.695963+08:00",
            "user_code": "348444",
            "win_ratio": 0.66
        },
        ...
    ],
    "error": false,
    "msg": "",
    "success": true
}

The endpoint return leader signal

HTTP Request

GET /leaders/<psid>

Response Parameters

Parameter Type Description
avg_monthly_trades Decimal Average Monthly Trades
commission_rate Decimal Commission Rate
cumulative_roi Decimal Cumulateive Return on Investment
current_balance Decimal Account current balance
follower_changes Decimal The number of follower change
follower_counts Decimal Follower Order Count
follower_growth_daily_changes Decimal Follower changes daily growth
follower_growth_monthly_changes Decimal Follower changes monthly growth
follower_numbers Decimal The number of follower
followers The follower status and features
investment_objectives The objetive of investment
portfolio_name The name of portfolio
psid String The user unique identifier
user_code String The user identify code
investment_objectives String The objetive of investment
portfolio_name String The name of portfolio
return_on_capital Decimal Capital Return
risk_score Decimal The score of model risk
sharpe_ratio Decimal Sharpe Ratio
win_ratio Decimal Win Ratio of completed trade
signal_fee Decimal Signal Fee
updated_at Datetime The update time

Follow Detail

Response:

"data": {
        "aum_range": 100000.0,
        "avg_monthly_trades": 25.42,
        "capital": 100000,
        "commission_rate": 0.45,
        "cumulative_roi": 1.365211,
        "current_balance": 88960.0,
        "expected_value": 97.27007834554834,
        "follower_changes": 1.15,
        "follower_counts": {
            "2022-06-25": 1.0,
            "2022-06-26": 2.0,
            "2022-06-27": 1.0
        },
        "follower_growth_daily_changes": 0.0,
        "follower_growth_monthly_changes": 0.03,
        "follower_numbers": 120.0,
        "followers": {
            "dc80b547-fab1-11eb-bd86-1d8712ff722d": {
                "amount": {
                    "Binance": 100.0
                },
                "followed_at": "2022-06-26 17:31:55.812370+08:00",
                "is_autopilot": false,
                "proportion": {
                    "binance": 889.6
                },
                "psid": "dc80b547-fab1-11eb-bd86-1d8712ff722d",
                "user_code": "687173"
            },
            "fd21e95a-fb14-11eb-93f7-7faaa53a9baa": {
                "amount": {
                    "Binance": 10000.0
                },
                "followed_at": "2022-06-26 17:37:12.525525+08:00",
                "is_autopilot": false,
                "proportion": {
                    "binance": 8.9
                },
                "psid": "fd21e95a-fb14-11eb-93f7-7faaa53a9baa",
                "user_code": "946244"
            }
        },
        "investment_objectives": "Just for testing purpose. ",
        "is_subscribed": true,
        "portfolio_name": "The King's Portfolio",
        "psid": "dc80b547-fab1-11eb-bd86-1d8712ff722d",
        "return_on_capital": 1.365211,
        "risk_score": 3.6,
        "sharpe_ratio": 0.692544,
        "signal_fee": 0.00018657943416665283,
        "snapshot": {
            "additional_capitals": {},
            "alpha": 0.170233,
            "annualized_return": 0.328086,
            "annualized_volatility": 0.40906,
            "available_balance": 108171.285197,
            "avg_annualy_pnl": 0.560241,
            "avg_annualy_pnl($)": 45888.8062,
            "avg_daily_pnl": 0.0011,
        },
        ...
        "subscription_detail": {
            "amount": {
                "Binance": 100.0
            },
            "followed_at": "2022-06-26 17:31:55.812370+08:00",
            "is_approved": true,
            "proportion": {
                "binance": 889.6
            },
            "user_code": "687173"
        },
        "updated_at": "2022-07-05 11:56:42.750450+08:00",
        "user_code": "687173",
        "win_ratio": 0.457386
    },
    "error": false,
    "msg": "",
    "success": true

}

The endpoint return follow detail

HTTP Request

GET /follow/<user_code>/<psid>

URL Parameters

Parameter Description
user_code The user unique code
psid The user unique identifier

Response Parameters

Parameter Type Description
avg_monthly_trades Decimal Average Monthly Trades
commission_rate Decimal Commission Rate
cumulative_roi Decimal Cumulateive Return on Investment
current_balance Decimal Account current balance
follower_changes Decimal The number of follower change
follower_counts Decimal Follower Order Count
follower_growth_daily_changes Decimal Follower changes daily growth
follower_growth_monthly_changes Decimal Follower changes monthly growth
follower_numbers Decimal The number of follower
followers Dict The follower status and features
investment_objectives String The objetive of investment
portfolio_name String The name of portfolio
psid String The user unique identifier
user_code String The user identify code
investment_objectives String The objetive of investment
portfolio_name String The name of portfolio
return_on_capital Decimal Capital Return
risk_score Decimal The score of model risk
sharpe_ratio Decimal Sharpe Ratio
win_ratio Decimal Win Ratio of completed trade
signal_fee Decimal Signal Fee
updated_at The update time
avg_annualy_pnl Decimal Annual average profit and loss
annualized_return Decimal Return in over a year
annualized_volatility Decimal The volatility in over a year
available_balance Decimal Account available balance
avg_annualy_pnl Decimal Annual Average Profit and Loss
avg_daily_pnl Decimal Daily Average Profit and Loss

List Follows

Response:

{
    "data": {
        "followers": {
            "687173": {
                "amount": {
                    "Binance": 100.0
                },
                "followed_at": "2022-06-26 17:31:55.812370+08:00",
                "is_approved": true,
                "proportion": {
                    "binance": 889.6
                },
                "user_code": "687173"
            },
            ...
        },
        "following": {
            "687173": {
                "amount": {
                    "Binance": 100.0
                },
                "followed_at": "2022-06-26 17:31:55.812370+08:00",
                "is_approved": true,
                "proportion": {
                    "binance": 889.6
                },
                "user_code": "687173"
            },
            "824705": {
                "amount": {
                    "Binance": 100.0
                },
                "followed_at": "2022-06-28 01:32:31.610972+08:00",
                "is_approved": true,
                "proportion": {
                    "binance": 9.69
                },
                "user_code": "824705"
            },
            ...
        }
    },
    "error": false,
    "msg": "",
    "success": true
}

The endpoint return follow list information

HTTP Request

GET /follow/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Response Parameters

Parameter Type Description
followers Dict The follower status and features
is_approve Boolean Approve or not
user_code String The user identify code

Request Follow

Payload:

{
    "user_code": 687173
    "amount" : {"Binance": 100.0
}

Response:

"data": null,
"error": false,
"msg": "You have successfully request to follow.",
"success": true

HTTP Request

POSE /follow/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Data Parameters

Parameter Required Description
user_code True The user identify code
amount True The amount of asset

Approve Follow

Payload:

{
    "user_code": 687173
    "is_approve" : true
}

Response:

"data": null,
"error": false,
"msg": "You have successfully approve.",
"success": true

HTTP Request

PUT /follow/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Data Parameters

Parameter Required Description
user_code True The user identify code
is_approve True Approve or not

Unfollow

Payload:

{
    "is_unfollow" : true
}

Response:

"data": null,
"error": false,
"msg": "",
"success": true

HTTP Request

DELETE /follow/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Data Parameters

Parameter Required Description
is_unfollow True Unfollow or not

All Users

Response:

{
    "data": [
        {
            "reix_bonus": 42,
            "roi": 0.21615321732268122,
            "signal_exexcuted": 5,
            "signal_received": 45,
            "user_code": "910979",
            "username": "mindset1686",
            "win_rate": 0.9191315204864087
        },
        {
            "reix_bonus": 20,
            "roi": 0.7170826929691851,
            "signal_exexcuted": 17,
            "signal_received": 18,
            "user_code": "230982",
            "username": "google_108601186084531206874",
            "win_rate": 0.5088140357047302
        },
        {
            "reix_bonus": 0,
            "roi": 0.9103598559306596,
            "signal_exexcuted": 45,
            "signal_received": 1,
            "user_code": "201098",
            "username": "nicoleng0615",
            "win_rate": 0.6706306521369204
        },
        ...
    ],
    "error": false,
    "msg": "",
    "success": true
} 

The endpoint return all user

HTTP Request

GET /follows

Response Parameters

Parameter Description
user_code The code of user
username The name of user

Response Parameters

Parameter Type Description
roi Decimal Return on Investment
signal_exexcuted Integer The number of exceuted Signal
signal_received Integer The number of received signal
user_code String The user identify code
username String The user account name
win_rate String The rate of win

Thematic Indexs

Response:

{
    "data": [
        {
            "created_at": "2020-08-08",
            "current_components": [
                "ETH",
                "ADA",
                "SOL",
                "DOT",
                "AVAX",
                "TRX",
                "NEAR",
                "ALGO",
                "ATOM",
                "FLOW"
            ],
            "current_divisor": 676770669.017756,
            "current_price": 282.429326,
            "hist_component_circulating": {
                "2020-08-08": {
                    "ADA": 25927070728.975536,
                    "ALGO": 771817005.8409256,
                    "ATOM": 190688439.167748,
                    "EOS": 935000991.9611297,
                    "ETC": 116313298.99611227,
                    "ETH": 111000820.049902,
                    "HBAR": 5033144480.454633,
                    "TRX": 71659663105.58348,
                    "VET": 55454723728.58038,
                    "XTZ": 752217016.0528264
                },
                ...
            },
            "hist_component_close": {
                "2020-08-08": {
                    "ADA": 0.14696,
                    "ALGO": 0.4524,
                    "ATOM": 4.426,
                    "EOS": 3.0649,
                    "ETC": 6.9377,
                    "ETH": 397.03,
                    "HBAR": 0.0451,
                    "TRX": 0.02046,
                    "VET": 0.020815,
                    "XTZ": 3.382
                },
                ...
            },
            "hist_component_weight": {
                "2020-08-08": {
                    "ADA": 0.065538,
                    "ALGO": 0.006006,
                    "ATOM": 0.014517,
                    "EOS": 0.049291,
                    "ETC": 0.01388,
                    "ETH": 0.758034,
                    "HBAR": 0.003904,
                    "TRX": 0.025219,
                    "VET": 0.019854,
                    "XTZ": 0.043758
                },
                ...
            },
            "hist_components": {
                "2020-08-08": [
                    "ETH",
                    "ADA",
                    "TRX",
                    "ALGO",
                    "ATOM",
                    "ETC",
                    "HBAR",
                    "VET",
                    "XTZ",
                    "EOS"
                ],
                ...
            },
            "hist_divisor": {
                "2020-08-08": 581381258.045585,
                "2020-09-01": 603435457.20244,
                "2020-12-01": 583600255.182144,
                "2021-03-01": 630087362.428365,
                "2021-06-01": 615586539.815714,
                "2021-09-01": 665371293.907186,
                "2021-12-01": 665379989.746218,
                "2022-03-01": 676770669.017756
            },
            "index": "smart_contract_platforms",
            "updated_at": "2022-07-05 00:00:00"
        },
        ...
    ],
    "error": false,
    "msg": "",
    "success": true
}

The endpoint return thematic index

HTTP Request

GET /index

Response Parameters

Parameter Type Description
current_components String Currency Type
current_price Decimal Current Order Price
index String The index of thematic
hist_component_circulating Dict Circulate history component
updated_at Datetime The update time

Thematic Indexs History

Response:

{
    "data": [
        {
            "close": 100.0,
            "datetime": "2020-08-08",
            "high": 103.216828,
            "index": "defi",
            "low": 94.494243,
            "open": 96.609004
        },
        {
            "close": 105.088072,
            "datetime": "2020-08-09",
            "high": 107.37513,
            "index": "defi",
            "low": 97.013352,
            "open": 99.973829
        },
        {
            "close": 107.162598,
            "datetime": "2020-08-10",
            "high": 112.240544,
            "index": "defi",
            "low": 101.369406,
            "open": 105.177827
        },
        ...
    ],
    "error": false,
    "msg": "",
    "success": true
} 

The endpoint return thematic index history

HTTP Request

GET /index/<theme>

URL Parameters

Parameter Description
theme The index theme of blockchain

Response Parameters

Parameter Type Description
close Decimal Closing Price
datetime Time The order date and time
high Decimal Highest Price
low Decimal Low Price
open Decimal Opening Price
index String The index of thematic

Digital Network Services

Response:


HTTP Request

GET /dns/

Response Parameters

Parameter Type Description

Get Set History

Response:


HTTP Request

GET /dns/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Response Parameters

Parameter Description

Open Set

Payload:

{
    "spot" : "spot",
    "future" : "future",
    "spot_qty" : "spot_qty",
    "future_qty" : "future_qty",
    "is_isolated" : "is_isolated",
    "amount" : "amount",
    "entry_spread" : "entry_spread",
    "leverage" : "leverage",
    "tp_spread" : "tp_spread",
    "exit_mode" : "exit_mode"
}

Response:


HTTP Request

POST /dns/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Data Parameters

Parameter Required Description
spot
future
spot_qty
future_qty
is_isolated
amount
entry_spread
leverage
tp_spread
exit_mode

Close Set

Payload:

{
    set_id : "set_id"
}

Response:


HTTP Request

DELETE /dns/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Data Parameters

Parameter Required Description
set_id

Update Set Spread

Payload:

{
    "set_id" : "set_id",
    "new_tp_spread" : "new_tp_spread ",
    "new_exit_mode" : "new_exit_mode"
}

Response:


URL Parameters

Parameter Description
psid The user unique identifier

Data Parameters

Parameter Required Description
set_id
new_tp_spread
new_exit_mode

Tsunami score historty

Payload:

{
    "interval": "1d"
    "events": {'tsunami_score',  'miner_selling', 'whale_accumulation', 'huge_otc_deal', 'buying_selling_pressure', 'market_trend', 'market_sentiment', 'whale_dumping'}
}

Response:

//The Response return an interval is invalid
"data": None,
"error": false,
"msg": "Please provide a valid `interval`",
"success": true

//The Response return an event name is invalid
"data": None,
"error": false,
"msg": "Please provide a valid `event_name`",
"success": true

The endpoint return tsunami historical score

HTTP Request

GET /tsunami_score/<event_name>

URL Parameters

Parameter Description
event_name The name of event

Data Parameters

Parameter Required Description
interval String Time Interval
event_name String The name of event

Tsunami score

Response:

{
    "data": [
        {
            "accuracy": 0.1387675770118254,
            "attr1": 0.4427391373094587,
            "attr2": 0.7743129400999741,
            "confidence": 0.1963576978306809,
            "datetime": "2022-07-17",
            "event": "buying_selling_pressure",
            "indicators": [
                {
                    "name": "transactions_count_inflow",
                    "score": -1.0,
                    "score_type": 1.0,
                    "significance": 0.6989999376155159,
                    "value": 473571.0
                },
                {
                    "name": "transactions_count_outflow",
                    "score": 2.0,
                    "score_type": 0.0,
                    "significance": 0.12754968141269596,
                    "value": 627044.0
                },
                {
                    "name": "stablecoins_ratio",
                    "score": -6.0,
                    "score_type": 1.0,
                    "significance": 0.9919744604725254,
                    "value": 3.6846613002997075
                },
                {
                    "name": "stablecoins_ratio_usd",
                    "score": 3.0,
                    "score_type": 1.0,
                    "significance": 0.00478330102192337,
                    "value": 90.66278616467469
                }
            ],
            "score": 3.0,
            "score_type": -1.0,
            "value": 87.79076037793781
        },
        ...
    ],
    "error": false,
    "msg": "",
    "success": true
}

The endpoint return tsunami score

HTTP Request

GET /tsunami_score/

Response Parameters

Parameter Required Description
name String The name of event
score String The tsunami score

Affiliate

Affiliate User

Response:

{
    "data": {
        "bonus_rate_client": 0.25,
        "bonus_rate_sub_affiliate": 0.35,
        "first_name": "KK",
        "followers": [
            {
                "followed_at": "2021-10-10 12:22:32",
                "is_sub_affiliate": true,
                "user_code": "483957"
            },
            {
                "followed_at": "2021-09-10 14:22:32",
                "is_sub_affiliate": false,
                "user_code": "742385"
            },
            ...
        ],
        "following": [
            {
                "followed_at": "2021-10-11 12:22:32",
                "is_recommander": true,
                "user_code": "857837"
            },
            ...
        ],
        "is_approved": true,
        "last_name": "J",
        "recommander": "293752",
        "reix_bonus_total": 122.21,
        "role": "associate",
        "user_code": "459886"
    },
    "error": false,
    "msg": "",
    "success": true
}

The endpoint return affiliate user information

HTTP Request

GET /user/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Response Parameters

Parameter Type Description
bonus_rate_client Decimal Client bonus rate
bonus_rate_sub_affiliate Decimal Sub Affiliate bonus rate
followed_at Datetime Following date and time
is_sub_affiliate Boolean Sub Affiliate or not
user_code String The user identify code
is_approved Boolean Approve or not
recommander String Recommander
reix_bonus_total Decimal Total Reix bonus

Affiliate Trades

Response:

{
    "data": [
        {
            "amount": 123,
            "asset_type": "SPOT",
            "datetime": "2021-10-10 12:12:12",
            "exchange": "BINANCE",
            "reix_bonus": 12.3,
            "symbol": "BTC/USDT",
            "user_code": "483957"
        },
        {
            "amount": 104.08293498075079,
            "asset_type": "SPOT",
            "datetime": "2022-01-01 11:00:23",
            "exchange": "BYBIT",
            "reix_bonus": 26.020733745187698,
            "symbol": "DOT/USDT",
            "user_code": "028473"
        },
        ...
    ],
    "error": false,
    "msg": "",
    "success": true
}

The endpoint return affiliate trades

HTTP Request

GET /trades/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Response Parameters

Parameter Type Description
amount Decimal Asset amount
asset_type String Possible values: "SPOT", "FUTURE", "INVERSE_FUTURE"
datetime Datetime The order date and time
exchange String Possible values: "BINANCE", "BYBIT", "EQONEX"
reix_bonus Decimal Bonus Reix
symbol String Trading pair
user_code String The user identify code

Withdrawal History

Response:

{
    "data": [
        {
            "amount": 16.150029610523188,
            "datetime": "2022-02-24 01:12:19"
        },
        {
            "amount": 34.781037369615476,
            "datetime": "2022-06-29 02:09:14"
        },
        {
            "amount": 58.45582392535388,
            "datetime": "2022-04-22 15:10:00"
        }
    ],
    "error": false,
    "msg": "",
    "success": true
}

The endpoint return withdrawal

HTTP Request

GET /withdrawal/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Response Parameters

Parameter Type Description
amount Decimal Asset amount
datetime Datetime The order date and time

Withdrawal

Payload:

{
    "amount": 10
}

Response:

{
    "data": null,
    "error": false,
    "msg": "You have successfully withdrawn $10 reix bonus.",
    "success": true
}

Response:


The endpoint get withdrawal

HTTP Request

POST /withdrawal/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Data Parameters

Parameter Required Description
amount True Withdraw amount

All Affiliate

Response:

{
    "data": [
        {
            "first_name": "",
            "last_name": "",
            "recommander": "",
            "requested_at": "2021-10-15 12:21:22",
            "user_code": "543265"
        },
        {
            "first_name": "",
            "last_name": "",
            "recommander": "",
            "requested_at": "2021-09-30 13:21:22",
            "user_code": "948329"
        },
        ...
    ],
    "error": false,
    "msg": "",
    "success": true
}

The endpoint return all affiliate

HTTP Request

GET /management/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Response Parameters

Parameter Type Description
recommander String Recommander
requested_at Datetime Requested Time
user_code String The user identify code

Approve Affiliate

Payload:

{
    "user_code": 687173
}

Response:

{
    "data": null,
    "error": false,
    "msg": "The user 687173 has been successfully approved.",
    "success": true
}

The endpoint approve affiliate

HTTP Request

POST /management/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Data Parameters

Parameter Required Description
user_code True The user identify code

Remove Affiliate

Payload:

{
    "user_code": 687173
}

Response:

{
    "data": null,
    "error": false,
    "msg": "The user 687173 has been successfully removed.",
    "success": true
}

The endpoint remove affiliate

HTTP Request

POST /management/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Data Parameters

Parameter Required Description
user_code True The user identify code

Adjust Bonus Rate


Payload:

{
    "bonus_rate_client": 0.25,
    "bonus_rate_sub_affiliate": 0.35
}

Response:

{
    "data": null,
    "error": false,
    "msg": "The rate has been successfully updated.",
    "success": true
}

The endpoint approve affiliate

HTTP Request

PUT /management/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Data Parameters

Parameter Required Description
bonus_rate_client True Client bonus rate
bonus_rate_sub_affiliate True Sub Affiliate bonus rate

Recommend As Affiliate

Payload:

{
    "user_code": 687173
}

Response:

{
    "data": null,
    "error": false,
    "msg": "The user 687173 has been successfully recommanded.",
    "success": true
}

The endpoint approve affiliate

HTTP Request

PUT /recommendation/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Data Parameters

Parameter Required Description
user_code True The user identify code

Partner Bonus

Response:

{
    "data": {
        "asset": {}
    },
    "error": false,
    "msg": "",
    "success": true
}

The endpoint return partner bonus

HTTP Request

GET /partner/<psid>

URL Parameters

Parameter Description
psid The user unique identifier

Response Parameters

Parameter Type Description
asset Dict Type of Asset

Get Resources

Response:

{
    "data": {
        "AirDrop": [
            {
                "description": "okgnggwqomvbozxssykurblrphxrvtsomhctucmymsrjckageh",
                "filename": "enjnnjgmaw.csv",
                "link": "www.areix-ai.com",
                "updated_at": "2022-03-23 07:55:05"
            },
            {
                "description": "lfaoryniyikgfxqstxztkwudcylcrmkdutwqlthoqmsextdjmo",
                "filename": "wsmfiwcibc.html",
                "link": "www.areix-ai.com",
                "updated_at": "2021-08-05 18:56:13"
            },
            ...
        ],
        "Campaign1": [
            {
                "description": "zwjuuqopoycwlekdnvvdarwgtmmsbmxliveuutpdmiepovdcvq",
                "filename": "ebzcpjicbd.png",
                "link": "www.areix-ai.com",
                "updated_at": "2022-04-17 18:23:06"
            },
            {
                "description": "hrolphmqxbqpzxdgvofxyswxckyvvnfriyopvyjneqwstrgheo",
                "filename": "thwakixfbt.csv",
                "link": "www.areix-ai.com",
                "updated_at": "2022-03-27 06:24:03"
            },
            ...
        ],
        "Material_20211001": [
            {
                "description": "hutuyvheeaufpbfnzrqjtiqvatgctiqzpjmokhzggwywkmlcpk",
                "filename": "vugskcsjum.csv",
                "link": "www.areix-ai.com",
                "updated_at": "2021-09-07 00:44:52"
            },
            {
                "description": "yjbvrrpwrpjapqkqclyrkgzqilqtksajsjbhwoolqitrrovkwt",
                "filename": "nwrbhbfeiu.csv",
                "link": "www.areix-ai.com",
                "updated_at": "2022-06-22 06:39:23"
            },
            ...
        ]
    },
    "error": false,
    "msg": "",
    "success": true
}

The endpoint return resources

HTTP Request

GET /resources

Response Parameters

Parameter Type Description
description String Description
filename String The filename
link String Link of resource
updated_at Datetime Update date and time

Upload Resources

Payload:

{
    "filename": "Test.csv"
}

Response:

{
    "data": null,
    "error": false,
    "msg": "The file has been successfully uploaded.",
    "success": true
}

The endpoint uploads resources

HTTP Request

POST /resources

Data Parameters

Parameter Required Description
filename True Filename

Get Announcement

Response:

{
    "data": [
        {
            "content": "dd",
            "datetime": "2022-05-25 11:47:44",
            "title": "dd"
        },
        {
            "content": "ngpopixmnzmrdbzwgjyfcqjrzrulerxwqytuwznznkzluoqcbd",
            "datetime": "2021-09-01 15:49:36",
            "title": "bnauxajgio"
        },
        ...
    ],
    "error": false,
    "msg": "",
    "success": true
}

The endpoint return announcement

HTTP Request

GET /announcement/<lang>

URL Parameters

Parameter Description
lang Language

Response Parameters

Parameter Type Description
content String Announcement content
title String Announcement title

Post Announcement

Payload:

{
    "title": "dd",
    "content": "dd",
    "dt": "2021-09-01 15:49:36"
}

Response:

{
    "data": null,
    "error": false,
    "msg": "The new announcement has been successfully uploaded.",
    "success": true
}

The endpoint post announcement

HTTP Request

GET /announcement/<lang>

URL Parameters

Parameter Description
lang Language

Data Parameters

Parameter Required Description
content True Announcement content
title True Announcement title
dt True Datetime

Get Campaigns

Response:

{
    "data": {
        "air_drop": 12,
        "banner_url": "",
        "head_count": 10,
        "reward_rules": [
            "fjw49hfwe9 ghrwe hg9werhgi fadvufdhg34 ",
            "f4ni fn9gn5iw4",
            "qf nq49n fq9u nfr9qeh f u43qh 94h9wy5 ",
            "q4 58wiurgeh th5w8 hfrwufrw hgru9hfgbv"
        ],
        "rules": [
            "1. 3jfi43jfio4q3g 4qg4q ",
            "2. 3ioqnfoqjg49 v9qj q9v q9nv9q4nvqubv4qi b",
            "3. fnqu4hf9q3 q39h fqh v78qg 23bd bf8yq"
        ]
    },
    "error": false,
    "msg": "",
    "success": true
}

The endpoint return campaigns

HTTP Request

GET /announcement/<lang>

URL Parameters

Parameter Description
lang Language

Response Parameters

Parameter Type Description
air_drop Integer Air Drop

Thematic Index Websocket

endpoint: wss://stream.areix-ai.com/public/ws

subscribe example: wscat -c wss://stream.areix-ai.com/public/ws

Frontend Shows Binance Bybit Eqonex
Dated Futures Yes No Yes
Perpetual Yes Yes Yes
Inverse Perpetual Yes Yes No
Inverse Dated Futures Yes Yes No
Frontend Shows Binance Bybit Eqonex
Spot Yes Yes Yes
Saving / Earn No Yes No
Future Yes Yes Yes
Inverse Future Yes Yes No

Subscribe Index

Response:


//The response return a index is subscribed successfully.

{"error": false, "success": true, "data": 
    {"action": "subscribe_index", "theme": "defi", "components": 
        ["uniusdt", "mkrusdt", "cakeusdt", "aaveusdt", "runeusdt", "crvusdt", "lrcusdt", "gnousdt", "compusdt", "kavausdt"]}, 
            "msg": "You have successfully subscribe defi index."}

//The response return subscribe index detail

{"error": false, "success": true, "data": 
    {"action": "index", "theme": "defi", "data": 
        {"datetime": "2022-07-11 09:52:41.601189+08:00", "close": 188.887755, "past_24hr_close": 197.679819, "past_24hr_change": -0.04447628515888114}}, "msg": ""}

The endpoint return subscribe index detail

Subscribe Parameters

Parameter Type Description
action String Subscribe index
theme String Possibe value: 'smart_contract_platforms', 'defi','web3', 'gamefi', 'metaverse'

Example

{"action": "subscribe_index", "theme": "defi"}

Response Parameters

Parameter Type Description
action String Subscribe index
theme String Index theme
components String Trading pair
datetime Datetime Trading date and time

Unsubscribe Index

Response:

"error": false, "success": true, "data": 
    {"action": "unsubscribe_index", "theme": "web3"}, "msg": "You have successfully unsubscribe web3 index."}

The endpoint return a index is unsubscribed successfully

Subscribe Parameters

Parameter Type Description
action String Possibe value:
theme String Possibe value: "smart_contract_platforms", "defi","web3", "gamefi", "metaverse"

Example

{"action": "unsubscribe_index", "theme": "web3"}

Response Parameters

Parameter Type Description
action String subscribe_index "unsubscribe_index"
theme String Possibe value: "smart_contract_platforms", "defi", "web3", "gamefi", "metaverse"

Subscribe Depth

Response:


//The response return a depth is subscribed successfully.

{"error": false, "success": true, "data": 
    {"action": "subscribe_data", "channel": "depth", "exchange": "bybit", "symbol": "btcusdt", "asset_type": "spot", "interval": null}, 
        "msg": "You have successfully subscribe depth data stream."}

//The response return depth channel detail

{"error": false, "success": true, "data": 
    {"action": "data", "channel": "depth", "symbol": "btcusdt", "exchange": "bybit", "asset_type": "spot", "data": 
        {"symbol": "BTCUSDT", "exchange": "BYBIT", "channel": "depth", "interval": "1m", "asset_type": "SPOT", "name": "BTC/USDT", 
            "bid_price_1": 20576.72, "bid_volume_1": 0.144457, "bid_price_2": 20576.49, "bid_volume_2": 0.00217, "bid_price_3": 20574.68, "bid_volume_3": 0.19, 
            "bid_price_4": 20574.5, "bid_volume_4": 0.485983, "bid_price_5": 20574.49, "bid_volume_5": 0.11878, "ask_price_1": 20576.73, "ask_volume_1": 0.011821, 
            "ask_price_2": 20577.71, "ask_volume_2": 0.121, "ask_price_3": 20580.66, "ask_volume_3": 0.121, "ask_price_4": 20580.73, "ask_volume_4": 0.004742, 
            "ask_price_5": 20580.81, "ask_volume_5": 0.195386, "datetime": "2022-07-11 02:11:03.496364"}}, "msg": ""}

This endpoint return depth channel detail

Subscribe Parameters

Parameter Type Description
action String Possibe value: "subscribe_data"
channel String Possibe value: "depth", "kline", "ticker"
exchange String Possibe value: "binance", "bybit", "eqonex"
symbol String Trading pair
asset_type String Possibe value: "SPOT", "FUTURE", "INVERSE_FUTURE"

Example

{'action': 'subscribe_data', 'channel':'depth', 'exchange':'bybit', 'symbol':'BTCUSDT', 'asset_type':'spot'}

Response Parameters

Parameter Type Description
action String subscribe_index
theme String Index theme
channel String Possibe value: "depth", "kline", "ticker"
symbol String Trading pair
asset_type String Possibe value: "SPOT", "FUTURE", "INVERSE_FUTURE"
bid_price Decimal Bid price
bid_volume Decimal Bid volumn
ask_price Decimal Ask price
ask_volume Decimal Ask volumn
datetime Datetime Trading date and time

Subscribe Kline

Response:


//The response return a kline is subscribed successfully.

{"error": false, "success": true, "data": 
    {"action": "subscribe_data", "channel": "kline", "exchange": "bybit", "symbol": "btcusdt", "asset_type": "spot", "interval": "1m"}, "
        msg": "You have successfully subscribe kline data stream."}

//The response return kline channel detail.

{"error": false, "success": true, "data": 
    {"action": "data", "channel": "kline", "symbol": "btcusdt", "exchange": "bybit", "asset_type": "spot", "data": 
        {"symbol": "BTCUSDT", "exchange": "BYBIT", "channel": "kline", "interval": "1m", "asset_type": "SPOT", "name": "BTC/USDT", "volume": 0.278138, 
            "open": 20584.87, "high": 20597.29, "low": 20584.87, "close": 20594.91, "turnover": 5728.22707758, 
            "start": "2022-07-11 02:40:00+08:00", "datetime": "2022-07-11 02:45:25.037605"}, "interval": "1m"}, "msg": ""}

This endpoint return kline channel detail

Subscribe Parameters

Parameter Type Description
action String Possibe value: "subscribe_data"
channel String Possibe value: "depth", "kline", "ticker"
exchange String Possibe value: "binance", "bybit", "eqonex"
symbol String Trading pair
asset_type String Possibe value: "SPOT", "FUTURE", "INVERSE_FUTURE"
interval String Possible value: '1m', '1w', '2h'

Example

{'action': 'subscribe_data', 'channel':'kline', 'exchange':'bybit', 'symbol':'BTCUSDT', 'asset_type':'spot', 'interval':'1m'}

Response Parameters

Parameter Type Description
action String subscribe_index
theme String Index theme
channel String Possibe value: "depth", "kline", "ticker"
symbol String Trading pair
asset_type String Possibe value: "SPOT", "FUTURE", "INVERSE_FUTURE"
high Decimal Highest Price
low Decimal Low Price
open Decimal Opening Price
close Decimal Closing Price
interval String Time Interval
datetime Datetime Trading date and time

Subscribe Ticker

Response:


//The response return a ticker is subscribed successfully.

{"error": false, "success": true, "data": 
    {"action": "subscribe_data", "channel": "ticker", "exchange": "bybit", "symbol": "btcusdt", "asset_type": "spot", "interval": null}, 
        "msg": "You have successfully subscribe ticker data stream."}

//The response return ticker channel detail.

{"error": false, "success": true, "data": 
    {"action": "data", "channel": "ticker", "exchange": "bybit", "asset_type": "spot", "data": 
        [{"symbol": "ETHUSDT", "exchange": "BYBIT", "channel": "ticker", "interval": "1m", "asset_type": "SPOT", "name": "ETH/USDT", 
            "prev_open_24h": 1211.3, "prev_high_24h": 1212.53, "prev_low_24h": 1143.92, "prev_volume_24h": 48019.24503, 
            "prev_turnover_24h": 56426173.5489556, "last_price": 1150.42, "price_change_pct": -0.0503, 
            "prev_close_24h": 1211.3509529325052, "price_change": -60.93095293250508, "datetime": "2022-07-11 02:23:10.714509"}, 
        {"symbol": "BCHUSDT", "exchange": "BYBIT", "channel": "ticker", "interval": "1m", "asset_type": "SPOT", "name": "BCH/USDT", 
            "prev_open_24h": 110.4, "prev_high_24h": 110.8, "prev_low_24h": 104.6, "prev_volume_24h": 1496.826, 
            "prev_turnover_24h": 160992.7708, "last_price": 104.6, "price_change_pct": -0.0525, 
            "prev_close_24h": 110.39577836411608, "price_change": -5.795778364116089, "datetime": "2022-07-11 02:09:38.291588"},
        ...
        ]}, "msg": ""}
}

This endpoint return ticker channel detail

Subscribe Parameters

Parameter Type Description
action String Possibe value: "subscribe_data"
channel String Possibe value: "depth", "kline", "ticker"
exchange String Possibe value: "binance", "bybit", "eqonex"
asset_type String Possibe value: "SPOT", "FUTURE", "INVERSE_FUTURE"

Example

{'action': 'subscribe_data', 'channel':'ticker', 'exchange':'bybit', 'asset_type':'spot'}

Response Parameters

Parameter Type Description
action String subscribe_index
theme String Index theme
channel String Possibe value: "depth", "kline", "ticker"
symbol String Trading pair
asset_type String Possibe value: "SPOT", "FUTURE", "INVERSE_FUTURE"
interval String Time Interval
last_price Decimal Last price
price_change Decimal APrice change
datetime Datetime Trading date and time

Unsubscribe Depth

Response:


{"error": false, "success": true, "data": 
    {"action": "unsubscribe_data", "channel": "depth", "exchange": "bybit", "symbol": "btcusdt", "asset_type": "spot"}, "msg": "You have successfully unsubscribe depth data stream."}

This endpoint return depth channel unsubscribe successfully

Subscribe Parameters

Parameter Type Description
action String Possibe value: "unsubscribe_data"
channel String Possibe value: "depth", "kline", "ticker"
exchange String Possibe value: "binance", "bybit", "eqonex"

Example

{'action': 'unsubscribe_data', 'channel':'depth', 'exchange':'bybit', 'symbol':'BTCUSDT', 'asset_type':'spot'}

Response Parameters

Parameter Type Description
action String unsubscribe_data
theme String Index theme
channel String Possibe value: "depth", "kline", "ticker"
symbol String Trading pair
asset_type String Possibe value: "SPOT", "FUTURE", "INVERSE_FUTURE"

Unsubscribe Kline

Response:

{"error": false, "success": true, "data": 
    {"action": "unsubscribe_data", "channel": "kline", "exchange": "bybit", "symbol": "btcusdt", "asset_type": "spot", "interval": "1m"}, "msg": "You have successfully unsubscribe kline data stream."}

This endpoint return kline channel unsubscribe successfully

Subscribe Parameters

Parameter Type Description
action String Possibe value: "unsubscribe_data"
channel String Possibe value: "depth", "kline", "ticker"
exchange String Possibe value: "binance", "bybit", "eqonex"
symbol String Trading pair
asset_type String Possibe value: "SPOT", "FUTURE", "INVERSE_FUTURE"
interval String Possible value: '1m', '1w', '2h'

Example

{'action': 'subscribe_data', 'channel':'kline', 'exchange':'bybit', 'symbol':'BTCUSDT', 'interval':'1m', 'asset_type':'spot'}

Response Parameters

Parameter Type Description
action String unsubscribe_data
theme String Index theme
channel String Possibe value: "depth", "kline", "ticker"
symbol String Trading pair

Unsubscribe Ticker

Response:

{"error": false, "success": true, "data": 
    {"action": "unsubscribe_data", "channel": "ticker", "exchange": "bybit", "asset_type": "spot"}, "msg": "You have successfully unsubscribe ticker data stream."}

This endpoint return ticker channel unsubscribe successfully

Subscribe Parameters

Parameter Type Description
action String Possibe value: "unsubscribe_data"
channel String Possibe value: "depth", "kline", "ticker"
exchange String Possibe value: "binance", "bybit", "eqonex"
interval String Possible value: '1m', '1w', '2h'

Example

{'action': 'subscribe_data', 'channel':'ticker', 'exchange':'bybit', 'interval':'1m', 'asset_type':'spot'}

Response Parameters

Parameter Type Description
action String unsubscribe_data
theme String Index theme
channel String Possibe value: "depth", "kline", "ticker"
symbol String Trading pair

General Exchange Connector

Endpoint:

Pricing:

Access Standard Advanced Professional Institutional
Price Free $0 $0 Contact us
Rate Limit 30 req/day 60 req/min 600    req/min Custom

API Authentication

Authentication:

$ curl -k -H "Content-Type: application/json" -H "x-api-key: j23JDdj.....iw23end" -X POST -d '{"symbol":"xyz","exchange":"xyz",...}' https://areixio.areix-ai.com/signal
import requests

headers = {'x-api-key': "j23JDdj.....iw23end"}

res = requests.get('https://areixio.areix-ai.com/signal', headers=headers)
print(res.json())

General - Setup Position

Example:

import requests

exchange = "bybit"
psid = "xxxxx"
headers = {'x-api-key': f"j23JDdj.....iw23end"}

res = requests.post(f'https://areixio.areix-ai.com/position/{exchange}/{psid}', 
    json={
        "symbol":"BTCUSDT",
        "position_mode":"hedge",
        "is_isolated":False,
        "leverage": 10
    },
    headers=headers)
print(res.text)

Payload:

{
    "symbol":"BTCUSDT",
    "position_mode":"hedge",
    "is_isolated":False,
    "leverage": 10
}

Response:

{
    "data": None,
    "error": false,
    "msg": "Setup position succeed.",
    "success": true
}

This endpoint is used to set up position mode, margin mode and leverage

HTTP Request

POST /position/<exchange>/<psid>

URL Parameters

Parameter Description
exchange Crypto Exchange
psid User identifier

Data Parameters

Parameter Type Description
symbol String Trading instrument
position_mode String Possible values: "oneway", "hedge"
is_isolated Bool Is isolated or cross
leverage Decimal Leverage

General - Place Order

Example:

import requests

exchange = "bybit"
psid = "xxxxx"
headers = {'x-api-key': f"j23JDdj.....iw23end"}

res = requests.post(f'https://areixio.areix-ai.com/order/{exchange}/{psid}', 
    json={
        "symbol":"BTCUSDT",
        "asset_type":"future",
        "side":"buy",
        "quantity":0.05,
        "price":19300,
        "is_open":True,
        "position_side": "long",
    },
    headers=headers)
print(res.text)

Payload:

{
    "symbol":"BTCUSDT",
    "asset_type":"future",
    "side":"buy",
    "quantity":0.05,
    "price":19300,
    "is_open":True,
    "position_side": "long"
}

Response:

{
    "data": None,
    "error": false,
    "msg": "Place order succeed.",
    "success": true
}

This endpoint is used to place order

HTTP Request

POST /order/<exchange>/<psid>

URL Parameters

Parameter Description
exchange Crypto Exchange
psid User identifier

Data Parameters

Parameter Type Description
symbol String Trading instrument
asset_type String Possible values: "spot", "future", "inverse_future"
side Enum Buy/sell direction: SELL, BUY
quantity Decimal Quantity
price Decimal Trade Price. If specified, the order will be limit order (Optional)
is_open Bool Is open position or close position. Compulsory for non-spot asset_type (Optional)
position_side String Position side, Possible values: "long", "short", "net". Compulsory for non-spot asset_type (Optional)

General - Cancel Order

Example:

import requests

exchange = "bybit"
psid = "xxxxx"
headers = {'x-api-key': f"j23JDdj.....iw23end"}

res = requests.post(f'https://areixio.areix-ai.com/order/{exchange}/{psid}', 
    json={
        "symbol":"BTCUSDT",
        "asset_type":"perpetual",
        "order_id": "dj3i20-jrf20f4-2f234g-g23543",
    },
    headers=headers)
print(res.text)

Payload:

{
    "symbol":"BTCUSDT",
    "asset_type":"perpetual",
    "order_id": "dj3i20-jrf20f4-2f234g-g23543",
}

Response:

{
    "data": None,
    "error": false,
    "msg": "Cancel order succeed.",
    "success": true
}

This endpoint is used to cancel order

HTTP Request

DELETE /order/<exchange>/<psid>

URL Parameters

Parameter Description
exchange Crypto Exchange
psid User identifier

Data Parameters

Parameter Type Description
symbol String Trading instrument
asset_type String Possible values: "spot", "future", "inverse_future"
order_id String Original exchange order id

Bybit - Public - Instruments Info

Example:

import requests

headers = {}

res = requests.get(f'https://areixio.areix-ai.com/get_instruments_info?category=linear&symbol=BTCUSDT', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "category": "linear",
        "list": [
            {
                "symbol": "BTCUSDT",
                "contractType": "LinearPerpetual",
                "status": "Trading",
                "baseCoin": "BTC",
                "quoteCoin": "USDT",
                "launchTime": "1585526400000",
                "deliveryTime": "0",
                "deliveryFeeRate": "",
                "priceScale": "2",
                "leverageFilter": {
                    "minLeverage": "1",
                    "maxLeverage": "100.00",
                    "leverageStep": "0.01"
                },
                "priceFilter": {
                    "minPrice": "0.10",
                    "maxPrice": "199999.80",
                    "tickSize": "0.10"
                },
                "lotSizeFilter": {
                    "maxOrderQty": "100.000",
                    "maxMktOrderQty": "100.000",
                    "minOrderQty": "0.001",
                    "qtyStep": "0.001",
                    "postOnlyMaxOrderQty": "1000.000",
                    "minNotionalValue": "5"
                },
                "unifiedMarginTrade": true,
                "fundingInterval": 480,
                "settleCoin": "USDT",
                "copyTrading": "both",
                "upperFundingRate": "0.00375",
                "lowerFundingRate": "-0.00375"
            }
        ],
        "nextPageCursor": ""
    },
    "retExtInfo": {},
    "time": 1707186451514
}

This endpoint is used to fetch bybit instruments info

HTTP Request

GET /get_instruments_info

Request Parameters

https://bybit-exchange.github.io/docs/v5/market/instrument

Response Parameters

https://bybit-exchange.github.io/docs/v5/market/instrument

Bybit - Public - Tickers

Example:

import requests

headers = {}

res = requests.get(f'https://areixio.areix-ai.com/get_tickers?category=linear&symbol=BTCUSDT', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "category": "inverse",
        "list": [
            {
                "symbol": "BTCUSD",
                "lastPrice": "16597.00",
                "indexPrice": "16598.54",
                "markPrice": "16596.00",
                "prevPrice24h": "16464.50",
                "price24hPcnt": "0.008047",
                "highPrice24h": "30912.50",
                "lowPrice24h": "15700.00",
                "prevPrice1h": "16595.50",
                "openInterest": "373504107",
                "openInterestValue": "22505.67",
                "turnover24h": "2352.94950046",
                "volume24h": "49337318",
                "fundingRate": "-0.001034",
                "nextFundingTime": "1672387200000",
                "predictedDeliveryPrice": "",
                "basisRate": "",
                "deliveryFeeRate": "",
                "deliveryTime": "0",
                "ask1Size": "1",
                "bid1Price": "16596.00",
                "ask1Price": "16597.50",
                "bid1Size": "1",
                "basis": ""
            }
        ]
    },
    "retExtInfo": {},
    "time": 1672376496682
}

This endpoint is used to fetch bybit tickers

HTTP Request

GET /get_tickers

Request Parameters

https://bybit-exchange.github.io/docs/v5/market/tickers

Response Parameters

https://bybit-exchange.github.io/docs/v5/market/tickers

Bybit - Public - Orderbook

Example:

import requests

headers = {}

res = requests.get(f'https://areixio.areix-ai.com/get_orderbook?category=linear&symbol=BTCUSDT', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "s": "BTCUSDT",
        "a": [
            [
                "65557.7",
                "16.606555"
            ]
        ],
        "b": [
            [
                "65485.47",
                "47.081829"
            ]
        ],
        "ts": 1716863719031,
        "u": 230704,
        "seq": 1432604333,
        "cts": 1716863718905
    },
    "retExtInfo": {},
    "time": 1716863719382
}

This endpoint is used to fetch bybit tickers

HTTP Request

GET /get_orderbook

Request Parameters

https://bybit-exchange.github.io/docs/v5/market/orderbook

Response Parameters

https://bybit-exchange.github.io/docs/v5/market/orderbook

Bybit - Public - Funding Rate Hist

Example:

import requests

headers = {}

res = requests.get(f'https://areixio.areix-ai.com/get_funding_rate_history?category=linear&symbol=BTCUSDT&endTime=1613168000000&limit=1', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "category": "linear",
        "list": [
            {
                "symbol": "ETHPERP",
                "fundingRate": "0.0001",
                "fundingRateTimestamp": "1672041600000"
            }
        ]
    },
    "retExtInfo": {},
    "time": 1672051897447
}

This endpoint is used to fetch bybit funding rate history

HTTP Request

GET /get_funding_rate_history

Request Parameters

https://bybit-exchange.github.io/docs/v5/market/history-fund-rate

Response Parameters

https://bybit-exchange.github.io/docs/v5/market/history-fund-rate

Bybit - Private - Funding Fee Rate

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}
psid = 'fc7ca.......abbc61'

res = requests.get(f'https://areixio.areix-ai.com/get_fee_rates?category=linear&symbol=BTCUSDT&psid={psid}', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "list": [
            {
                "symbol": "ETHUSDT",
                "takerFeeRate": "0.0006",
                "makerFeeRate": "0.0001"
            }
        ]
    },
    "retExtInfo": {},
    "time": 1676360412576
}

This endpoint is used to fetch bybit user fee rate

HTTP Request

GET /get_fee_rates

Request Parameters

Parameter Type Description
psid String Psid (Mandatory)

https://bybit-exchange.github.io/docs/v5/account/fee-rate

Response Parameters

https://bybit-exchange.github.io/docs/v5/account/fee-rate

Bybit - Private - Users

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}

res = requests.get(f'https://areixio.areix-ai.com/get_users', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "list": [
            {
                "psid": "xxxx",
                "initial_balance": "1000",
            }
        ]
    },
    "retExtInfo": {},
    "time": 1676360412576
}

This endpoint is used to fetch bybit user list

HTTP Request

GET /get_users

Request Parameters

Response Parameters

Parameter Type Description
psid String Psid
initial_balance Decial Initial Balance

Bybit - Private - User Status

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}

res = requests.get(f'https://areixio.areix-ai.com/update_user_status', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
    },
    "retExtInfo": {},
    "time": 1676360412576
}

This endpoint is used to fetch bybit user list

HTTP Request

GET /update_user_status?psid=<psid>&status=<status>

Request Parameters

Parameter Type Description
psid String Psid
status String Status

Bybit - Private - Collateral Info

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}
psid = 'fc7ca.......abbc61'

res = requests.get(f'https://areixio.areix-ai.com/get_collateral_info?currency=USDT&psid={psid}', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "list": [
            {
                "availableToBorrow": "3",
                "freeBorrowingAmount": "",
                "freeBorrowAmount": "0",
                "maxBorrowingAmount": "3",
                "hourlyBorrowRate": "0.00000147",
                "borrowUsageRate": "0",
                "collateralSwitch": true,
                "borrowAmount": "0",
                "borrowable": true,
                "currency": "BTC",
                "marginCollateral": true,
                "freeBorrowingLimit": "0",
                "collateralRatio": "0.95"
            }
        ]
    },
    "retExtInfo": {},
    "time": 1691565901952
}

This endpoint is used to fetch bybit user collateral info

HTTP Request

GET /get_collateral_info

Request Parameters

Parameter Type Description
psid String Psid (Mandatory)

https://bybit-exchange.github.io/docs/v5/account/collateral-info

Response Parameters

https://bybit-exchange.github.io/docs/v5/account/collateral-info

Bybit - Private - Wallet Balance

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}
psid = 'fc7ca.......abbc61'

res = requests.get(f'https://areixio.areix-ai.com/get_wallet_balance?accountType=UNIFIED&psid={psid}', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "list": [
            {
                "totalEquity": "3.31216591",
                "accountIMRate": "0",
                "totalMarginBalance": "3.00326056",
                "totalInitialMargin": "0",
                "accountType": "UNIFIED",
                "totalAvailableBalance": "3.00326056",
                "accountMMRate": "0",
                "totalPerpUPL": "0",
                "totalWalletBalance": "3.00326056",
                "accountLTV": "0",
                "totalMaintenanceMargin": "0",
                "coin": [
                    {
                        "availableToBorrow": "3",
                        "bonus": "0",
                        "accruedInterest": "0",
                        "availableToWithdraw": "0",
                        "totalOrderIM": "0",
                        "equity": "0",
                        "totalPositionMM": "0",
                        "usdValue": "0",
                        "spotHedgingQty": "0.01592413",
                        "unrealisedPnl": "0",
                        "collateralSwitch": true,
                        "borrowAmount": "0.0",
                        "totalPositionIM": "0",
                        "walletBalance": "0",
                        "cumRealisedPnl": "0",
                        "locked": "0",
                        "marginCollateral": true,
                        "coin": "BTC"
                    }
                ]
            }
        ]
    },
    "retExtInfo": {},
    "time": 1690872862481
}

This endpoint is used to fetch bybit user wallet balance

HTTP Request

GET /get_wallet_balance

Request Parameters

Parameter Type Description
psid String Psid (Mandatory)

https://bybit-exchange.github.io/docs/v5/account/wallet-balance

Response Parameters

https://bybit-exchange.github.io/docs/v5/account/wallet-balance

Bybit - Private - Open Orders

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}
psid = 'fc7ca.......abbc61'

res = requests.get(f'https://areixio.areix-ai.com/get_open_orders?category=linear&symbol=BTCUSDT&psid={psid}', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "list": [
            {
                "availableToBorrow": "3",
                "freeBorrowingAmount": "",
                "freeBorrowAmount": "0",
                "maxBorrowingAmount": "3",
                "hourlyBorrowRate": "0.00000147",
                "borrowUsageRate": "0",
                "collateralSwitch": true,
                "borrowAmount": "0",
                "borrowable": true,
                "currency": "BTC",
                "marginCollateral": true,
                "freeBorrowingLimit": "0",
                "collateralRatio": "0.95"
            }
        ]
    },
    "retExtInfo": {},
    "time": 1691565901952
}

This endpoint is used to fetch bybit user open orders

HTTP Request

GET /get_open_orders

Request Parameters

Parameter Type Description
psid String Psid (Mandatory)

https://bybit-exchange.github.io/docs/v5/order/open-order

Response Parameters

https://bybit-exchange.github.io/docs/v5/order/open-order

Bybit - Private - Positions

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}
psid = 'fc7ca.......abbc61'

res = requests.get(f'https://areixio.areix-ai.com/get_positions?category=linear&symbol=BTCUSDT&psid={psid}', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "list": [
            {
                "positionIdx": 0,
                "riskId": 1,
                "riskLimitValue": "150",
                "symbol": "BTCUSD",
                "side": "Sell",
                "size": "300",
                "avgPrice": "27464.50441675",
                "positionValue": "0.01092319",
                "tradeMode": 0,
                "positionStatus": "Normal",
                "autoAddMargin": 1,
                "adlRankIndicator": 2,
                "leverage": "10",
                "positionBalance": "0.00139186",
                "markPrice": "28224.50",
                "liqPrice": "",
                "bustPrice": "999999.00",
                "positionMM": "0.0000015",
                "positionIM": "0.00010923",
                "tpslMode": "Full",
                "takeProfit": "0.00",
                "stopLoss": "0.00",
                "trailingStop": "0.00",
                "unrealisedPnl": "-0.00029413",
                "curRealisedPnl": "0.00013123",
                "cumRealisedPnl": "-0.00096902",
                "seq": 5723621632,
                "isReduceOnly": false,
                "mmrSysUpdateTime": "",
                "leverageSysUpdatedTime": "",
                "sessionAvgPrice": "",
                "createdTime": "1676538056258",
                "updatedTime": "1697673600012"
            }
        ],
        "nextPageCursor": "",
        "category": "inverse"
    },
    "retExtInfo": {},
    "time": 1697684980172
}

This endpoint is used to fetch bybit user positions

HTTP Request

GET /get_positions

Request Parameters

Parameter Type Description
psid String Psid (Mandatory)

https://bybit-exchange.github.io/docs/v5/position

Response Parameters

https://bybit-exchange.github.io/docs/v5/position

Bybit - Private - Place Order

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}
psid = 'fc7ca.......abbc61'

res = requests.get(f'https://areixio.areix-ai.com/place_order?category=linear&symbol=BTCUSDT&qty=0.001&side=Buy&orderType=Limit&price=40000&psid={psid}', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "orderId": "1321003749386327552",
        "orderLinkId": "spot-test-postonly"
    },
    "retExtInfo": {},
    "time": 1672211918471
}

This endpoint is used to place order in bybit

HTTP Request

GET /place_order

Request Parameters

Parameter Type Description
psid String Psid (Mandatory)

https://bybit-exchange.github.io/docs/v5/order/create-order

Response Parameters

https://bybit-exchange.github.io/docs/v5/order/create-order

Bybit - Private - Cancel Order

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}
psid = 'fc7ca.......abbc61'

res = requests.get(f'https://areixio.areix-ai.com/cancel_order?category=linear&symbol=BTCUSDT&orderId=e3dd3d3f342tf342tf4&psid={psid}', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "orderId": "c6f055d9-7f21-4079-913d-e6523a9cfffa",
        "orderLinkId": "linear-004"
    },
    "retExtInfo": {},
    "time": 1672217377164
}

This endpoint is used to cancel order in bybit

HTTP Request

GET /cancel_order

Request Parameters

Parameter Type Description
psid String Psid (Mandatory)

https://bybit-exchange.github.io/docs/v5/order/cancel-order

Response Parameters

https://bybit-exchange.github.io/docs/v5/order/cancel-order

Bybit - Private - Switch Collateral

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}
psid = 'fc7ca.......abbc61'

res = requests.get(f'https://areixio.areix-ai.com/set_collateral_switch?coin=USDT&collateralSwitch=ON&psid={psid}', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "SUCCESS",
    "result": {},
    "retExtInfo": {},
    "time": 1690515818656
}

This endpoint is used to set collateral in bybit

HTTP Request

GET /set_collateral_switch

Request Parameters

Parameter Type Description
psid String Psid (Mandatory)

https://bybit-exchange.github.io/docs/v5/account/set-collateral

Response Parameters

https://bybit-exchange.github.io/docs/v5/account/set-collateral

Bybit - Private - Set Leverage

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}
psid = 'fc7ca.......abbc61'

res = requests.get(f'https://areixio.areix-ai.com/set_leverage?category=linear&symbol=BTCUSDT&buyLeverage=5&sellLeverage=5&psid={psid}', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "SUCCESS",
    "result": {},
    "retExtInfo": {},
    "time": 1690515818656
}

This endpoint is used to set leverage in bybit

HTTP Request

GET /set_leverage

Request Parameters

Parameter Type Description
psid String Psid (Mandatory)

https://bybit-exchange.github.io/docs/v5/position/leverage

Response Parameters

https://bybit-exchange.github.io/docs/v5/position/leverage

Bybit - Private - Set Position Mode

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}
psid = 'fc7ca.......abbc61'

res = requests.get(f'https://areixio.areix-ai.com/switch_position_mode?category=linear&symbol=BTCUSDT&mode=0&psid={psid}', headers=headers)
print(res.json)

Payload:


Response:

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {},
    "retExtInfo": {},
    "time": 1675249072814
}

This endpoint is used to set position mode in bybit

HTTP Request

GET /switch_position_mode

Request Parameters

Parameter Type Description
psid String Psid (Mandatory)

https://bybit-exchange.github.io/docs/v5/position/position-mode

Response Parameters

https://bybit-exchange.github.io/docs/v5/position/position-mode

Social Analysis

Endpoint:

Pricing:

Access Standard Advanced Professional Institutional
Price Free $0 $0 Contact us
Rate Limit 30 req/day 60 req/min 600    req/min Custom

API Authentication

Authentication:

$ curl -k -H "Content-Type: application/json" -H "x-api-key: j23JDdj.....iw23end" -X POST -d '{"symbol":"xyz","exchange":"xyz",...}' https://areixio.areix-ai.com/signal
import requests

headers = {'x-api-key': "j23JDdj.....iw23end"}

res = requests.get('https://areixio.areix-ai.com/signal', headers=headers)
print(res.json())

Trade Backtest

Example:

import requests

user_code = "xxxxx"
input_path = r'dtrades.csv'
out_path = r'dtrades.html'

res = requests.post(f'https://areixio.areix-ai.com/backtest?user_code={user_code}', 
    files={'file': open(input_path, 'rb')},
    headers=headers)
print(res.text)

with open(out_path, 'wb') as f:
    f.write(res.text.encode())

Input File Sample:

[
    {
        "symbol":"BTCUSDT",
        "datetime":"2022-06-07 01:40:00",
        "price":29766.5,
        "side":"buy",
        "leverage":8,
        "quantity":0.5,
        "exchange":"binance",
        "asset_type":"perptual"
    },
    ...
]

Response:

{}

This endpoint is used to backtest the trades based on submited trade file

HTTP Request

POST /backtest?user_code=<user_code>

URL Parameters

Parameter Description
user_code The signal provider unique identifier

Data Parameters

Parameter Reqiure Description
file True The trade file that would be either csv or json format

Trade file feilds

Parameter Type Description
symbol String Trading instrument
asset_type String Possible values: "PERPETUAL", "DATED_FUTURE", "INVERSE_PERPETUAL", "INVERSE_DATED_FUTURE"
exchange String Possible values: "BINANCE", "BYBIT", "OKX"
side Enum Buy/sell direction: SELL, BUY
price Decimal Trade Price
quantity Decimal Quantity
datetime Datetime The trade date and time
leverage Decimal Leverage (Optional)

Submit Analysis

Example:

import requests

user_code = "xxxxx"
headers = {'x-api-key': f"j23JDdj.....iw23end"}

res = requests.post(f'https://areixio.areix-ai.com/analysis?user_code={user_code}', 
    json={
        "symbol":"BTCUSDT",
        "asset_type": "derivatives",
        "side":"long",
        "leverage":1,
        "entry_price":[],
        "exit_price":[],
        "sl_price":,
        "effevtive_start":"2024-01-01",
        "effevtive_end":"2024-01-02",
        "confidence":4,
        "detail":"xxxxxxxx",
        "translation":{
            "zh":{
                "detail":"XXXX"
            }
        }
    },
    headers=headers)
print(res.text)

Payload:

{
    "symbol":"BTCUSDT",
    "asset_type": "derivatives",
    "side":"long",
    "leverage":1,
    "entry_price":[],
    "exit_price":[],
    "sl_price":,
    "effevtive_start":"2024-01-01",
    "effevtive_end":"2024-01-02",
    "confidence":4,
    "detail":"xxxxxxxx",
    "translation":{
        "zh":{
            "detail":"XXXX"
        }
    }
}

Response:

{
    "data": None,
    "error": false,
    "msg": "successfully submitted",
    "success": true
}

This endpoint is used to submit the signal, the signal will be stored in our database and executed in realtime.

HTTP Request

POST /analysis?user_code=<user_code>

URL Parameters

Parameter Description
user_code The signal provider unique identifier

Data Parameters

Parameter Type Description
symbol String Trading instrument
asset_type String Possible values: "derivatives", "spot"
side Enum Buy/sell direction: SELL, BUY
leverage Decimal Leverage (Optional)
entry_price List Entry Price
exit_price List Exit Price
effevtive_start Datetime The trade date and time
effevtive_end Datetime The trade date and time
confidence Integer Confidence
translation Dict Optional

Submit Feed

Example:

import requests

user_code = "xxxxx"
headers = {'x-api-key': f"j23JDdj.....iw23end"}

res = requests.post(f'https://areixio.areix-ai.com/feeds?user_code={user_code}', 
    json={
        "topic":"XXXX",
        "text": "xxxxx",
        "url":"",
        "img_url":"https://xxxxxx",
        "youtube_url":"https://xxxxxx",
        "translation":{
            "zh":{
                "topic":"XXXX",
                "text":"xxxxx"
            }
        }
    },
    headers=headers)
print(res.text)

Payload:

{
    "topic":"XXXX",
    "text": "xxxxx",
    "url":"",
    "img_url":"https://xxxxxx",
    "youtube_url":"https://xxxxxx",
    "translation":{
        "zh":{
            "topic":"XXXX",
            "text":"xxxxx"
        }
    }
}

Response:

{
    "data": None,
    "error": false,
    "msg": "successfully submitted",
    "success": true
}

This endpoint is used to submit the signal, the signal will be stored in our database and executed in realtime.

HTTP Request

POST /feeds?user_code=<user_code>

URL Parameters

Parameter Description
user_code The signal provider unique identifier

Data Parameters

Parameter Type Description
topic String Topic
text String Content
url String Url
img_url String Image Url
youtube_url String Youtube Url
translation Dict Optional

Submit Signal

Example:

import requests

user_code = "xxxxx"
headers = {'x-api-key': f"j23JDdj.....iw23end"}

res = requests.post(f'https://areixio.areix-ai.com/signal?user_code={user_code}', 
    json={
        "symbol":"BTCUSDT",
        "datetime":"2022-10-05 12:03:11",
        "price":19300,
        "side":"buy",
        "quantity":0.05,
        "exchange":"bybit",
        "asset_type":"perpetual",
        "leverage": 5,
        "validate_only":True
    },
    headers=headers)
print(res.text)

Payload:

{
    "symbol":"BTCUSDT",
    "datetime":"2022-10-05 12:03:11",
    "price":19300,
    "side":"buy",
    "quantity":0.05,
    "exchange":"bybit",
    "asset_type":"perpetual",
    "leverage": 5,
    "validate_only":true
}

Response:

{
    "data": None,
    "error": false,
    "msg": "successfully stored/executed",
    "success": true
}

This endpoint is used to submit the signal, the signal will be stored in our database and executed in realtime.

HTTP Request

POST /signal?user_code=<user_code>

URL Parameters

Parameter Description
user_code The signal provider unique identifier

Data Parameters

Parameter Type Description
symbol String Trading instrument
asset_type String Possible values: "PERPETUAL", "DATED_FUTURE", "INVERSE_PERPETUAL", "INVERSE_DATED_FUTURE"
exchange String Possible values: "BINANCE", "BYBIT", "OKX"
side Enum Buy/sell direction: SELL, BUY
price Decimal Trade Price
quantity Decimal Quantity
datetime Datetime The trade date and time
leverage Decimal Leverage (Optional)
validate_only Boolean Default is False. If specified if True, the signal will only be verified the format and wont be store&execute (Optional)

Top Traders

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}

res = requests.get(f'https://areixio.areix-ai.com/leaders', headers=headers)
print(res.json)

Payload:


Response:

{
    "data": [
        {
            "aum_range": 1526449.2109287716,
            "avg_monthly_trades": 24.0,
            "capital": 100000,
            "commission_rate": 0.35,
            "cumulative_roi": 2.337419,
            "current_balance": 6410.0,
            "expected_value": 2.53,
            "follower_changes": 0.0,
            "follower_counts": {
                "2022-10-06": 3.0,
                ...
                "2022-12-07": 37.0
            },
            "follower_growth_daily_changes": 0.0,
            "follower_growth_monthly_changes": 1.125,
            "follower_numbers": 38,
            "followers": {
                "1385c89e-4ef9-11ed-843f-9e4310159abd": {
                    "amount": {
                        "bybit": 100.0
                    },
                    "followed_at": "2022-11-23 11:51:59.667239+08:00",
                    "is_autopilot": false,
                    "proportion": {
                        "bybit": 64.1
                    },
                    "psid": "1385c89e-4ef9-11ed-843f-9e4310159abd",
                    "user_code": "778246"
                },
                ...
            },
            "icon_url": "https://areix.s3.ap-east-1.amazonaws.com/signal_provider_icons/440425.png",
            "investment_objectives": "Dema's strategy is a long term strategy that based on dema and supertrend indicators. \n\nBy combining the Dema to calculate Supertrend results in nice lower and upper bands. This can be used to identify potential supports and resistances and set protective stops.\n\nWith the RSI indicator, based on the oversold and overbought volume to double filter the false signal. Plus, using the multiple timeframe to increase the accuracy the entry point\n ",
            "is_ola": true,
            "lang": {
                "zh": {
                    "investment_objectives": "「Dema 策略」屬於中長期交易策略。\n\n此策略主要基於 Dema 和 Supertrend 等指標,透過結合 Dema 的結果去計算 Supertrend 指標,從而得出一個較為精準的價格通道,用以分辨價格的支持和阻力位。\n\n此策略亦加以利用 RSI 的超買超賣去過濾虛假的交易訊號, 並且通過多個時間間隔來提升入場點的準確度。",
                    "portfolio_name": "Dema 策略"
                }
            },
            "num_positions": 1,
            "ola_rating": "AA-",
            "past_7d_roi": 0.016651,
            "portfolio_name": "Dema's strategy",
            "psid": "9ccccc",
            "rank": "average",
            "return_on_capital": 2.337419,
            "sharpe_ratio": 2.561867,
            "signal_fee": 0.4834394904458599,
            "signal_fee_hist": {
                "2022-10": 0.6993630573248408,
                "2022-12": 0.6993630573248408
            },
            "signal_fee_updated_at": "2022-12-01 23:58:00.006630+08:00",
            "sqn": 2.716707,
            "sqn_rank": 0.5,
            "standardized_expected_value": 2.51,
            "updated_at": "2022-12-07 18:17:11.997614+08:00",
            "user_code": "4545454",
            "win_ratio": 0.434555
        },
        ....
    ],
    "error": false,
    "msg": "",
    "success": true
}

This endpoint is used to fetch Ola top traders

HTTP Request

GET /leaders?lang=<lang>

URL Parameters

Parameter Description
lang Language. E.g. 'en', 'zh', ...

Response Parameters

Parameter Type Description
avg_monthly_trades Decimal Average Monthly Trades
commission_rate Decimal Commission Rate
cumulative_roi Decimal Cumulateive Return on Investment
current_balance Decimal Account current balance
follower_changes Decimal The number of follower change
follower_counts Decimal Follower Order Count
follower_growth_daily_changes Decimal Follower changes daily growth
follower_growth_monthly_changes Decimal Follower changes monthly growth
follower_numbers Decimal The number of follower
followers The follower status and features
investment_objectives The objetive of investment
portfolio_name The name of portfolio
psid String The user unique identifier
user_code String The user identify code
investment_objectives String The objetive of investment
portfolio_name String The name of portfolio
return_on_capital Decimal Capital Return
risk_score Decimal The score of model risk
sharpe_ratio Decimal Sharpe Ratio
win_ratio Decimal Win Ratio of completed trade
signal_fee Decimal Signal Fee
updated_at Datetime The update time

Top Signals

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}

res = requests.get(f'https://areixio.areix-ai.com/topsignals', headers=headers)
print(res.json)

Payload:


Response:

{
    "data": {
        "data": {
            "binance_leaderboard": [
                {
                    "actual_traded_at": "2022-12-07 18:31:18.089609+08:00",
                    "asset_type": "PERPETUAL",
                    "avg_open_price": 2.318,
                    "code": "WAVESBUSD",
                    "datetime": "2022-12-07 18:31:18.089609+08:00",
                    "exchange": "BINANCE",
                    "icon_url": "https://areix.s3.ap-east-1.amazonaws.com/signal_provider_icons/binanceleaderboard_default.png",
                    "is_open": false,
                    "leverage": 1,
                    "nickname": "Anonymous User-b82a42",
                    "price": 2.318,
                    "product": "FUTURE",
                    "quantity": 2.5,
                    "roi": 0.0,
                    "side": "SELL",
                    "source": "binance_leaderboard",
                    "symbol": "WAVESBUSD",
                    "uid": "D9DBFAC2D9B25C1293B03C041A42F249"
                }
            ],
            "ola": [
                {
                    "actual_traded_at": "2022-12-07 18:09:32.256000+08:00",
                    "asset_type": "PERPETUAL",
                    "avg_open_price": 3.962,
                    "code": "APEUSDT",
                    "datetime": "2022-12-07 18:09:52.004855+08:00",
                    "exchange": "BYBIT",
                    "icon_url": "https://areix.s3.ap-east-1.amazonaws.com/signal_provider_icons/660701.png",
                    "is_open": true,
                    "leverage": 1,
                    "nickname": "Dynamic Grid Trade Strategy G",
                    "order_id": "221207-180900000-01228",
                    "pnl": 0.0,
                    "price": 3.962,
                    "product": "FUTURE",
                    "quantity": 25.2,
                    "roi": 0.0,
                    "side": "SELL",
                    "signal_id": "11178713864",
                    "source": "follow",
                    "source_id": "660701",
                    "symbol": "APEUSDT",
                    "traded_at": "2022-12-07 18:09:48.677553+08:00"
                }
            ]
        },
        "error": false,
        "msg": "",
        "success": true
    },
    "error": false,
    "msg": "",
    "success": true
}

This endpoint is used to fetch Ola top signals

HTTP Request

GET /topsignals

Response Parameters

Parameter Type Description
asset_type String Possible values: "SPOT", "PERPETUAL", "DATED_FUTURE", "INVERSE_PERPETUAL", "INVERSE_DATED_FUTURE"
exchange String Exchange, Possible values: "BINANCE", "BYBIT", "OKX"
datetime Datetime Datetime
avg_open_price Decimal Average Open Price
is_open Boolean Is Open position or close position
icon_url String Icon URL
nickname String Nickname
leverage Decimal Leverage
orider_id String Order Id
pnl Decimal Profit and Loss
price Decimal Order Price
product String Product type
roi Decimal Return on investment
side Enum Buy/sell direction: SELL, BUY
signal_id String The signal identifier
source String Possible values: "FOLLOW", "BINANCE_LEADERBOARD"
source_id String The source identifier
code String Exchange Symbol
symbol String Areix standardized Symbol
traded_at Datetime System Datetime
actual_traded_at Datetime Exchange return datetime

Long Short Ratio

Example:

import requests

headers = {'x-api-key': f"j23JDdj.....iw23end"}

res = requests.get(f'https://areixio.areix-ai.com/longshortratio', headers=headers)
print(res.json)

Payload:


Response:

{
    "data": [
        {
            "created_at": "2022-12-07 13:25:02.196965+08:00",
            "datetime": "2022-12-07 13:25:00",
            "long_notional": 216839.27256385155,
            "long_ratio": 0.07606897542690785,
            "longshort_ratio": 0.0823318769515895,
            "short_notional": 2633721.962774532,
            "short_ratio": 0.9239310245730924
        },
        {
            "created_at": "2022-12-07 13:35:01.990931+08:00",
            "datetime": "2022-12-07 13:35:00",
            "long_notional": 216839.27256385155,
            "long_ratio": 0.07606897542690785,
            "longshort_ratio": 0.0823318769515895,
            "short_notional": 2633721.962774532,
            "short_ratio": 0.9239310245730924
        },
        ...
    ],
    "error": false,
    "msg": "",
    "success": true
}

This endpoint is used to fetch Ola Long Short Ratio

HTTP Request

GET /longshortratio

Response Parameters

Parameter Type Description
short_ratio Decimal Short side ratio
short_notional Decimal Short side notional
longshort_ratio Decimal Long Short Ratio
long_ratio Decimal Long side ratio
long_notional Decimal Long side notional
created_at Datetime The create time

Ola Terminal

Quick Start

demo1.png

1. Import the packaged JS file

Create an html file and import the required libraries and the packaged js file in the header.

Import library:


<!doctype html>
<html lang='en'>
    <head>
        ...
        <title>Ola Terminal</title>
        <script type="module" src="https://unpkg.com/sentiment-widget@1.0.22/dist/esm/sentiment.js"></script>

    </head>
        ...
</html>

2. Use the <sentiment-widget> tag

Use widget:

<!doctype html>
<html lang='en'>
    <head>
        <meta charset='UTF-8'>
        <meta name='viewport' content='width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0'>
        <meta http-equiv='X-UA-Compatible' content='ie=edge'>

        <title>Ola Terminal</title>
        <script type="module" src="https://unpkg.com/sentiment-widget@1.0.22/dist/esm/sentiment.js"></script>
    </head>

    <body>
        <sentiment-widget></sentiment-widget>
    </body>
</html>

demo1.png

3. Custom attributes

4. Example:

As basic user, if you want to initialize and display the event key event using the English interface widget, you can use:

Example:

<sentiment-widget type-prop='event' lang-prop='en'></sentiment-widget>
or
<sentiment-widget lang-prop='en'></sentiment-widget>

If you want to enable WebSocket subscription service, initialize and display the address key whale using the English interface widget, you can use:

<sentiment-widget api-key='xxxxxxx' type-prop='whale' lang-prop='en'></sentiment-widget>

After specify the api-key subscription service, the widget will update in real-time when new records arrive.

Rest API

Endpoint:

Pricing:

Access Standard Advanced Professional Institutional
Price Free $0 $0 Contact us
Rate Limit 30 req/day 60 req/min 600    req/min Custom

API Authentication

Authentication:

$ curl -k -H "Content-Type: application/json" -H "x-api-key: j23JDdj.....iw23end" -X POST -d '{"symbol":"xyz","exchange":"xyz",...}' https://areixio.areix-ai.com/signal
import requests

headers = {'x-api-key': f"j23JDdj.....iw23end}"}

res = requests.get('https://areixio.areix-ai.com/signal', headers=headers)
print(res.json())

Example:

import requests

res = requests.get(f'https://areixio.areix-ai.com/sentiment?type=incidnet', headers=headers)
print(res.json)

Response:

{
    "data": [
        {
            "actual_value": 3.7,
            "category": {
                "BTC": [
                    "Top Assets"
                ],
                "UNI": [
                    "Defi"
                ]
            },
            "confidence": null,
            "content": "In the United States, unadjusted Consumer Price Index for All Urban Consumers is based on the prices of a market basket of: Food (14% of total weight); Energy (8%); Commodities Less Food & Energy Commodities (21%) and Services Less Energy Services (57%). The last category is divided by: Shelter (32%), Medical Care Services (7%) and Transportation Services (6%).",
            "created_at": "2023-10-12 12:44:02",
            "datetime": "2023-10-13 12:30:00",
            "est_confidence": null,
            "est_effective_time": null,
            "est_price_impact": null,
            "est_sentiment": null,
            "est_timeframe": null,
            "event": "Inflation Rate YoY",
            "forecast_value": 3.6,
            "hist_accuracy": null,
            "hist_effective_time": null,
            "hist_price_impact": null,
            "hist_timeframe": null,
            "previous_value": 3.7,
            "sentiment": null,
            "source": "Bureau of Labour Statistics",
            "symbols": [
                "BTC",
                "ETH"
            ],
            "translation": {},
            "type": "incident",
            "url": ""
        }
    ],
    "error": false,
    "msg": "",
    "success": true
}

This endpoint is used to fetch the data on ola terminal

HTTP Request

GET /sentiment?type=<type>

URL Parameters

Parameter Description
type Possible input: incident,whale,abstract

Response Parameters

Parameter Type Description
actual_value float The actual value of the US economic calendar data.
category object The category or categories to which the data belongs.
confidence null The confidence level associated with the data.
content string Additional information or content related to the data.
created_at string The date and time when the data was created.
datetime string The date and time of the event.
est_confidence null The estimated confidence level associated with the data.
est_effective_time null The estimated effective time of the event.
est_price_impact null The estimated price impact of the event.
est_sentiment null The estimated sentiment associated with the event.
est_timeframe null The estimated timeframe in which the event is expected to occur.
event string The type of event.
forecast_value float The forecasted value of the US economic calendar data.
hist_accuracy null The historical accuracy of the data.
hist_effective_time null The historical effective time of the event.
hist_price_impact null The historical price impact of the event.
hist_timeframe null The historical timeframe in which the event occurred.
previous_value float The previous value of the US economic calendar data.
sentiment null The sentiment associated with the event.
source string The source of the data, in this case, the "Bureau of Labour Statistics".
symbols array The symbols or assets related to the data, in this case, "BTC" and "ETH".
translation object Any translation associated with the data.
type string The type of data, in this case, "incident".
url string The URL or link associated with the data (if applicable).

Websocket

Endpoint: wss://stream.areix-ai.com/public/ws

subscribe msg: {'action': 'subscribe_sentiment', 'type':<type>, 'lang':<lang>, 'key':<key>, 'domain':<domain>}

Example: {'action': 'subscribe_sentiment', 'type':'event', 'lang':'zh', 'key':'xxxxx', 'domain':'xxxx.com'}

Ola Algo

Screener

demo1.png

Price Patterns

Price Patterns Strategy is crafted to exploit price movements across a spectrum of timeframes within the different sector.

It is closely monitoring price movements over various time periods (short term/ mid term/ long term) and continuouslly adjusting the parameters of each indicator based on real-time market data and historical patterns. This allows the strategy to adapt and refine its analysis for different timeframes, ensuring that it can effectively capture and respond to market movements at each interval.

This strategy offers a balanced risk and high market adaptability profile as it is able to dynamically adjust to changing market conditions, providing consistent performance over time. Also, it helps mitigate risks associated with short-term volatility and capitalizes on longer-term trends while still capturing short-term opportunities.

The themes:

SMC

Smart Money Concept is a dynamic trading approach designed to capitalize on liquidity patterns in the market. By closely monitoring liquidity movements and identifying significant shifts, the strategy aims to capture profitable trading opportunities. It leverages advanced algorithms and data analysis techniques to track and interpret liquidity trends, providing investors with a strategic edge in their decision-making process.

Key Features:

Smart DCA

Smart DCA is a strategy designed to improve upon the common standard DCA (Dollar Cost Averaging) investment strategy.

It meticulously crafted to optimize asset accumulation over time by consistently investing fixed amounts but also performs effectively in sideways markets and uptrends

Regardless of market fluctuations, Smart DCA offers a disciplined and systematic strategy. Unlike attempting to time the market or predict short-term movements, this approach prioritizes long-term growth and risk mitigation.

Arbitrage

Statistical Arbitrage

Asset Value Arbitrage

Funding Rate Arbitrage

Momentum

We typically wish to bet when there is a confluence of factors whose predicted outcome offers a favorable risk-adjusted return. Structural breaks, like the transition from one market regime to another, is one example of such a confluence that is of particular interest. For instance, a meanreverting pattern may give way to a momentum pattern. As this transition takes place, most market participants are caught off guard, and they will make costly mistakes. This sort of errors is the basis for many profitable strategies, because the actors on the losing side will typically become aware of their mistake once it is too late. Before they accept their losses, they will act irrationally, try to hold the position, and hope for a comeback. Sometimes they will even increase a losing position, in desperation. Eventually they will be forced to stop loss or stop out.

Trading Strategy: Entry with appearance of SADF indictor

Errors

The Areix API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- The api requested is hidden for administrators only.
404 Not Found -- The specified api could not be found.
405 Method Not Allowed -- You tried to access a api with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
410 Gone -- The api requested has been removed from our servers.
418 I'm a teapot.
429 Too Many Requests -- You're requesting too many apis! Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.
504 Gateway Timeout -- The api timout