Admin Endpoints

These endpoints need an admin API key, and the exchange's Admin API endpoints setting must be turned on in Operator Controls. It is off by default, and admin API keys are refused while it is off. See API Keys. Sign every request as described in Signing Requests.

Exchange Info

Request

curl -X GET "https://<your-api-domain>/v2/admin/exchange"

Response

{
   "id": 781,
    "name": "testexchange429",
    "expiry": "2022-03-30T13:19:06.283Z",
    "url": "localhost",
    "active": true,
    "is_trial": false,
    "created_at": "2022-03-28T13:19:06.284Z",
    "coins": [
        "btc",
        "usdt",
        "eth"
    ],
    "pairs": [
        "btc-usdt",
        "eth-usdt",
        "eth-btc"
    ],
    "plan": null,
    "period": null
}

Get general exchange information such as coins & pairs

HTTP Request

GET https://<your-api-domain>/v2/admin/exchange

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user to filter by

Create User

Request

curl -X POST "https://<your-api-domain>/v2/admin/user"

Response

{
   "message": "Success"
}

Create a new user on the exchange

HTTP Request

POST https://<your-api-domain>/v2/admin/user

PARAMETERS

Parameter	Type	Required/Optional	Description
email	string	Required	The mail address for the user
password	string	Required	The password for the user
referral	string	Optional	The referral code for the user

Exchange Users List

Request

curl -X GET "https://<your-api-domain>/v2/admin/users"

Response

{
   "count": 1,
    "data": [
        {
            "id": 346,
            "email": "23423f4@gmail.com",
            "full_name": "",
            "gender": false,
            "nationality": "",
            "dob": null,
            "phone_number": "",
            "address": {
                "city": "",
                "address": "",
                "country": "",
                "postal_code": ""
            },
            "id_data": {
                "note": "",
                "type": "",
                "number": "",
                "status": 0,
                "issued_date": "",
                "expiration_date": ""
            },
            "bank_account": [],
            "crypto_wallet": {},
            "verification_level": 1,
            "email_verified": true,
            "otp_enabled": false,
            "activated": true,
            "note": "",
            "username": "23423f4",
            "affiliation_code": "1RSWRK",
            "settings": {
                "chat": {
                    "set_username": false
                },
                "risk": {
                    "order_portfolio_percentage": 90
                },
                "audio": {
                    "public_trade": false,
                    "order_completed": true,
                    "order_partially_completed": true
                },
                "language": "en",
                "interface": {
                    "theme": "dark",
                    "order_book_levels": 10
                },
                "notification": {
                    "popup_order_completed": true,
                    "popup_order_confirmation": true,
                    "popup_order_partially_filled": true
                }
            },
            "flagged": false,
            "affiliation_rate": 0,
            "network_id": 11262,
            "discount": 0,
            "meta": {},
            "created_at": "2023-04-10T20:44:34.717Z",
            "updated_at": "2023-04-10T20:44:35.799Z"
        },
    ]
}

Retrieve a list of users by admin

HTTP Request

GET https://<your-api-domain>/v2/admin/users

PARAMETERS

Parameter	Type	Required/Optional	Description
id	number	Optional	The identifier of the user to filter by
user_id	number	Optional	The identifier of the user to filter by
limit	number	Optional	Amount of referrals per page. Maximum: 50. Default: 50
page	number	Optional	Page of referral data. Default: 1
order_by	string	Optional	The field to order data by e.g. amount, id.
order	string	Optional	Ascending (asc) or descending (desc).
start_date	date	Optional	Start date of query in ISO8601 format.
end_date	date	Optional	End date of query in ISO8601 format.
search	string	Optional	The search text to filter by, pass undefined to receive data on all fields
pending	boolean	Optional	The pending field to filter by, pass undefined to receive all data
pending_type	string	Optional	The pending type info to filter by, pass undefined to receive data
format	string	Optional	Custom format of data set. Enum: ['all', 'csv']

User Referrer

Request

curl -X GET "https://<your-api-domain>/v2/admin/user/referer"

Response

{
    "email": {
        "created_at": "2020-01-18T18:35:02.418Z",
        "updated_at": "2020-01-18T18:35:02.418Z",
        "referer": {
            "id": 1,
            "email": "test@mail.com"
        }
    }
}

Retrieve a user's referer info by admin

HTTP Request

GET https://<your-api-domain>/v2/admin/user/referer

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user to filter by

User Referrals

Request

curl -X GET "https://<your-api-domain>/v2/admin/user/affiliation"

Response

{
    "count": 1,
    "data": [
        {
            "referrer_id": 1,
            "user": {
                "id": 10,
                "email": "test@mail.com"
            }
        },
    ]
}

Retrieve a user's referrals list by admin

HTTP Request

GET https://<your-api-domain>/v2/admin/user/affiliation

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user to filter by
limit	number	Optional	Amount of referrals per page. Maximum: 50. Default: 50
page	number	Optional	Page of referral data. Default: 1
order_by	string	Optional	The field to order data by e.g. amount, id.
order	string	Optional	Ascending (asc) or descending (desc).
start_date	date	Optional	Start date of query in ISO8601 format.
end_date	date	Optional	End date of query in ISO8601 format.

Activate User

Request

curl -X POST "https://<your-api-domain>/v2/admin/user/activate"

Response

{
   "message": "Success"
}

Activate a frozen user account by admin

HTTP Request

POST https://<your-api-domain>/v2/admin/user/activate

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user to filter by
activated	boolean	Requred	The option to activate or deactivate

Deactive OTP

Request

curl -X POST "https://<your-api-domain>/v2/admin/deactivate-otp"

Response

{
    "message": "Success"
}

Deactivate user's otp by admin

HTTP Request

POST https://<your-api-domain>/v2/admin/deactivate-otp

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user to filter by

User Logins List

Request

curl -X GET "https://<your-api-domain>/v2/admin/logins"

Response

{
    "count": 1,
    "data": [
        {
            "ip": "172.19.0.1",
            "device": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36",
            "domain": "http://localhost:3000",
            "timestamp": "2023-04-16T11:24:22.197Z",
            "user_id": 1,
            "UserId": 1
        },
    ]
}

Retrieve user's login info by admin

HTTP Request

GET https://<your-api-domain>/v2/admin/logins

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user to filter by
limit	number	Optional	Amount of referrals per page. Maximum: 50. Default: 50
page	number	Optional	Page of referral data. Default: 1
order_by	string	Optional	The field to order data by e.g. amount, id.
order	string	Optional	Ascending (asc) or descending (desc).
start_date	date	Optional	Start date of query in ISO8601 format.
end_date	date	Optional	End date of query in ISO8601 format.

Create User Bank

Request

curl -X POST "https://<your-api-domain>/v2/admin/user/bank"

Response

{
   "message": "Success"
}

Create a bank or payment account for a user by admin

HTTP Request

POST https://<your-api-domain>/v2/admin/user/bank

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user to filter by
bank_account	object	Required	Array of objects with bank account info

User Balance

Request

curl -X GET "https://<your-api-domain>/v2/admin/user/balance"

Response

{
    "user_id": 1,
    "btc_balance": 0.4972535,
    "btc_available": 0.4972535,
    "usdt_balance": 38860.29955,
    "usdt_available": 38857.29955,
    "eth_balance": 0,
    "eth_available": 0
}

Retrieve a user's balance by admin

HTTP Request

GET https://<your-api-domain>/v2/admin/user/balance

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user to filter by

Users Balances

Request

curl -X GET "https://<your-api-domain>/v2/admin/balances"

Response

{
   "count": 356,
   "data": [
    {
      "balance": "2.0010000000000000",
      "available": "2.0010000000000000",
      "symbol": "usdt",
      "updated_at": "2022-02-17T08:27:10.637Z",
      "user_id": 150,
      "network_id": 582
    },
    {
      "balance": "2.0110000000000000",
      "available": "2.0110000000000000",
      "symbol": "usdt",
      "updated_at": "2022-02-17T09:07:46.303Z",
      "user_id": 33,
      "network_id": 324
    },
    {
      "balance": "49108.1478000000000000",
      "available": "49108.1478000000000000",
      "symbol": "usdt",
      "updated_at": "2023-02-21T18:37:58.966Z",
      "user_id": 8,
      "network_id": 138
    },
    {
      "balance": "2.1000000000000000",
      "available": "2.1000000000000000",
      "symbol": "usdt",
      "updated_at": "2023-05-22T12:07:39.124Z",
      "user_id": 11,
      "network_id": 188
    },
    {
      "balance": "5.0000000000000000",
      "available": "5.0000000000000000",
      "symbol": "usdt",
      "updated_at": "2023-07-03T14:22:28.277Z",
      "user_id": 1664,
      "network_id": 12392
    },
    {
      "balance": "1.0000000000000000",
      "available": "1.0000000000000000",
      "symbol": "usdt",
      "updated_at": "2022-02-17T08:25:37.498Z",
      "user_id": 136,
      "network_id": 568
    },

    ...
   ]
}

Retrieve a list of balances from multiple users by admin

HTTP Request

GET https://<your-api-domain>/v2/admin/balances

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Optional	The identifier of the user
currency	string	Optional	The currency symbol, e.g. btc
format	string	Optional	Pass value 'all' to download csv file

Exchange Total Balance

Request

curl -X GET "https://<your-api-domain>/v2/admin/balance"

Response

{
    "btc_balance": 0.50727102,
    "btc_available": 0.50727102,
    "usdt_balance": 40030.93636929621,
    "usdt_available": 40026.73636929621,
    "eth_balance": 0.0001996,
    "eth_available": 0.0001996,
    "try_balance": 0,
    "try_available": 0
}

Retrieve the total balance of all users on the exchange

HTTP Request

GET https://<your-api-domain>/v2/admin/balance

PARAMETERS

Parameter	Type	Required/Optional	Description

Create User Wallet

Request

curl -X POST "https://<your-api-domain>/v2/admin/user/wallet"

Response

{
   "message": "Success"
}

Create a wallet for a user on the exchange

HTTP Request

POST https://<your-api-domain>/v2/admin/user/wallet

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user
crypto	number	Required	The coin for the wallet e.g btc, eth
network	number	Optional	The network info

Wallets List

Request

curl -X GET "https://<your-api-domain>/v2/admin/user/wallet"

Response

{
    "count": 1,
    "data": [
        {
            "currency": "btc",
            "address": "31j36fxNCt51mtMd15DMF9UyEb5YmGx3bZ",
            "network": "btc",
            "standard": null,
            "is_valid": true,
            "created_at": "2023-03-31T01:08:40.987Z",
            "updated_at": "2023-03-31T01:08:40.987Z",
            "User": {
                "email": "testmail12@gmail.com",
                "exchange_id": 781
            },
            "network_id": 10509
        },
    ]
}

Retrieve users' wallets information by admin

HTTP Request

GET https://<your-api-domain>/v2/admin/user/wallet

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Optional	The identifier of the user to filter by
limit	number	Optional	Amount of referrals per page. Maximum: 50. Default: 50
page	number	Optional	Page of referral data. Default: 1
order_by	string	Optional	The field to order data by e.g. amount, id.
order	string	Optional	Ascending (asc) or descending (desc).
start_date	date	Optional	Start date of query in ISO8601 format.
end_date	date	Optional	End date of query in ISO8601 format.
address	string	Optional	Address of crypto
is_valid	boolean	Optional	Specify whether or not wallet is valid
network	string	Optional	Crypto network of currency
format	string	Optional	Custom format of data set. Enum: ['all', 'csv']

Update User role

Request

curl -X PUT "https://<your-api-domain>/v2/admin/user/role"

Response

{
   "message": "Success"
}

Update exchange user role

HTTP Request

PUT https://<your-api-domain>/v2/admin/user/role

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user
role	string	Required	The role of the user

Update User meta

Request

curl -X PUT "https://<your-api-domain>/v2/admin/user/meta"

Response

{
   "message": "Success"
}

Update exchange user meta

HTTP Request

PUT https://<your-api-domain>/v2/admin/user/meta

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user
meta	object	Required	The meta object of the user
overwrite	boolean	Optional	The overwrite field

Update User discount

Request

curl -X PUT "https://<your-api-domain>/v2/admin/user/discount"

Response

{
   "message": "Success"
}

Update exchange user discount fee reduction

HTTP Request

PUT https://<your-api-domain>/v2/admin/user/discount

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user
discount	number	Required	The discount number of the user

Update User note

Request

curl -X PUT "https://<your-api-domain>/v2/admin/user/note"

Response

{
   "message": "Success"
}

Update exchange user note which is used to store additional information about the user

HTTP Request

PUT https://<your-api-domain>/v2/admin/user/note

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user
note	string	Required	The note text of the user

Update User tier

Request

curl -X POST "https://<your-api-domain>/v2/admin/upgrade-user"

Response

{
   "message": "Success"
}

Update exchange user tier (verification level)

HTTP Request

POST https://<your-api-domain>/v2/admin/upgrade-user

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user
verification_level	number	Required	The verification_level of the user

Delete User

Request

curl -X POST "https://<your-api-domain>/v2/admin/user"

Response

{
   "message": "Success"
}

Create exchange user

HTTP Request

DELETE https://<your-api-domain>/v2/admin/user

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The id for the user

Create User Order

Request

curl -X POST "https://<your-api-domain>/v2/admin/order"

Response

{
  "fee": 0,
  "meta": {},
  "symbol": "btc-usdt",
  "side": "buy",
  "size": 0.01,
  "type": "limit",
  "price": 60000,
  "fee_structure": { "maker": 0.186, "taker": 0.186 },
  "fee_coin": "btc",
  "id": "a80b5c7f-be88-4d24-b134-cfb7b31b6d7d",
  "created_by": 10792,
  "filled": 0,
  "filled": 0,
  "average": 0.1,
  "status": "new",
  "updated_at": "2023-12-12T23:51:22.239Z",
  "created_at": "2023-12-12T23:51:22.239Z",
  "stop": null
}

Create am order on behalf of a user

HTTP Request

POST https://<your-api-domain>/v2/admin/order

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	User id for the order
symbol	string	Required	Currency symbol of the order e.g. btc-usdt
size number	Required	Amount of the order
price	number	Required	Order Price
side	string	Required	Order Side, buy or sell
type	string	Required	Order Type, limit or market

Cancel User Order

Request

curl -X DELETE "https://<your-api-domain>/v2/admin/order"

Response

{
   "message": "Success"
}

Cancel a user's order by order id

HTTP Request

DELETE https://<your-api-domain>/v2/admin/order

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Optional	The identifier of the user to filter by

Orders List

Request

curl -X GET "https://<your-api-domain>/v2/admin/orders"

Response

{
   "count": 1,
    "data": [
        {
            "id": "21c2be80-a2d8-4797-9ed9-caf83c631586",
            "side": "buy",
            "symbol": "btc-usdt",
            "size": 0.1,
            "filled": 0,
            "stop": null,
            "fee": 0,
            "fee_coin": "btc",
            "type": "limit",
            "price": 60000,
            "status": "new",
            "created_by": 1,
            "created_at": "2023-04-10T21:48:13.691Z",
            "updated_at": "2023-04-10T21:48:13.691Z",
            "meta": {},
            "average": 0.3,
            "User": {
                "id": 1,
                "email": "test15@mail.com_m3cc4",
                "username": "test15",
                "exchange_id": 781
            },
            "network_id": 10792
        },
    ]
}

Retrieve user's orders list by admin

HTTP Request

GET https://<your-api-domain>/v2/admin/orders

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Optional	The identifier of the user to filter by
limit	number	Optional	Amount of referrals per page. Maximum: 50. Default: 50
side	string	Optional	The order side (buy or side)
status	string	Optional	The order's status e.g open, filled, canceled etc
open	boolean	Optional	The info on whether the order is active or not
page	number	Optional	Page of referral data. Default: 1
bank_key	string	Optional	Bank query key to fetch specific bank
bank_value	string	Optional	Bank query value to fetch specific bank
order_by	string	Optional	The field to order data by e.g. amount, id.
order	string	Optional	Ascending (asc) or descending (desc).
start_date	date	Optional	Start date of query in ISO8601 format.
end_date	date	Optional	End date of query in ISO8601 format.
format	string	Optional	Custom format of data set. Enum: ['all', 'csv']

Create Trade

Request

curl -X POST "https://<your-api-domain>/v2/admin/trade"

Response

{
{
    "side": "buy",
    "symbol": "xrp-usdt",
    "size": 10,
    "price": 0.6,
    "maker_order_id": "05018676-d8f0-420d-abc0-3c199fb84f4c",
    "taker_order_id": "4d62d466-fbdb-4819-b60a-8aba3ad1c3e9",
    "timestamp": "2024-02-27T04:43:57.183Z",
    "maker_fee": 0.003,
    "taker_fee": 0.05,
    "maker_fee_coin": "usdt",
    "taker_fee_coin": "xrp",
    "quick": false,
    "maker_id": 1436,
    "taker_id": 1,
    "maker_network_id": 11186,
    "taker_network_id": 90
}
}

Create a trade between two users at a specific price

HTTP Request

POST https://<your-api-domain>/v2/admin/trade

PARAMETERS

Parameter	Type	Required/Optional	Description
maker_id	number	Required	User id for the maker
taker_id	number	Required	User id for the taker
maker_fee	number	Required	fee in percentage for the maker
taker_fee	number	Required	fee in percentage for the taker
symbol	string	Required	Currency symbol of the order e.g. btc-usdt
size number	Required	Amount of the order
price	number	Required	Order Price
side	string	Required	Order Side, buy or sell

Trades List

Request

curl -X GET "https://<your-api-domain>/v2/admin/trades"

Response

{
   "count": 1,
    "data": [
        {
            "side": "buy",
            "symbol": "btc-usdt",
            "size": 0.01,
            "price": 60500,
            "maker_order_id": null,
            "taker_order_id": "c3a29aa8-0e8a-40f7-9057-a873dba65402",
            "timestamp": "2023-03-09T20:09:33.379Z",
            "maker_fee": null,
            "taker_fee": 0.002,
            "maker_fee_coin": null,
            "taker_fee_coin": "btc",
            "quick": false,
            "maker_id": null,
            "taker_id": 1,
            "taker_network_id": 10792
        },
    ]
}

Retrieve user's trades list by admin

HTTP Request

GET https://<your-api-domain>/v2/admin/trades

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Optional	The identifier of the user to filter by
limit	number	Optional	Amount of referrals per page. Maximum: 50. Default: 50
side	string	Optional	The order side (buy or side)
symbol	string	Optional	The symbol-pair to filter by, pass undefined to receive data on all currencies
page	number	Optional	Page of referral data. Default: 1
order_by	string	Optional	The field to order data by e.g. amount, id.
order	string	Optional	Ascending (asc) or descending (desc).
start_date	date	Optional	Start date of query in ISO8601 format.
end_date	date	Optional	End date of query in ISO8601 format.
format	string	Optional	Custom format of data set. Enum: ['all', 'csv']

Transfer Assets

Request

curl -X POST "https://<your-api-domain>/v2/admin/transfer"

Response

{
   "message": "Success"
}

Transfer an asset between two users by admin

HTTP Request

POST https://<your-api-domain>/v2/admin/transfer

PARAMETERS

Parameter	Type	Required/Optional	Description
sender_id	number	Required	The identifier of the sender
receiver_id	number	Required	The identifier of the receiver
currency	string	Required	The currency to specify
amount	number	Required	The amount to specify
description	string	Optional	The description field
email	boolean	Optional	The email field

Crypto Withdrawal

Request

curl -X POST
  -H "api-key: $API_KEY"
  -H "api-signature: $API_SIGNATURE"
  -H "api-expires: $API_EXPIRES"
  -H "Content-Type: application/json"
  -d '{"user_id":$user_id,"currency":$currency,"amount":$amount,"address":$address}'
  "https://<your-api-domain>/v2/admin/withdrawal"

Response

{
    "message": "Withdrawal request is in the queue and will be processed.",
    "id": 1000,
    "transaction_id": "d696dd5d-3226-4662-8d86-3da3d8eb68ff",
    "amount": 0.01,
    "currency": "btc",
    "fee": 0.0005,
    "fee_coin": "btc"
}

This endpoint directly creates a withdrawal on behalf of a user, only available via HMAC tokens with the withdrawal permission.

HTTP Request

POST https://<your-api-domain>/v2/admin/withdrawal

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	user id for the withdrawal process
currency	string	Required	The desired currency e.g. btc
amount	number	Required	The amount to withdrawal e.g. 5
address	string	Required	The recipient wallet's address
network	string	Optional	Network of currency being withdrawn if there are multiple networks for currency

Check Deposit status

Request

curl -X GET "https://<your-api-domain>/v2/admin/check-transaction"

Response

{

}

Check the status of a transaction on the blockchain. This is useful for when a deposit is missing or its left as pending on the blockchain

HTTP Request

GET https://<your-api-domain>/v2/admin/check-transaction

PARAMETERS

Parameter	Type	Required/Optional	Description
currency	string	Required	The currency to filter by, pass undefined to receive data on all currencies
transaction_id	string	Required	Deposits with specific transaction ID.
address	string	Required	Deposits with specific address.
network	string	Required	The network info
is_testnet	boolean	Optional	The info on whether it's a testnet or not

Create Manual Deposit

Request

curl -X POST "https://<your-api-domain>/v2/admin/mint"

Response

{
   "message": "Success"
}

Create a manual deposit for a user by admin. This is called minting assets and can only be done for fiat assets and assets you have created in the system.

HTTP Request

POST https://<your-api-domain>/v2/admin/mint

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user to filter by
currency	string	Required	The currency to specify
amount	number	Required	The amount to specify
transaction_id	string	Optional	Withdrawal with specific transaction ID.
status	boolean	Optional	The status field to confirm the withdrawal
email	boolean	Optional	The email field
fee	number	Optional	The fee to specify

Update Deposit

Request

curl -X PUT "https://<your-api-domain>/v2/admin/mint"

Response

{
   "message": "Success"
}

Update the status of a manually created deposit on the exchange

HTTP Request

PUT https://<your-api-domain>/v2/admin/mint

PARAMETERS

Parameter	Type	Required/Optional	Description
transaction_id	string	Required	Withdrawals with specific transaction ID.
updated_transactionId	string	Optional	Withdrawals with updated transaction id
updated_address	string	Optional	Withdrawals with updated address
status	boolean	Optional	Confirmed status of the withdrawals to set.
dismissed	boolean	Optional	Dismissed status of the withdrawals to set.
rejected	boolean	Optional	Rejected status of the withdrawals to set.
processing	boolean	Optional	Processing status of the withdrawals to set.
waiting	boolean	Optional	Waiting status of the withdrawals to set.
email	boolean	Optional	Email
description	string	Optional	The description field

Create Manual Withdrawal

Request

curl -X POST "https://<your-api-domain>/v2/admin/burn"

Response

{
   "message": "Success"
}

Create a manual withdrawal for a user by admin. This is called burning assets and can only be done for fiat assets and assets you have created in the system.

HTTP Request

POST https://<your-api-domain>/v2/admin/burn

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user to filter by
currency	string	Required	The currency to specify
amount	number	Required	The amount to specify
transaction_id	string	Optional	Withdrawal with specific transaction ID.
status	boolean	Optional	The status field to confirm the withdrawal
email	boolean	Optional	The email field
fee	number	Optional	The fee to specify

Update Withdrawal

Request

curl -X PUT "https://<your-api-domain>/v2/admin/burn"

Response

{
   "message": "Success"
}

Update the status of a manually created withdrawal on the exchange

HTTP Request

PUT https://<your-api-domain>/v2/admin/burn

PARAMETERS

Parameter	Type	Required/Optional	Description
transaction_id	string	Required	Withdrawals with specific transaction ID.
updated_transactionId	string	Optional	Withdrawals with updated transaction id
updated_address	string	Optional	Withdrawals with updated address
status	boolean	Optional	Confirmed status of the withdrawals to set.
dismissed	boolean	Optional	Dismissed status of the withdrawals to set.
rejected	boolean	Optional	Rejected status of the withdrawals to set.
processing	boolean	Optional	Processing status of the withdrawals to set.
waiting	boolean	Optional	Waiting status of the withdrawals to set.
email	boolean	Optional	Email
description	string	Optional	The description field

Deposits List

Request

curl -X GET "https://<your-api-domain>/v2/admin/deposits"

Response

{

   {
    "count": 1,
    "data": [
        {
            "id": 11104,
            "amount": 5,
            "fee": 0,
            "address": "transfer",
            "transaction_id": "0200a457-1965-45de-ac08-03699d44c7f6",
            "status": true,
            "dismissed": false,
            "rejected": false,
            "processing": false,
            "waiting": false,
            "description": "Admin Transfer",
            "type": "deposit",
            "currency": "usdt",
            "network": null,
            "fee_coin": "usdt",
            "created_at": "2023-04-16T20:49:01.228Z",
            "updated_at": "2023-04-16T20:49:01.228Z",
            "user_id": 10,
            "User": {
                "email": "test_auth9126@mail.com_vow05",
                "exchange_id": 781,
                "Exchange": {
                    "id": 781,
                    "name": "testexchange429",
                    "display_name": "test-exchange429"
                },
                "id": 10
            },
            "network_id": 10871
        },
    ]
   }
}

Retrieve a list of the user's deposits by admin

HTTP Request

GET https://<your-api-domain>/v2/admin/deposits

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Optional	The identifier of the user to filter by
currency	string	Optional	The currency pair symbol
limit	number	Optional	Number of elements to return. Default: 50. Maximum: 100
page	number	Optional	Page of data to retrieve
order_by	string	Optional	Field to order data
order	string	Optional	asc or desc
transaction_id	string	Optional	Get deposits with this transaction ID
address	string	Optional	Get deposits made to this address
status	boolean	Optional	Completed status of deposits to get
dismissed	boolean	Optional	Dismissed status of deposits to get
rejected	boolean	Optional	Rejected status of deposits to get
processing	boolean	Optional	Processing status of deposits to get
waiting	boolean	Optional	Waiting status of deposits to get
start_date	date-time	Optional	Starting date of queried data in ISO 8601 format
end_date	date-time	Optional	Ending date of queried data in ISO 8601 format
format	string	Optional	Pass value csv to download csv file

Withdrawals List

Request

curl -X GET "https://<your-api-domain>/v2/admin/withdrawals"

Response

{
   "count": 1,
    "data": [
        {
            "id": 11103,
            "amount": 5,
            "fee": 0,
            "address": "transfer",
            "transaction_id": "0200a457-1965-45de-ac08-03699d44c7f6",
            "status": true,
            "dismissed": false,
            "rejected": false,
            "processing": false,
            "waiting": false,
            "description": "Admin Transfer",
            "type": "withdrawal",
            "currency": "usdt",
            "network": null,
            "fee_coin": "usdt",
            "created_at": "2023-04-16T20:49:01.228Z",
            "updated_at": "2023-04-16T20:49:01.228Z",
            "user_id": 1,
            "User": {
                "email": "test15@mail.com_m3cc4",
                "exchange_id": 781,
                "Exchange": {
                    "id": 781,
                    "name": "testexchange429",
                    "display_name": "test-exchange429"
                },
                "id": 1
            },
            "network_id": 10792
        },
    ]
}

Retrieve a list of the user's withdrawals by admin

HTTP Request

GET https://<your-api-domain>/v2/admin/withdrawals

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Optional	The identifier of the user to filter by
currency	string	Optional	The currency pair symbol
limit	number	Optional	Number of elements to return. Default: 50. Maximum: 100
page	number	Optional	Page of data to retrieve
order_by	string	Optional	Field to order data
order	string	Optional	asc or desc
transaction_id	string	Optional	Get deposits with this transaction ID
address	string	Optional	Get deposits made to this address
status	boolean	Optional	Completed status of deposits to get
dismissed	boolean	Optional	Dismissed status of deposits to get
rejected	boolean	Optional	Rejected status of deposits to get
processing	boolean	Optional	Processing status of deposits to get
waiting	boolean	Optional	Waiting status of deposits to get
start_date	date-time	Optional	Starting date of queried data in ISO 8601 format
end_date	date-time	Optional	Ending date of queried data in ISO 8601 format
format	string	Optional	Pass value csv to download csv file

Send Email to User

Request

curl -X POST "https://<your-api-domain>/v2/admin/send-email"

Response

{
   "message": "Success"
}

Send an email to a user account by admin

HTTP Request

POST https://<your-api-domain>/v2/admin/send-email

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Required	The identifier of the user
mail_type	string	Required	The mail type for the email payload
data	object	Required	The content of the mail

Send Raw Email

Request

curl -X POST "https://<your-api-domain>/v2/admin/send-email/raw"

Response

{
   "message": "Success"
}

Send an email to users with a custom html by admin

HTTP Request

POST https://<your-api-domain>/v2/admin/send-email/raw

PARAMETERS

Parameter	Type	Required/Optional	Description
receivers	array	Required	The array of emails to send mail
html	string	Required	The stringified html content
title	string	Optional	The title of the mail
text	string	Optional	The text of the mail

Settle Fees

Request

curl -X GET "https://<your-api-domain>/v2/admin/fees/settle"

Response

{
    "message": "Success"
}

Settle the exchange fees by admin to a specific user account

HTTP Request

GET https://<your-api-domain>/v2/admin/fees/settle

PARAMETERS

Parameter	Type	Required/Optional	Description
user_id	number	Optional	The identifier of the user to filter by

Create Exchange Stakes

Request

curl -X POST "https://<your-api-domain>/v2/admin/stake" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "MATURE USDT",
    "user_id": 1,
    "currency": "usdt",
    "account_id": 228,
    "apy": 10,
    "min_amount": 1,
    "max_amount": 100,
    "early_unstake": false,
    "status": "active"
  }'

Response

{
  "message": "Success"
}

Create new exchange stakes

HTTP Request

POST https://<your-api-domain>/v2/admin/stake

PARAMETERS

Parameter	Type	Required/Optional	Description
name	string	Required	Name of the stake pool (max 256 chars)
user_id	number	Required	User ID associated with stake pool
currency	string	Required	Currency of the stake pool
account_id	number	Required	Account ID
apy	number	Required	Annual Percentage Yield
min_amount	number	Required	Minimum stake amount
max_amount	number	Required	Maximum stake amount
early_unstake	boolean	Required	Whether early unstake is allowed
status	string	Required	Pool status (uninitialized/active/paused/terminated)
reward_currency	string	Optional	Currency for rewards
duration	number	Optional	Duration in days
slashing	boolean	Optional	Whether slashing is enabled
slashing_earning_percentage	number	Optional	Slashing percentage for earnings
slashing_principle_percentage	number	Optional	Slashing percentage for principle
onboarding	boolean	Optional	Whether pool is for onboarding
disclaimer	string	Optional	Disclaimer text

Update Exchange Stakes

Request

curl -X PUT "https://<your-api-domain>/v2/admin/stake" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 43,
    "apy": 12,
    "status": "paused"
  }'

Response

{
  "message": "Success"
}

Update exchange stakes

HTTP Request

PUT https://<your-api-domain>/v2/admin/stake

PARAMETERS

Parameter	Type	Required/Optional	Description
id	number	Required	ID of the stake pool to update
name	string	Optional	Name of the stake pool
user_id	number	Optional	User ID associated with stake pool
currency	string	Optional	Currency of the stake pool
account_id	number	Optional	Account ID
apy	number	Optional	Annual Percentage Yield
min_amount	number	Optional	Minimum stake amount
max_amount	number	Optional	Maximum stake amount
early_unstake	boolean	Optional	Whether early unstake is allowed
status	string	Optional	Pool status (uninitialized/active/paused/terminated)

Delete Exchange Stakes

Request

curl -X DELETE "https://<your-api-domain>/v2/admin/stake" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 43
  }'

Response

{
  "message": "Success"
}

Delete exchange stakes

HTTP Request

DELETE https://<your-api-domain>/v2/admin/stake

PARAMETERS

Parameter	Type	Required/Optional	Description
id	number	Required	ID of the stake pool to delete

Get Exchange Stakers

Request

curl -X GET "https://<your-api-domain>/v2/admin/stakers"

Response

{
  "count": 14,
  "data": [
    {
      "id": 142,
      "user_id": 1,
      "stake_id": 43,
      "amount": 10,
      "currency": "usdt",
      "reward_currency": "usdt",
      "reward": 0.00277777777777778,
      "slashed": 0,
      "status": "closed",
      "closing": "2024-10-23T18:20:46.498Z",
      "unstaked_date": "2024-10-28T00:00:00.033Z",
      "created_at": "2024-10-08T18:20:47.571Z",
      "updated_at": "2024-11-10T00:00:01.903Z"
    }
  ]
}

Get exchange stakers information

HTTP Request

GET https://<your-api-domain>/v2/admin/stakers

PARAMETERS

Parameter	Type	Required/Optional	Description
opts.id	number	Optional	Unique identifier for the staker entry
opts.user_id	number	Optional	The ID of the user who staked
opts.stake_id	number	Optional	The ID of the stake pool
opts.currency	string	Optional	The currency in which the user staked
opts.limit	number	Optional	Number of elements to return. Default: 50. Maximum: 100
opts.page	number	Optional	Page of data to retrieve
opts.order_by	string	Optional	Field to order data
opts.order	string	Optional	Direction to order (asc/desc)
opts.start_date	string	Optional	Starting date in ISO8601 format
opts.end_date	string	Optional	Ending date in ISO8601 format
opts.format	string	Optional	Data format (csv/all)

Update Exchange Staker

Request

curl -X PUT "https://<your-api-domain>/v2/admin/staker" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 142,
    "nav": 10,
    "reward": 0.0028,
    "status": "staking"
  }'

Response

{
  "message": "Success"
}

Update exchange staker values for admin

HTTP Request

PUT https://<your-api-domain>/v2/admin/staker

PARAMETERS

Parameter	Type	Required/Optional	Description
id	number	Required	Unique identifier for the staker entry
nav	number	Optional	Net asset value of the staker entry
reward	number	Optional	Reward value of the staker entry
status	string	Optional	Staker status (staking/unstaking/closed)

Get Stake Analytics

Request

curl -X GET "https://<your-api-domain>/v2/admin/stake/analytics"

Response

{
  "stakingAmount": [
    {
      "currency": "usdt",
      "total_amount": 317.25
    }
  ],
  "unstakingAmount": [
    {
      "currency": "usdt",
      "total_amount": 8.5
    }
  ]
}

Get staking and unstaking analytics

HTTP Request

GET https://<your-api-domain>/v2/admin/stake/analytics

PARAMETERS

Parameter	Type	Required/Optional	Description

Exchange Info​

HTTP Request​

PARAMETERS​

Create User​

HTTP Request​

PARAMETERS​

Exchange Users List​

HTTP Request​

PARAMETERS​

User Referrer​

HTTP Request​

PARAMETERS​

User Referrals​

HTTP Request​

PARAMETERS​

Activate User​

HTTP Request​

PARAMETERS​

Deactive OTP​

HTTP Request​

PARAMETERS​

User Logins List​

HTTP Request​

PARAMETERS​

Create User Bank​

HTTP Request​

PARAMETERS​

User Balance​

HTTP Request​

PARAMETERS​

Users Balances​

HTTP Request​

PARAMETERS​

Exchange Total Balance​

HTTP Request​

PARAMETERS​

Create User Wallet​

HTTP Request​

PARAMETERS​

Wallets List​

HTTP Request​

PARAMETERS​

Update User role​

HTTP Request​

PARAMETERS​

Update User meta​

HTTP Request​

PARAMETERS​

Update User discount​

HTTP Request​

PARAMETERS​

Update User note​

HTTP Request​

PARAMETERS​

Update User tier​

HTTP Request​

PARAMETERS​

Delete User​

HTTP Request​

PARAMETERS​

Create User Order​

HTTP Request​

PARAMETERS​

Cancel User Order​

HTTP Request​

PARAMETERS​

Orders List​

HTTP Request​

PARAMETERS​

Create Trade​

HTTP Request​

PARAMETERS​

Trades List​

HTTP Request​

PARAMETERS​

Transfer Assets​

HTTP Request​

PARAMETERS​

Crypto Withdrawal​

HTTP Request​

Exchange Info

HTTP Request

PARAMETERS

Create User

HTTP Request

PARAMETERS

Exchange Users List

HTTP Request

PARAMETERS

User Referrer

HTTP Request

PARAMETERS

User Referrals

HTTP Request

PARAMETERS

Activate User

HTTP Request

PARAMETERS

Deactive OTP

HTTP Request

PARAMETERS

User Logins List

HTTP Request

PARAMETERS

Create User Bank

HTTP Request

PARAMETERS

User Balance

HTTP Request

PARAMETERS

Users Balances

HTTP Request

PARAMETERS

Exchange Total Balance

HTTP Request

PARAMETERS

Create User Wallet

HTTP Request

PARAMETERS

Wallets List

HTTP Request

PARAMETERS

Update User role

HTTP Request

PARAMETERS

Update User meta

HTTP Request

PARAMETERS

Update User discount

HTTP Request

PARAMETERS

Update User note

HTTP Request

PARAMETERS

Update User tier

HTTP Request

PARAMETERS

Delete User

HTTP Request

PARAMETERS

Create User Order

HTTP Request

PARAMETERS

Cancel User Order

HTTP Request

PARAMETERS

Orders List

HTTP Request

PARAMETERS

Create Trade

HTTP Request

PARAMETERS

Trades List

HTTP Request

PARAMETERS

Transfer Assets

HTTP Request

PARAMETERS

Crypto Withdrawal

HTTP Request