• Русский
    • English
    • Русский
  • Время сервера
  • Биржа
  • О компании
  • Новости
  • Регистрация
  • Войти
  • Русский
    • English
    • Русский
  • Время сервера

Overview

Ezoex provides a simple and powerful REST API to allow you to programatically perform nearly all actions you can from our web interface. All requests use the application/json content type and go over https. The base url is https://api.ezoex.com /.

We are currently restricting orders to 400 open orders and 150,000 orders a day. We reserve the right to change these settings as we tune the system. If you are affected by these limits as an active trader, please write to mailto:[email protected].

If you have any questions, feedback or recommendation for API support you can post a question in our support.

Getting Started

  • General
  • Authentication
  • API Reference

General

We provide a simple RESTful API. All calls are GETs and should be called via https. The endpoints have a standard format as follows:

https://api.ezoex.com/{method}?param=value

Authentication

In the spirit of keeping things simple, we offer an easy to manage API Key authentication method. You can have multiple API keys, each with their own level of rights. To manage your API keys please go to Settings > Manage API Keys.

Each api key can be configured with different permissions

  • Read Info - You can only view the balances, orders, and other details of the account
  • Enable Trading - This allows the API key to place LIMIT buy and sell orders
  • Enable Withdrawals - We allow you to programatically withdraw any currency to an address you provide. This can be used to quick arbitrage exchanges or move money into cold storage after thresholds. It is strongly recommended that you do so only after enabling two-factor authentication and applying the IP Assess Restriction filter.
  • IP Access Restriction - IP addresses whitelist to use API key

For this version, we use a standard HMAC-SHA512 signing. Append apikey and nonce to your request and calculate the HMAC hash and include it under an apisign header. Note: the nonce is not respected right now but will be enforced later.

$apikey='xxx';
$apisecret='xxx'; 
$nonce=time(); 
$uri='https://api.ezoex.com/market/getopenorders?apikey='.$apikey.'&nonce='.$nonce; 
$sign=hash_hmac('sha512',$uri,$apisecret); 
$ch = curl_init($uri); 
curl_setopt($ch, CURLOPT_HTTPHEADER, array('apisign:'.$sign)); 
$execResult = curl_exec($ch); 
$obj = json_decode($execResult);

API Reference

Our APIs are broken into three distinct groups

  • Public - Public information available without an API key
  • Market - For programmatic trading of crypto currencies
  • Account - For managing your account

Public API

  • /public/tradepairs

    Used to get the open and available trading markets at Ezoex along with other meta data.

    Parameters

    None

    Request

    https://api.ezoex.com/public/tradepairs

    Response

    [
        {  
          "Id":"AEBTC",
          "BaseCurrencyId":"BTC",
          "MarketCurrencyId":"AE",
          "Disabled":false,
          "MinTradeSize":0.00010000,
          "MakerFeeRate":0.00100000,
          "TakerFeeRate":0.00150000
       },
       {  
          "Id":"BATBTC",
          "BaseCurrencyId":"BTC",
          "MarketCurrencyId":"BAT",
          "Disabled":false,
          "MinTradeSize":0.00010000,
          "MakerFeeRate":0.00100000,
          "TakerFeeRate":0.00150000
       },
       ...
    ]
                                
  • /public/currencies

    Used to get all supported currencies at Ezoex along with other meta data.

    Parameters

    None

    Request

    https://api.ezoex.com/public/currencies

    Response

    {  
       "Success":true,
       "ErrorType":null,
       "Errors":null,
       "Data":
          [{  
             "Id":"AE",
             "Description":"Aeternity",
             "Precision":8,
             "Url":null,
             "LogoSrc":"/images/currencies/ae.png",
             "DepositDisabled":false,
             "WithdrawDisabled":false,
             "MinDeposit":1.00000000,
             "MinWithdrawal":2.00000000,
             "CurrencyType":0,
             "LastCheck":"2018-11-09T11:52:07.58",
             "BlockHeight":6672204,
             "BaseAddress":null,
             "ConfirmationsCount":30,
             "CryptoMessageDesc":null,
             "TxFee":1.70000000
          },
          {  
             "Id":"BAT",
             "Description":"Basic Attention Token",
             "Precision":8,
             "Url":null,
             "LogoSrc":"/images/currencies/bat.png",
             "DepositDisabled":false,
             "WithdrawDisabled":false,
             "MinDeposit":10.00000000,
             "MinWithdrawal":10.00000000,
             "CurrencyType":0,
             "LastCheck":"2018-11-09T11:52:07.58",
             "BlockHeight":6672204,
             "BaseAddress":null,
             "ConfirmationsCount":30,
             "CryptoMessageDesc":null,
             "TxFee":9.00000000
          },
          ...]
    }
                                    
  • /public/tickers

    Used to get the current tick values for a market.

    Parameters

    None

    Request

    https://api.ezoex.com/public/tickers

    Response

    {  
       "BTCUSD":{  
          "Ask":0.0,
          "Bid":0.0,
          "Change":0.0
       },
       "BTCUSDT":{  
          "Ask":0.0,
          "Bid":0.0,
          "Change":0.0
       },
       ...
    }
                                    
  • /public/marketsummary

    Used to get the last 24 hour summary of all active markets.

    Parameters

    None

    Request

    https://api.ezoex.com/public/marketsummary

    Response

    {  
       "LTCETH":{  
          "PairId":"LTCETH",
          "High":0.25569720,
          "Low":0.24921270,
          "Volume":404.87240442
       },
       "BTCUSD":{  
          "PairId":"BTCUSD",
          "High":4531.27680000,
          "Low":4291.20000000,
          "Volume":46985310.32435929
       },
       ...
    }
                                    
  • /public/ordersbook

    Used to get retrieve the orderbook for a given market.

    Parameters

    Parameter Required Description
    pairId required a string literal for the market (ex: LTCUSDT)

    Request

    https://api.ezoex.com/public/ordersbook/?pairId=LTCUSDT

    Response

    {  
       "Bids":[  
          [  
             50.6484000000, //Price
             216.01263000   //Amount
          ],
          [  
             50.6187000000,
             41.80265000
          ]
       ],
       "Asks":[  
          [  
             51.7120000000,
             0.78132000
          ],
          [  
             51.7221000000,
             1.48054000
          ]
       ]
    }
                                    

Market API

  • /market/buylimit

    Used to place a buy order in a specific market. Use buylimit to place limit orders. Make sure you have the proper permissions set on your API keys for this call to work.

    Parameters

    Parameter Required Description
    pair required a string literal for the market (ex: LTCBTC)
    amount required the amount to purchase
    price required the price at which to place the order

    Request

    https://api.ezoex.com/market/buylimit?apikey=API_KEY&nonce=100&pair=LTCBTC&amount=1.2&price=1.3

    Response

    {
        "Success":true,
        "Message":"",
        "Data":{
            "Uuid" : "614c34e4-8d71-11e3-94b5-425861b86ab6" //order uuid
        }
    }
                                    
  • /market/selllimit

    Used to place an sell order in a specific market. Use selllimit to place limit orders. Make sure you have the proper permissions set on your API keys for this call to work.

    Parameters

    Parameter Required Description
    pair required a string literal for the market (ex: LTCBTC)
    amount required the amount to purchase
    price required the price at which to place the order

    Request

    https://api.ezoex.com/market/selllimit?apikey=API_KEY&nonce=100&pair=LTCBTC&amount=1.2&price=1.3

    Response

    {
        "Success":true,
        "Message":"",
        "Data":{
            "Uuid" : "614c34e4-8d71-11e3-94b5-425861b86ab6" //order uuid
        }
    }
                                    
  • /market/cancel

    Used to cancel a buy or sell order.

    Parameters

    Parameter Required Description
    pair required a string literal for the market (ex: LTCBTC)
    uuid required uuid of buy or sell order

    Request

    https://api.ezoex.com/market/cancel?apikey=API_KEY&nonce=100&pair=LTCBTC&uuid=ORDER_UUID

    Response

    {
        "Success" : true,
        "Message" : "",
        "result" : null
    }
                                    
  • /market/getopenorders

    Get all orders that you currently have opened. A specific market can be requested.

    Parameters

    Parameter Required Description
    pair optional a string literal for the market (ie. LTCBTC)

    Request

    https://api.ezoex.com/market/getopenorders?apikey=API_KEY&nonce=100&pair=LTCBTC

    Response

    {
        "Success" : true,
        "Message" : "",
        "Data" : [
            {
                "Id":"af94774b-5048-4838-a4d9-cacf67b9bbaf",
                "TradePairId":"LTCBTC",
                "OrderType":0,  //0 - buy limit; 1 - sell limit
                "Price":0.00010000,
                "Amount":1.00000000,
                "AmountRemains":1.00000000,
                "CreateDateTime":"2018-10-08T16:26:42.490572",
                "CloseDateTime":null,
            }
        ]
    }
                                    
  • /market/getorder

    Get all orders that you currently have opened. A specific market can be requested.

    Parameters

    Parameter Required Description
    uuid required uuid of buy or sell order

    Request

    https://api.ezoex.com/market/getorder?apikey=API_KEY&nonce=100&uuid=ORDER_UUID

    Response

    {
        "Success" : true,
        "Message" : "",
        "Data" : {
            "Id":"af94774b-5048-4838-a4d9-cacf67b9bbaf",
            "TradePairId":"LTCBTC",
            "OrderType":0,           //0 - buy limit; 1 - sell limit
            "Price":0.00010000,
            "Amount":1.00000000,
            "AmountRemains":1.00000000,
            "CreateDateTime":"2017-10-08T16:26:42.490572",
            "CloseDateTime":null     //if null - order is open
        }
    }
                                    
  • /market/getclosedorders

    Used to retrieve your order history. Ordered by descending of CloseDateTime

    Parameters

    Parameter Required Description
    pair optional a string literal for the market (ie. LTCBTC)
    pageSize optional The amount of orders per page (Max - 200; Default - 30)
    page optional The page to retrieve

    Request

    https://api.ezoex.com/market/getclosedorders?apikey=API_KEY&nonce=100&pair=LTCBTC&pageSize=50&page=1

    Response

    {  
        "Success" : true,
        "Message" : "",
        "Data" : {
            "Results":[  
                {  
                    "Id":"08bd52af-ae46-443f-a7b5-1786c92411ab",
                    "TradePairId":"LTCBTC",
                    "OrderType":0,           //0 - buy limit; 1 - sell limit
                    "Price":0.00100000,
                    "Amount":0.10000000,
                    "AmountRemains":0.00000000,
                    "CreateDateTime":"2017-10-16T16:12:33.986012",
                    "CloseDateTime":"2017-10-16T16:12:35.902011"
                }
            ],
            "CurrentPage":1,
            "PagesCount":1,
            "PageSize":30
        }
    }
                                    

Account API

  • /account/getbalances

    Used to retrieve all balances from your account. Note: If the currency is not listed, the balance for this currency is 0

    Parameters

    None

    Request

    https://api.ezoex.com/account/getbalances?apikey=API_KEY&nonce=100

    Response

    {
        "Success" : true,
        "Message" : "",
        "Data" : [
            {
                "CurrencyId":"BTC",
                "Balance":0.1,
                "Reserved":0
            },
            {
                "CurrencyId":"LTC",
                "Balance":10,
                "Reserved":0.110
            }
        ]
    }
                                
  • /account/withdraw

    [For crypto only] Used to withdraw funds from your account. Note: please account for txfee

    Parameters

    Parameter Required Description
    currency required a string literal for the currency (ie. BTC)
    amount required the quantity of coins to withdraw
    address required the address where to send the funds
    paymentid optional used for CryptoNotes/BitShareX/NXT/XRP and any other coin that has a memo/message/tag/paymentid option

    Request

    https://api.ezoex.com/account/withdraw?apikey=API_KEY&nonce=100&currency=BTC&amount=20.40&address=BTC_ADDRESS

    Response

    {
        "Success" : true,
        "Message" : "",
        "Data" : {
            "Id" : 1234
        }
    }
                                    
  • /account/withdrawcode

    Used to withdraw funds from your account via Code. (No fee)

    Parameters

    Parameter Required Description
    currency required a string literal for the currency (ie. BTC)
    amount required the quantity of coins to withdraw

    Request

    https://api.ezoex.com/account/withdrawcode?apikey=API_KEY&nonce=100&currency=BTC&amount=20.40

    Response

    {
        "Success" : true,
        "Message" : "",
        "Data" : {
            "Id" : 1234,
            "Code": "EZOEX_BTC_BYLsvrE5JEGL2LkKX6t5A38hdlnVREe5NMhyS7vn"
        }
    }
                                    
  • /account/redeemcode

    Used to add funds to your account via Code

    Parameters

    Parameter Required Description
    code required Code to redeem

    Request

    https://api.ezoex.com/account/redeemcode?apikey=API_KEY&nonce=100&code=EZOEX_BTC_BYLsvrE5JEGL2LkKX6t5A38hdlnVREe5NMhyS7vn

    Response

    {
        "Success" : true,
        "Message" : "",
        "Data" : {
            "CurrencyId" : BTC,
            "Amount": "0.1234"
        }
    }
                                    
Bitcoin ETH nix perfect-money payeer advcash btc-e
© 2023 - Ezoex
  • Информация
  • Партнерское соглашение
  • Политика Конфиденциальности
  • Партнерская программа
  • Coin status
  • Fees
  • F.A.Q
  • Предложить платежную систему
  • Документация по API
  • Новости
  • О компании
  • Поддержка: [email protected]