iCapitalior

Base URL

The base url is https://siteapi.icapitalior.io.

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)

Headers

Key	Value
Accept	application/json
secretkey	aa42b7a06810f60ba202faa1f17b9752be9620abe3bf7038486d6ea26a67808b

Parameter	Description
api_key	pu_3542ee5868b52d9773f0c68f8cb55d43

                                                
                                    
{
    "success": true,
    "data": {
        "token": "8|vmnTROXJFVTxdTWH8y9VnGQW6tFCO7OqvsobfOBt",
        "details": {
            "name": "johndoe",
            "email": "john@roy.fr",
            "address": "xyz"
        }
    },
    "message": "user login successfully"
}

Coins List

HTTP Request

GET /coins

Parameter	Description
No params	---

                                                
                                    
{
    "success": true,
    "data": [
        {
            "coin_name": "BITCOIN",
            "coin": "BTC",
            "decimal": 8,
            "network": "BTC"
        },
        {
            "coin_name": "ETHEREUM",
            "coin": "ETH",
            "decimal": 8,
            "network": "ETH"
        },
        {
            "coin_name": "Tether",
            "coin": "USDT",
            "decimal": 8,
            "network": "ERC20"
        },
        {
            "coin_name": "TRON",
            "coin": "TRON",
            "decimal": 8,
            "network": "ERC20"
        },
        {
            "coin_name": "USDC",
            "coin": "USDC",
            "decimal": 8,
            "network": "ERC20"
        }
    ],
    "message": "Coins list fetched successfully"
}

Trade Pairs

HTTP Request

GET /trade/pairs

Parameter	Description
No params	---

                                                
                                    
    {
        "success": true,
        "data": [
            {
                "pair": "BTC_EUR",
                "mini_buy_price": "1.00",
                "maxi_buy_price": "50.00",
                "mini_buy_amount": "1.00000",
                "maxi_buy_amount": "10.00000",
                "mini_buy_total": "0.0000000",
                "mini_sell_price": "1.00",
                "maxi_sell_price": "50.00",
                "mini_sell_amount": "1.00000",
                "maxi_sell_amount": "10.00000",
                "mini_sell_total": "0.0000000",
                "pair_type": "0"
            },
            {
                "pair": "ETH_EUR",
                "mini_buy_price": "0.00",
                "maxi_buy_price": "10000000.00",
                "mini_buy_amount": "0.0000",
                "maxi_buy_amount": "100000000.0000",
                "mini_buy_total": "0.000100",
                "mini_sell_price": "0.35",
                "maxi_sell_price": "10000000.00",
                "mini_sell_amount": "0.4500",
                "maxi_sell_amount": "100000000.0000",
                "mini_sell_total": "0.157500",
                "pair_type": "0"
            }

        ],
        "message": "Trade pair details."
    }

Ticker Info

HTTP Request

GET /trade/tickerinfo

Parameter	Description
pair	BTC_EUR Required: Yes Type: string Accept: UPPERCASE

                                                
                                    
{
    "success": true,
    "data": {
        "Last_price": "7.00",
        "24h_low": "1.00",
        "24h_high": "7.00",
        "24h_volume": "11.00000",
        "24h_change": "0.00",
        "quote_volume": "38.00",
        "best_ask": "3.00",
        "best_bid": "2.00",
        "completed_trade_type": "Buy"
    },
    "message": "Ticker Info."
}

Buy Order Book

HTTP Request

GET /trade/buy/orderbook

Parameter	Description
pair	BTC_EUR Required: Yes Type: string Accept: UPPERCASE
limit	10 Required: Yes Type: int
offset	0 Required: Yes Type: int

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

Sell Order Book

HTTP Request

GET /trade/sell/orderbook

Parameter	Description
pair	ETH_USDT Required: Yes Type: string Accept: UPPERCASE
limit	10 Required: Yes Type: int
offset	0 Required: Yes Type: int

                                               
                                     
{
    "success": true,
    "data": {
        "sell_order_book": [
            {
                "price": "1673.29000000",
                "remaining_qty": "5.94760000"
            }
        ]
    },
    "message": "Sell Order Book"
}

Trade History

HTTP Request

GET /trade/history

Parameter	Description
pair	ETH_BTC Required: Yes Type: string Accept: UPPERCASE
limit	10 Required: Yes Type: int
offset	0 Required: Yes Type: int

                                          
                                      
{
    "success": true,
    "data": {
        "trade_history": [
            {
                "date": "15-09-2023 13:28:45",
                "price": "12.00000000",
                "qty": "1.00000000",
                "order_type": "Sell"
            },
            {
                "date": "15-09-2023 13:28:38",
                "price": "15.00000000",
                "qty": "1.00000000",
                "order_type": "Buy"
            }
        ]
    },
    "message": "Trade History"
}

Assets List

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

HTTP Request

POST /account/assets

Parameter	Description
No params	---

 
                                    
{
    "success": true,
    "data": [
        {
            "coin": "BTC",
            "wallet": {
                "avbl_balance": "3.70588001",
                "balance_in_trade": "6.22351000"
            }
        },
        {
            "coin": "ETH",
            "wallet": {
                "avbl_balance": "0.00000000",
                "balance_in_trade": "0.00000000"
            }
        },
        {
            "coin": "LTC",
            "wallet": {
                "avbl_balance": "5.97000000",
                "balance_in_trade": "0.00000000"
            }
        },
    ],
    "message": "Assets list fetched successfully"
}

Buy Limit Trade

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

HTTP Request

POST /trade/buy/limit

Parameter	Description
coinone	BTC Required: Yes Type: string Accept: UPPERCASE
cointwo	EUR Required: Yes Type: string Accept: UPPERCASE
buyprice	2 Required: Yes Type: int
buyvolume	1 Required: Yes Type: int

       
                                         
{
    "success": true,
    "data": {
        "order_id": "18908dfae3762eb27394"
    },
    "message": "Post Trade Successfully!"
}

Sell Limit Trade

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

HTTP Request

POST /trade/sell/limit

Parameter	Description
coinone	BTC Required: Yes Type: string Accept: UPPERCASE
cointwo	EUR Required: Yes Type: string Accept: UPPERCASE
sellprice	3 Required: Yes Type: int
sellvolume	1 Required: Yes Type: int

                                            
                                    
{
    "success": true,
    "data": {
        "order_id": "7e1c44c4eef4e14faff4"
    },
    "message": "Post Trade Successfully!"
 }

Buy Market Trade

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

HTTP Request

POST /trade/buy/market

Parameter	Description
coinone	BTC Required: Yes Type: string Accept: UPPERCASE
cointwo	EUR Required: Yes Type: string Accept: UPPERCASE
buymarketvolume	1 Required: Yes Type: int

                                                
{
    "success": true,
    "result": {
        "order_id": "ccde7766e17677026d73"
    },
    "message": "Post Trade Successfully!"
}

Sell Market Trade

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

HTTP Request

POST /trade/sell/market

Parameter	Description
coinone	BTC Required: Yes Type: string Accept: UPPERCASE
cointwo	EUR Required: Yes Type: string Accept: UPPERCASE
sellmarketvolume	10 Required: Yes Type: int

    
                                         
{
    "success": true,
    "data": {
        "order_id": "6501e8d98335b17b9f9c"
    },
    "message": "Post Trade Successfully!"
}

Buy Trade History

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

HTTP Request

POST /trade/buy/history

Parameter	Description
pair	BTC_EUR Required: No Type: string Accept: UPPERCASE
order_type	market Required: No Type: string Accept: limit,market
from_date	30-09-2025 Required: No Type: Date (dd-mm-yyyy)
to_date	01-10-2025 Required: No Type: Date (dd-mm-yyyy)
limit	10 Required: No Type: int
offset	0 Required: No Type: int

                                               
                                     
{
    "success": true,
    "data": [
        {
            "order_id": "ccde7766e17677026d73",
            "pair": "BTC/EUR",
            "order_type": "Market",
            "price": "0.00000000",
            "qty": "1.00000000",
            "fee": "0.00500000",
            "total": "3.00000000",
            "remaining_qty": "0.00000000",
            "status": "Confirmed",
            "created_at": "01-10-2025 09:05:47"
        },
        {
            "order_id": "1d2f6249dcafa58216cf",
            "pair": "BTC/EUR",
            "order_type": "Limit",
            "price": "2.00000000",
            "qty": "1.00000000",
            "fee": "0.00500000",
            "total": "2.00000000",
            "remaining_qty": "0.00000000",
            "status": "Confirmed",
            "created_at": "01-10-2025 06:29:15"
        }
    ],
    "message": "Buy Trade history details"
}

Sell Trade History

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

HTTP Request

POST /trade/sell/history

Parameter	Description
pair	BTC_EUR Required: No Type: string Accept: UPPERCASE
order_type	limit Required: No Type: string Accept: limit,market
from_date	30-09-2025 Required: No Type: Date (dd-mm-yyyy)
to_date	01-10-2025 Required: No Type: Date (dd-mm-yyyy)
limit	3 Required: No Type: int
offset	0 Required: No Type: int

  
                                     
{
    "success": true,
    "data": [
        {
            "order_id": "6501e8d98335b17b9f9c",
            "pair": "BTC/EUR",
            "order_type": "Market",
            "price": "0.00000000",
            "qty": "1.00000000",
            "fee": "0.01000000",
            "total": "2.00000000",
            "remaining_qty": "0.00000000",
            "status": "Confirmed",
            "created_at": "01-10-2025 09:07:16"
        },
        {
            "order_id": "7e1c44c4eef4e14faff4",
            "pair": "BTC/EUR",
            "order_type": "Limit",
            "price": "3.00000000",
            "qty": "1.00000000",
            "fee": "0.00000000",
            "total": "3.00000000",
            "remaining_qty": "1.00000000",
            "status": "Pending",
            "created_at": "01-10-2025 07:59:50"
        }
    ],
    "message": "Sell Trade history details"
}

Open Order History

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

HTTP Request

POST /trade/openorder

Parameter	Description
pair	ETH_USDT Required: No Type: string Accept: UPPERCASE
order_type	limit Required: No Type: string Accept: limit,market
type	buy Required: No Type: string Accept: buy,sell
from_date	30-09-2025 Required: No Type: Date (dd-mm-yyyy)
to_date	01-10-2025 Required: No Type: Date (dd-mm-yyyy)
limit	10 Required: No Type: int
offset	0 Required: No Type: int

                                                
{
    
    "success": true,
    "data": [
        {
            "type": "Buy",
            "date": "01-Oct-2025 07:57:49",
            "pair": "BTC/EUR",
            "order_type": "Limit",
            "price": "2.00",
            "qty": "1.00000",
            "remaining_qty": "1.00000",
            "fee": "0.00000",
            "total": "2.00000000",
            "status": "Pending",
            "order_id": "18908dfae3762eb27394"
        },
        {
            "type": "Sell",
            "date": "01-Oct-2025 07:59:50",
            "pair": "BTC/EUR",
            "order_type": "Limit",
            "price": "3.00",
            "qty": "1.00000",
            "remaining_qty": "1.00000",
            "fee": "0.00000",
            "total": "3.00000000",
            "status": "Pending",
            "order_id": "7e1c44c4eef4e14faff4"
        }
    ],
    "message": "Open Orders"
}

Trade Cancel

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

HTTP Request

POST /trade/cancel

Parameter	Description
order_id	23912a05546dc419ac45 Required: Yes Type: int
type	sell Required: Yes Type: string Accepted string: buy, sell

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