Base URL

The base url is - https://siteapi.omex.exchange

The request URL needs to be determined by BASE and specific endpoint combination.

Endpoint of the Interface

Each interface has its own endpoint, described by field HTTP REQUEST in the docs.

Authentication

HTTP Request

POST login

Passphrase - testapi (Your Passphrase)

Secret Key - pk_d5b167bee654fb72142ae5d801261330 (Your Api Secret Key)

Info: To get 'secretkey' value of the prehash string {passphrase + secretkey} with sha256 HMAC use below format.

hash_hmac('sha256', passphrase, secretkey)

keyvalue
secretkey6c842df7ce530227399b4a3a53f2615ddaaea0ca0d15d26c41d39402b536085b
Required: Yes
ParameterDescription
api_keypu_3dcb8f52ef347ad57060dae3d678a65f
Required: Yes

Coins List

HTTP Request

GET coins

ParameterDescription
No params-

Response Example


 
{
    "success": true,
    "data": [
        {
            "coin_name": "BITCOIN",
            "coin": "BTC",
            "decimal": 8,
            "network": "BTC"
        },
        {
            "coin_name": "ETHEREUM",
            "coin": "ETH",
            "decimal": 8,
            "network": "ETH"
        },
        {
            "coin_name": "SOLANA",
            "coin": "SOL",
            "decimal": 8,
            "network": "SOL"
        },
        {
            "coin_name": "TRON",
            "coin": "TRX",
            "decimal": 8,
            "network": "TRX"
        },
        {
            "coin_name": "Litecoin",
            "coin": "LTC",
            "decimal": 8,
            "network": "LTC"
        },
        {
            "coin_name": "AVALANCHE",
            "coin": "AVAX",
            "decimal": 8,
            "network": "AVAX"
        },
        {
            "coin_name": "DOGE",
            "coin": "DOGE",
            "decimal": 8,
            "network": "DOGE"
        },
        {
            "coin_name": "ARBITRUM",
            "coin": "ARB",
            "decimal": 8,
            "network": "ERC20"
        },
        {
            "coin_name": "CARDANO",
            "coin": "ADA",
            "decimal": 8,
            "network": "BEP20"
        },
        {
            "coin_name": "USDC",
            "coin": "USDC",
            "decimal": 8,
            "network": "ERC20"
        },
        {
            "coin_name": "SHIBA INU",
            "coin": "SHIB",
            "decimal": 8,
            "network": "BEP20"
        },
        {
            "coin_name": "JUST",
            "coin": "JST",
            "decimal": 6,
            "network": "TRC20"
        },
        {
            "coin_name": "UNISWAP",
            "coin": "UNI",
            "decimal": 8,
            "network": "ERC20"
        },
        {
            "coin_name": "NEAR",
            "coin": "NEAR",
            "decimal": 8,
            "network": "ERC20"
        },
        {
            "coin_name": "MATIC",
            "coin": "MATIC",
            "decimal": 8,
            "network": "ERC20"
        },
        {
            "coin_name": "USD",
            "coin": "USDT",
            "decimal": 8,
            "network": "ERC20"
        },
        {
            "coin_name": "OKB",
            "coin": "OKB",
            "decimal": 8,
            "network": "ERC20"
        },
        {
            "coin_name": "DAI",
            "coin": "DAI",
            "decimal": 8,
            "network": "ERC20"
        }
    ],
    "message": "Coins list fetched successfully"
}

Trade Pairs

HTTP Request

GET trade/pairs

ParameterDescription
No params-

Response Example



{
    "success": true,
    "data": [
        {
            "pair": "BTC_USDC",
            "mini_buy_price": "1.00",
            "maxi_buy_price": "20.00",
            "mini_buy_amount": "1.00000000",
            "maxi_buy_amount": "50.00000000",
            "mini_buy_total": "2.0000000000",
            "mini_sell_price": "1.00",
            "maxi_sell_price": "40.00",
            "mini_sell_amount": "1.00000000",
            "maxi_sell_amount": "50.00000000",
            "mini_sell_total": "3.0000000000",
            "pair_type": "Normal"
        },
        {
            "pair": "TRX_USDT",
            "mini_buy_price": "1.00",
            "maxi_buy_price": "50.00",
            "mini_buy_amount": "1.00000000",
            "maxi_buy_amount": "40.00000000",
            "mini_buy_total": "2.0000000000",
            "mini_sell_price": "1.00",
            "maxi_sell_price": "50.00",
            "mini_sell_amount": "1.00000000",
            "maxi_sell_amount": "60.00000000",
            "mini_sell_total": "1.0000000000",
            "pair_type": "Normal"
        },
        {
            "pair": "BTC_USDT",
            "mini_buy_price": "0.00000000",
            "maxi_buy_price": "350000.00000000",
            "mini_buy_amount": "0.00010000",
            "maxi_buy_amount": "150.14370900",
            "mini_buy_total": "0.0001000000000000",
            "mini_sell_price": "0.10000000",
            "maxi_sell_price": "350000.00000000",
            "mini_sell_amount": "0.00001000",
            "maxi_sell_amount": "150.14370900",
            "mini_sell_total": "0.0000100000000000",
            "pair_type": "Bybit"
        },
        {
            "pair": "BTC_LTC",
            "mini_buy_price": "8.00000000",
            "maxi_buy_price": "10.00000000",
            "mini_buy_amount": "6.00000000",
            "maxi_buy_amount": "10.00000000",
            "mini_buy_total": "14.0000000000000000",
            "mini_sell_price": "8.00000000",
            "maxi_sell_price": "10.00000000",
            "mini_sell_amount": "6.00000000",
            "maxi_sell_amount": "12.00000000",
            "mini_sell_total": "14.0000000000000000",
            "pair_type": "Normal"
        },
        {
            "pair": "LTC_USDT",
            "mini_buy_price": "0.0000",
            "maxi_buy_price": "10000000000.0000",
            "mini_buy_amount": "0.0000",
            "maxi_buy_amount": "100000000.0000",
            "mini_buy_total": "0.00000000",
            "mini_sell_price": "0.0000",
            "maxi_sell_price": "10000000000.0000",
            "mini_sell_amount": "0.0000",
            "maxi_sell_amount": "1000000000.0000",
            "mini_sell_total": "0.00000000",
            "pair_type": "Bybit"
        },
        {
            "pair": "ETH_USDT",
            "mini_buy_price": "1",
            "maxi_buy_price": "350000",
            "mini_buy_amount": "0.000010",
            "maxi_buy_amount": "150.143709",
            "mini_buy_total": "0.000010",
            "mini_sell_price": "1",
            "maxi_sell_price": "350000",
            "mini_sell_amount": "0.000010",
            "maxi_sell_amount": "150.143709",
            "mini_sell_total": "0.000010",
            "pair_type": "Bybit"
        },
        {
            "pair": "SOL_USDT",
            "mini_buy_price": "0.10",
            "maxi_buy_price": "100.00",
            "mini_buy_amount": "0.10000000",
            "maxi_buy_amount": "100.00000000",
            "mini_buy_total": "1.0000000000",
            "mini_sell_price": "0.10",
            "maxi_sell_price": "100.00",
            "mini_sell_amount": "0.10000000",
            "maxi_sell_amount": "100.00000000",
            "mini_sell_total": "1.0000000000",
            "pair_type": "Normal"
        }
    ],
    "message": "Trade pair details."
}

Assets List

API endpoints require authentication [ Bearer token authentication received on login]

HTTP Request

POST account/assets

ParameterDescription
No params-

Response Example


{
    "success": true,
    "data": [
        {
            "coin": "BTC",
            "wallet": {
                "avbl_balance": "131208.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "ETH",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "SOL",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "TRX",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "LTC",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "AVAX",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "DOGE",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "ARB",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "ADA",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "USDC",
            "wallet": {
                "avbl_balance": "31.68000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "SHIB",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "JST",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "UNI",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "NEAR",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "MATIC",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "USDT",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "OKB",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "DAI",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        }
    ],
    "message": "Assets list fetched successfully"
}

Deposit

API endpoints require authentication [ Bearer token authentication received on login]

HTTP Request

POST account/coin/deposit

ParameterDescription
coinETH
Required: Yes
Type: string
Accept: UPPERCASE
networkETH
Required: Yes
Type: string
Accept: UPPERCASE

Response Example


{
    "success": true,
    "data": {
        "coin": "ETH",
        "address": "0x6D7C3f4e7a8630027a70F69C0905Ded6C4345C28",
        "address_url": "https://api.qrserver.com/v1/create-qr-code/?size=150x150&data=0x6D7C3f4e7a8630027a70F69C0905Ded6C4345C28"
    },
    "message": "Success"
}

Withdraw

API endpoints require authentication [ Bearer token authentication received on login]

HTTP Request

POST account/coin/withdraw

ParameterDescription
coinETH
Required: Yes
Type: string
Accept: UPPERCASE
networkETH
Required: Yes
Type: string
Accept: UPPERCASE
amount1
Required: Yes
Type: int
to_address0x8c08a27cd4e4e0f1587370089743c5a53bd36666
Required: Yes
Type: string

Response Example


{
    "success": true,
    "data": "[]",
    "message": "Withdraw request sent successfully"
}

Buy Order Book

HTTP Request

POST trade/buy/orderbook

ParameterDescription
pairTRX_USDT
Required: Yes
Type: string
Accept: UPPERCASE
limit10
Required: Yes
Type: int
offset0
Required: Yes
Type: int

Response Example


{
    "success": true,
    "data": {
        "buy_order_book": [
            {
                "price": "10.00000000",
                "remaining_qty": "1.00000000"
            }
        ]
    },
    "message": "Buy Order Book"
}

Sell Order Book

HTTP Request

POST trade/sell/orderbook

ParameterDescription
pairTRX_USDT
Required: Yes
Type: string
Accept: UPPERCASE
limit10
Required: Yes
Type: int
offset0
Required: Yes
Type: int

Response Example


{
    "success": true,
    "data": {
        "sell_order_book": [
            {
                "price": "10.00000000",
                "remaining_qty": "1.00000000"
            }
        ]
    },
    "message": "Sell Order Book"
}
Trade History

HTTP Request

POST trade/history

ParameterDescription
pairETH_USDT
Required: Yes
Type: string
Accept: UPPERCASE
from_date2024-09-23
Required: No
Type: Date (YYYY-mm-dd)
to_date2024-09-30
Required: No
Type: Date (YYYY-mm-dd)
limit10
Required: No
Type: int
offset0
Required: No
Type: int
typebuy
Required: No
Type: string
Accept: lowercase(buy,sell)
order_typelimit
Required: No
Type: string
Accept: lowercase(limit,market,stoplimit)

Response Example


 {
    "success": true,
    "data": [
        {
            "type": "buy",
            "date": "29-03-2024 13:16:58",
            "pair": "TRX/USDT",
            "order_type": "Limit",
            "price": "5.00000000",
            "qty": "1.00000000",
            "remaining_qty": "0.00000000",
            "fee": "0.00000000",
            "total": "5.00000000",
            "status": "Completed",
            "order_id": "abb5263badead798f72e"
        },
        {
            "type": "sell",
            "date": "28-03-2024 18:30:43",
            "pair": "TRX/USDT",
            "order_type": "Limit",
            "price": "5.00000000",
            "qty": "1.00000000",
            "remaining_qty": "0.00000000",
            "fee": "0.00000000",
            "total": "5.00000000",
            "status": "Completed",
            "order_id": "e423dbac7cdd148da731"
        },
        {
            "type": "buy",
            "date": "28-03-2024 17:58:08",
            "pair": "TRX/USDT",
            "order_type": "Limit",
            "price": "5.00000000",
            "qty": "1.00000000",
            "remaining_qty": "0.00000000",
            "fee": "0.00000000",
            "total": "5.00000000",
            "status": "Completed",
            "order_id": "98c3b53d9837af682d95"
        }
    ],
    "message": "Trade history"
}

Buy Limit

API endpoints require authentication [ Bearer token authentication received on login]

HTTP Request

POST trade/buy/limit

ParameterDescription
coin_oneETH
Required: Yes
Type: string
Accept: UPPERCASE
coin_twoTRY
Required: Yes
Type: string
Accept: UPPERCASE
buy_price12
Required: yes
Type: int
buy_volume1
Required: yes
Type: int

Response Example


{
    "success": true,
    "data": {
        "order_id": "ceb51c348e1ad118e7b7"
    },
    "message": "Post Trade Successful."
}

Sell Limit

API endpoints require authentication [ Bearer token authentication received on login]

HTTP Request

POST trade/sell/limit

ParameterDescription
coin_oneETH
Required: Yes
Type: string
Accept: UPPERCASE
coin_twoTRY
Required: Yes
Type: string
Accept: UPPERCASE
sell_price10
Required: yes
Type: int
sell_volume1
Required: yes
Type: int

Response Example


{
    "success": true,
    "data": {
        "order_id": "6fb0b255ddc39b404829"
    },
    "message": "Post Trade Successful."
}

Buy Market

API endpoints require authentication [ Bearer token authentication received on login]

HTTP Request

POST trade/buy/market

ParameterDescription
coin_oneETH
Required: Yes
Type: string
Accept: UPPERCASE
coin_twoTRY
Required: Yes
Type: string
Accept: UPPERCASE
buy_market_volume10
Required: yes
Type: int

Response Example


{
    "success": true,
    "data": {
        "order_id": "f2f3ffca5e9b274d92f3"
    },
    "message": "Post Trade Successful."
}

Sell Market

API endpoints require authentication [ Bearer token authentication received on login]

HTTP Request

POST trade/sell/market

ParameterDescription
coin_oneETH
Required: Yes
Type: string
Accept: UPPERCASE
coin_twoTRY
Required: Yes
Type: string
Accept: UPPERCASE
sell_market_volume10
Required: yes
Type: int

Response Example


{
   "success": true,
    "data": {
        "order_id": "e1ce9885a8cf5ddc356e"
    },
    "message": "Post Trade Successful."
}

Stop Buy Limit

API endpoints require authentication [ Bearer token authentication received on login]

HTTP Request

POST trade/buy/stop

ParameterDescription
coin_oneETH
Required: Yes
Type: string
Accept: UPPERCASE
coin_twoTRY
Required: Yes
Type: string
Accept: UPPERCASE
stoplimit_buystopprice1
Required: yes
Type: int
stoplimit_buylimitprice10
Required: yes
Type: int
stoplimit_buyamount1
Required: yes
Type: int
stoplimit_buytotal10
Required: yes
Type: int

Response Example


{
    "success": true,
    "data": {
        "order_id": "42d461bcb483f57875dd"
    },
    "message": "Post Trade Successful."
}

Stop Sell Limit

API endpoints require authentication [ Bearer token authentication received on login]

HTTP Request

POST trade/sell/stop

ParameterDescription
coin_oneETH
Required: Yes
Type: string
Accept: UPPERCASE
coin_twoTRY
Required: Yes
Type: string
Accept: UPPERCASE
stoplimit_sellstopprice11
Required: yes
Type: int
stoplimit_selllimitprice10
Required: yes
Type: int
stoplimit_sellamount1
Required: yes
Type: int
stoplimit_selltotal1
Required: yes
Type: int

Response Example


{
   "success": true,
    "data": {
        "order_id": "8081345728a545f00337"
    },
    "message": "Post Trade Successful."
}

Stop Loss Sell

API endpoints require authentication [ Bearer token authentication received on login]

HTTP Request

POST trade/sell/stoploss

ParameterDescription
coin_oneBTC
Required: Yes
Type: string
Accept: UPPERCASE
coin_twoTRX
Required: Yes
Type: string
Accept: UPPERCASE
stoploss_sellstopprice13
Required: yes
Type: int
stoploss_sellamount1
Required: yes
Type: int

Response Example


{
    "success": true,
    "data": {
        "order_id": "cf3fc8a95090b080022e"
    },
    "message": "Post Trade Successful"
}

Open Order

API endpoints require authentication [ Bearer token authentication received on login]

HTTP Request

POST trade/openorder

ParameterDescription
coin_oneBTC
Required: Yes
Type: string
Accept: UPPERCASE
coin_twoUSDC
Required: Yes
Type: string
Accept: UPPERCASE

Response Example


{
    "success": true,
    "data": [
        {
            "type": "Sell",
            "date": "13-09-2024 11:41:23",
            "pair": "BTC/USDC",
            "order_type": "Limit",
            "price": "11.00000000",
            "qty": "0.50037503",
            "remaining_qty": "0.50037503",
            "fee": "0.00000000",
            "total": "5.50412533",
            "status": "Pending",
            "order_id": "13e403b8548350df4b05"
        },
        {
            "type": "Sell",
            "date": "13-09-2024 11:40:59",
            "pair": "BTC/USDC",
            "order_type": "Limit",
            "price": "10.00000000",
            "qty": "22.00000000",
            "remaining_qty": "19.00000000",
            "fee": "0.60000000",
            "total": "190.00000000",
            "status": "Pending",
            "order_id": "0c3383894f4a56242b38"
        },
        {
            "type": "Sell",
            "date": "10-09-2024 11:33:12",
            "pair": "BTC/USDC",
            "order_type": "Stop Limit",
            "price": "13.00000000",
            "qty": "11.00000000",
            "remaining_qty": "11.00000000",
            "fee": "0.00000000",
            "total": "143.00000000",
            "status": "Pending",
            "order_id": "00591958f1735e116a9e"
        }
    ],
    "message": "Open Orders"
}

Cancel Trade

API endpoints require authentication [ Bearer token authentication received on login]

HTTP Request

POST trade/cancel

ParameterDescription
order_id6dc99e678812f78a1afa
Required: Yes
Type: Alpha numeric
typesell
Required: Yes
Type: string
Accepted: string:buy,sell

Response Example


{
   "success": true,
    "data": [],
    "message": "Pending order cancelled successfully!"
}

Deposit History

API endpoints require authentication [ Bearer token authentication received on login]

HTTP Request

POST account/deposit/history

ParameterDescription
symbolETH
Required: Yes
Type: string
Accept: UPPERCASE
limit10
Required: Yes
Type: int
offset0
Required: Yes
Type: int

Response Example


{
   "success": true,
    "data": [
        {
            "txid": "d724e3129ac176daa5817797390f31ec4ee91c7d6b87278d48568eabdca5",
            "currency": "ETH",
            "txtype": "deposit",
            "from_addr": "admindeposit",
            "to_addr": "0x6d554c278bcbda19e99e870aaa0d085c44f4efd7",
            "amount": 100,
            "totalamount": 0,
            "status": "Approved",
            "created_at": "24-08-2024 12:08:29"
        }
    ],
    "message": "Deposit history"
}

Withdraw History

API endpoints require authentication [ Bearer token authentication received on login]

HTTP Request

POST account/withdraw/history

ParameterDescription
symbolETH
Required: Yes
Type: string
Accept: UPPERCASE
limit10
Required: Yes
Type: int
offset0
Required: Yes
Type: int

Response Example


{
   "success": true,
    "data": [
        {
            "created_at": "02-Sep-2024 13:49:51",
            "txid": "59ef1abfe4fe79c5dd314be55d5ab97fd59959c554fe304582d4454a204a",
            "currency": "TRY",
            "type": "withdraw",
            "amount": 50,
            "totalamount": 50,
            "account_name": "ajith",
            "account_no": "123456",
            "bank_name": "asfdasf",
            "bank_address": "asdfsaf",
            "status": "Waiting for admin confirmation"
        },
        {
            "created_at": "02-Sep-2024 13:27:34",
            "txid": "bdab0e8edb8c509178d826f38a1408ad96acac9c7ca87b2f620e4f354c3f",
            "currency": "TRY",
            "type": "withdraw",
            "amount": 50,
            "totalamount": 50,
            "account_name": "ajith",
            "account_no": "123456",
            "bank_name": "asfdasf",
            "bank_address": "asdfsaf",
            "status": "Waiting for admin confirmation"
        },
        {
            "created_at": "22-Aug-2024 10:16:11",
            "txid": "3a076adf2e23409588b9b27bfc71355ea6b1803e6f47121c1e0f3e055c1f",
            "currency": "TRY",
            "type": "withdraw",
            "amount": 1,
            "totalamount": 1,
            "account_name": "ajith",
            "account_no": "12313",
            "bank_name": "njsdn",
            "bank_address": "skjds",
            "status": "Waiting for admin confirmation"
        }
    ],
    "message": "Withdraw History"
}