-21Days -22Hours -6Minutes -35Seconds

 

ICE3X API V1

ICE3X provides access to the API via two ways:

  1. Public API:
    • Does not require the use of authentication methods and is available via GET requests.
    • This API does not require authorization, and is accessible through the GET request.
    • In general, the URL for accessing the API is as follows https://www.ICE3X.com/api/v1/api_method/api_action?api_params where api_method – this API method that is accessed, api_action – the action to be performed and api_params – incoming request parameters. List of Public API
  2. Private API:
    • Requires the use of an authorization and is available only by using a POST request and GET request.
    • In both cases it is required to send GET / POST-parameter nonce with incremental numerical value [timestamp unix], which should not be less than the current timestamp, rounded up to the third digit to the lower side and no more current timestamp unix.
    • To access this API requires authentication and you must use POST method. The exception is the receipt of the invoice pdf file.
    • All the answers come from the server in JSON format.Authorization is performed by sending to the server the following headings:
      • Key – The public key, it is necessary to take the user’s profile settings
        (example: 1KАF69ZVYNHGG109SBKSSX5VI8TUC7CA236VPTXEH7JLRMB2RIWZH1VFHVGBLZU4)
      • Sign – POST data (param = val & param1 = val1 … & paramN = valN), signed by the secret key HMAC-SHA512, secret key is also necessary to take in the user profile settings
        (example: 1e0oe19wfn11s3t2lzmvrt26izlaky8k22ko88zroki74cp1y9kdd812i0y7rtxj). List of Private API
  3. Error responses to API:
    • List of error responses to API

Public API OF ICE3X.COM

1 Description of PUBLIC API
=====================

1.1 Method “stats/marketdepthfull”

api_method/api_action
GET stats/marketdepthfull

This method provides info about currency pair for a certain period of time (24h by default):

  • Name of currency pair (pair_name) as well as its id (pair_id)
  • Lowest (min) and Highest (max) price of the last 24 hours
  • Trading volume of the last 24 hours (vol)
  • The average price (avg)
  • The price at which the last order executed (last_price)

This method also allows to obtain info not for whole list of currency pair but for specific one, it is possible if param pair_id is set, in this case params order_by, pair_id, order_direction, items_per_page and page are ignored.

Note: Value of param last_price doesn’t depend on chosen period of time (date_from, date_to) and always provides info for current time.

api_method/api_action
GET stats/marketdepthfull

api_params (* – required param, ^- if param is set up, ^^-these params are ignored),
*nonce=<\d{10}>
^pair_id=<\d+>:all
date_from=<\d{10}>:current time-24hours
date_to=<\d{10}>:current time
^^order_by=<‘field_name’>:’pair_id’
^^order_direction=<asc|desc>:ASC
^^items_per_page=<\d+>:100
^^page=<\d+>:1

entity format
{
“pair_id”:<\d+>,
“min”:<\d{1,8}\.d{0,8}>,
“max”:<\d{1,8}\.d{0,8}>,
“avg”:<\d{1,8}\.d{0,8}>,
“vol”:<\d{1,8}\.d{0,8}>,
“last_price”:<\d{1,8}\.d{0,8}>,
“pair_name”:<{A-Z}{3}\/{A-Z}{3}>
}

example response
pair_id is not set:
{“errors”:false,”response”:{“entities”:[{“pair_id”:”1″,”min”:”0.00076610″,”max”:”0.75000000″,”
avg”:”0.29701284″,”vol”:”11.39379300″,”last_price”:”0.00770000″,”pair_name”:”LTC\/BTC”},{“pair_id”:”2″,”min”:”167.47000000″,”max”:”333.18700000″,”avg”:”288.33488725″,”vol”:”22.30009666″,”last_price”:”205.26200000″,”pair_name”:”BTC\/USD”},{“pair_id”:”3″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”pair_name”:”LTC\/USD”},{“pair_id”:”4″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”pair_name”:”LTC\/EUR”},{“pair_id”:”5″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”pair_name”:”LTC\/GBP”},{“pair_id”:”6″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”pair_name”:”LTC\/NOK”},{“pair_id”:”7″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”pair_name”:”LTC\/DKK”},{“pair_id”:”8″,”min”:”153.78000000″,”max”:”277.64967000″,”avg”:”230.87369999″,”vol”:”29.13258534″,”last_price”:”181.25300000″,”pair_name”:”BTC\/EUR”},{“pair_id”:”9″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”pair_name”:”BTC\/GBP”},{“pair_id”:”10″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”pair_name”:”BTC\/NOK”}],pagination”:{“total_items”:10,”items_per_page”:100,”current_page”:1,”total_pages”:1}}
pair_id is set:
{“errors”:false,”response”:{“entity”:{“pair_id”:”2″,”min”:”167.47″,”max”:”333.187″,”avg”:”288.335″,”vol”:”22.3001″,”pair_name”:”BTC\/USD”,”last_price”:”205.262″}}}

example error response
pair_id is not set:
{“errors”:{“nonce”:”incorrect range `nonce`=`1410425690`, must be from `1410426700` till `1410426700`”,”order_by”:”incorrect `order by`=`maks`, must be one of `pair_id|min|max|avg|vol`”,”order_direction”:”incorrect `order direction`=`DESK`, must be one of `ASC|DESC`”,”date_from”:”incorrect range `date from`=`1888534400`, must be from `1388534400` till `1410426700`”,”date_to”:”incorrect range `date to`=`1709584030`, must be from `1388534400` till `1410426700`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

pair_id is set:
{“errors”:{“nonce”:”incorrect range `nonce`=`1410425804`, must be from `1410426800` till `1410426812`”,”date_from”:”incorrect range `date from`=`1488534400`, must be from `1388534400` till `1410426812`”,”date_to”:”incorrect range `date to`=`1309584030`, must be from `1388534400` till `1410426812`”,”pair_id”:”incorrect `pair id`=`1.3`, must be digits”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
pair_id is not set:
{“errors”:false,”response”:{“entities”:false},”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

pair_id is set:
{“errors”:false,”response”:{“entity”:false}}

1.2 Method “stats/marketdepthbtcav”

This method provides info about currebcy pair, for a certain period of time (24h by default):

  • Name of currency pair (pair_name) as well as it id (pair_id)
  • Current lowest ask (min_ask) and highest bid (max_bid)
  • Trading volume of the last 24 hours (vol)
  • The price at which the last order executed (last_price)

Note: Value of params last_price, min_ask and max_bid don’t depend on chosen period of time (date_from, date_to) and always provides info for current time.

Api_method/api_action
GET stats/marketdepthbtcav

api_params (* – required param, ^- if param is set up, ^^-these params are ignored),
*nonce=<\d{10}>
^pair_id=<\d+>:all
date_from=<\d{10}>:current time-24hours
date_to=<\d{10}>:current time
^^order_by=<‘field_name’>:’pair_id’
^^order_direction=<asc|desc>:ASC
^^items_per_page=<\d+>:100
^^page=<\d+>:1

entity format
{
“pair_id”:<\d+>,
“min_ask”:<\d{1,8}\.d{0,8}>,
“max_bid”:<\d{1,8}\.d{0,8}>,
“vol”:<\d{1,8}\.d{0,8}>,
“last_price”:<\d{1,8}\.d{0,8}>,
“pair_name”:<{A-Z}{3}\/{A-Z}{3}>
}

example response
pair_id is not set:
{“errors”:false,”response”:{“entities”:[{“pair_id”:”1″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”max_bid”:”0.00000000″,”min_ask”:”0.00000000″,”pair_name”:”LTC\/BTC”},{“pair_id”:”2″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”max_bid”:”0.00000000″,”min_ask”:”0.00000000″,”pair_name”:”BTC\/USD”},{“pair_id”:”3″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”max_bid”:”0.00000000″,”min_ask”:”0.00000000″,”pair_name”:”LTC\/USD”},{“pair_id”:”4″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”max_bid”:”0.00000000″,”min_ask”:”0.00000000″,”pair_name”:”LTC\/EUR”},{“pair_id”:”5″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”max_bid”:”0.00000000″,”min_ask”:”0.00000000″,”pair_name”:”LTC\/GBP”},{“pair_id”:”6″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”max_bid”:”0.00000000″,”min_ask”:”0.00000000″,”pair_name”:”LTC\/NOK”},{“pair_id”:”7″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”max_bid”:”0.00000000″,”min_ask”:”0.00000000″,”pair_name”:”LTC\/DKK”},{“pair_id”:”8″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”max_bid”:”0.00000000″,”min_ask”:”0.00000000″,”pair_name”:”BTC\/EUR”},{“pair_id”:”9″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”max_bid”:”0.00000000″,”min_ask”:”0.00000000″,”pair_name”:”BTC\/GBP”},{“pair_id”:”10″,”vol”:”0.00000000″,”last_price”:”0.00000000″,”max_bid”:”0.00000000″,”min_ask”:”0.00000000″,”pair_name”:”BTC\/NOK”}]},”pagination”:{“total_items”:10,”items_per_page”:100,”current_page”:1,”total_pages”:1}}

pair_id is set:
{“errors”:false,”response”:{“entity”:{“pair_id”:”1″,”vol”:”0″,”last_price”:”0″,”max_bid”:”0″,”min_ask”:”0″,”pair_name”:”LTC\/BTC”}}}

example error response

pair_id is not set:
{“errors”:{“nonce”:”incorrect range `nonce`=`1410425690`, must be from `1410426700` till `1410426700`”,”order_by”:”incorrect `order by`=`maks`, must be one of `pair_id|min|max|avg|vol`”,”order_direction”:”incorrect `order direction`=`DESK`, must be one of `ASC|DESC`”,”date_from”:”incorrect range `date from`=`1888534400`, must be from `1388534400` till `1410426700`”,”date_to”:”incorrect range `date to`=`1709584030`, must be from `1388534400` till `1410426700`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

pair_id is set:
{“errors”:{“nonce”:”incorrect range `nonce`=`1410425804`, must be from `1410426800` till `1410426812`”,”date_from”:”incorrect range `date from`=`1488534400`, must be from `1388534400` till `1410426812`”,”date_to”:”incorrect range `date to`=`1309584030`, must be from `1388534400` till `1410426812`”,”pair_id”:”incorrect `pair id`=`1.3`, must be digits”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
pair_id is not set:
{“errors”:false,”response”:{“entities”:false},”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

pair_id is set:
{“errors”:false,”response”:{“entity”:false}}

1.3 Method “orderbook/info”

This method provides info about list of active buy/sell orders for a certain period of time:

  • Sell/buy price of current order (price)
  • Volume currency at this order (amount)

Max quantity of sended asks and bids is limited by 15000, to obtain full list of active orders you should set up param type, in this case data pagination is availible by using additonal params item_per_page and page (if param type isn’t set up these two params are ignored).

Note: In case of you set up custom time range (date_from, date_to) this API return the list of active orders that were created at chosen period of time.

api_method/api_action
GET orderbook/info

api_params (* – required params, ^- if param is NOT set up, ^^-these params are ignored),
*nonce=<\d{10}>
*pair_id=<\d+>
^type=<ask|bid>
date_from=<\d{10}>:current time-30days
date_to=<\d{10}>:current time
order_by=<‘field_name’>:’price’
order_direction=<asc|desc>:for bids – ASC, for ask – DESC
^^items_per_page=<\d+>:100
^^page=<\d+>:1

entity format
type is not set:
{
“asks”:{[
{
“price”:<\d{1,8}\.d{0,8}>,
“amount”:<\d{1,8}\.d{0,8}>,
}…. (max count: 15000)
]}
“bids”:{[
{
“price”:<\d{1,8}\.d{0,8}>,
“amount”:<\d{1,8}\.d{0,8}>,
}….(max count: 15000)
]}
}
type is set:
{
“price”:<\d{1,8}\.d{0,8}>,
“amount”:<\d{1,8}\.d{0,8}>,
}

example response
type is not set:
{“errors”:false,”response”:{“entity”:{“asks”:[{“price”:”0.75000000″,”amount”:”4.98002000″},{“price”:”0.75000000″,”amount”:”4.98002000″},{“price”:”0.75000000″,”amount”:”4.98002000″}],”bids”:[{“price”:”0.75000000″,”amount”:”4.98002000″},{“price”:”0.75000000″,”amount”:”4.98002000″},{“price”:”0.75000000″,”amount”:”4.98002000″}]}}}
type is set:
{“errors”:false,”response”:{“entities”:[{“price”:”0.75000000″,”amount”:”4.98002000″},{“price”:”0.75000000″,”amount”:”4.98002000″},{“price”:”0.75000000″,”amount”:”4.98002000″}]},”pagination”:{“total_items”:3,”items_per_page”:100,”current_page”:1,”total_pages”:1}}

example error response
type is not set:
{“errors”:{“nonce”:”incorrect range `nonce`=`1422280318`, must be from `1422281425` till `1422281445`”,”pair_id”:”errors.pair_id.not_empty”,”date_from”:”incorrect `date from`=`asd`, must be digits”,”date_to”:”incorrect `date to`=`qwe`, must be digits”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}
type is set:
{“errors”:{“nonce”:”incorrect range `nonce`=`1422280318`, must be from `1422281339` till `1422281359`”,”pair_id”:”errors.pair_id.not_empty”,”type”:”incorrect `type`=`eqw`, must satisfy rule `ask|bid`”,”date_from”:”incorrect `date from`=`asd`, must be
digits”,”date_to”:”incorrect `date to`=`qwe`, must be digits”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
type is not set:
{“errors”:false,”response”:{“entity”:{“asks”:[],”bids”:[]}}}

type is set:
{“errors”:false,”response”:{“entities”:[]},”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

1.4 The list of available currencies

This method allows to obtain info about the currencies at our exchange:

  • currency Id (id),
  • short (iso) and full currency name (name)

api_method/api_action
GET currency/list

api_params (* – required parameter)
*nonce=<\d{10}>
order_by=<‘field_name’>:’currency_id’
order_direction=<asc|desc>:ASC
items_per_page=<\d+>:100
page=<\d+>:1

entity format
{
“id”:<\d+> AS “currency_id”,
“iso”:<\w{3}>,
“name”:<\w+>
}

example response
{“errors”:false,”response”:{“entities”:[{“currency_id”:”3″,”iso”:”USD”,”name”:”United States Dollar”},{“currency_id”:”13″,”iso”:”UAH”,”name”:”Hryvnia”},{“currency_id”:”9″,”iso”:”SEK”,”name”:”Swedish Krona”},{“currency_id”:”12″,”iso”:”RUB”,”name”:”Russian Ruble”},{“currency_id”:”8″,”iso”:”PPC”,”name”:”Peercoin”},{“currency_id”:”11″,”iso”:”NXT”,”name”:”Nextcoin”},{“currency_id”:”6″,”iso”:”NOK”,”name”:”Norwegian Kroner”},{“currency_id”:”1″,”iso”:”LTC”,”name”:”Litecoin”},{“currency_id”:”5″,”iso”:”GBR”,”name”:”British Pound”},{“currency_id”:”4″,”iso”:”EUR”,”name”:”Euro”},{“currency_id”:”7″,”iso”:”DKK”,”name”:”Danish Krone”},{“currency_id”:”10″,”iso”:”CHF”,”name”:”Swiss Franc”},{“currency_id”:”2″,”iso”:”BTC”,”name”:”Bitcoin”}]},”pagination”:{“total_items”:13,”items_per_page”:100,”current_page”:1,”total_pages”:1}}

example error response
{“errors”:{“nonce”:”incorrect range `nonce`=`1410364676`, must be from `1410364700` till `1410364787`”,”order_by”:”incorrect `order by`=`id`, must be one of `currency_id|iso|name`”,”order_direction”:”incorrect `order direction`=`DESK`, must be one of `ASC|DESC`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entities”:false},”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

1.5 Information about a particular currency

This method is similar to one described in the section 1.4, but it allows to obtain information about a particular currency:

  • currency Id (id) – corresponds to currency_id,
  • short (iso) and full currency name (name)

api_method/api_action
GET currency/info
api_params * – required parameter
*nonce=<\d{10}>
*currency_id=<\d{10}>

entity format
{
“id”:<\d+> AS “currency_id”,
“iso”:<\w{3}>,
“name”:<\w+>
}

example response
{“errors”:false,”response”:{“entities”:[{“currency_id”:”3″,”iso”:”USD”,”name”:”United States Dollar”},{“currency_id”:”13″,”iso”:”UAH”,”name”:”Hryvnia”},{“currency_id”:”9″,”iso”:”SEK”,”name”:”Swedish Krona”},{“currency_id”:”12″,”iso”:”RUB”,”name”:”Russian Ruble”},{“currency_id”:”8″,”iso”:”PPC”,”name”:”Peercoin”},{“currency_id”:”11″,”iso”:”NXT”,”name”:”Nextcoin”},{“currency_id”:”6″,”iso”:”NOK”,”name”:”Norwegian Kroner”},{“currency_id”:”1″,”iso”:”LTC”,”name”:”Litecoin”},{“currency_id”:”5″,”iso”:”GBR”,”name”:”British Pound”},{“currency_id”:”4″,”iso”:”EUR”,”name”:”Euro”},{“currency_id”:”7″,”iso”:”DKK”,”name”:”Danish Krone”},{“currency_id”:”10″,”iso”:”CHF”,”name”:”Swiss Franc”},{“currency_id”:”2″,”iso”:”BTC”,”name”:”Bitcoin”}]},”pagination”:{“total_items”:13,”items_per_page”:100,”current_page”:1,”total_pages”:1}}

example error response
{“errors”:{“nonce”:”incorrect range `nonce`=`1410364047`, must be from `1410364700` till `1410364707`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entity”:false}}

1.6 The list of available currency pairs

The method provides information about all currency pairs at exchange:

  • currency pair id (id),
  • the first currency id in a currency pair (currency_id_from),
  • the second currency id in a currency pair (currency_id_to)

api_method/api_action
GET pair /list
api_params * – required parameter
*nonce=<\d{10}>
order_by=<‘field_name’>:’pair_id’
order_direction=<asc|desc>:ASC
items_per_page=<\d+>:100
page=<\d+>:1

entity format
{
“id”:<\d+> AS “pair_id”,
“currency_id_from”:<\d+>,
“currency_id_to”:<\d+>
}

example response
{“errors”:false,”response”:{“entities”:[{“pair_id”:”41″,”currency_id_from”:”11″,”currency_id_to”:”13″},{“pair_id”:”40″,”currency_id_from”:”8″,”currency_id_to”:”13″},{“pair_id”:”39″,”currency_id_from”:”2″,”currency_id_to”:”13″},{“pair_id”:”38″,”currency_id_from”:”1″,”currency_id_to”:”13″},{“pair_id”:”37″,”currency_id_from”:”11″,”currency_id_to”:”12″},{“pair_id”:”36″,”currency_id_from”:”8″,”currency_id_to”:”12″},{“pair_id”:”35″,”currency_id_from”:”2″,”currency_id_to”:”12″},{“pair_id”:”34″,”currency_id_from”:”1″,”currency_id_to”:”12″},{“pair_id”:”33″,”currency_id_from”:”11″,”currency_id_to”:”4″},{“pair_id”:”32″,”currency_id_from”:”11″,”currency_id_to”:”5″}]},”pagination”:{“total_items”:41,”items_per_page”:10,”current_page”:1,”total_pages”:5}}

example error response
{“errors”:{“nonce”:”incorrect range `nonce`=`1410365281`, must be from `1410365400` till `1410365436`”,”order_by”:”incorrect `order by`=`id`, must be one of `pair_id|currency_id_from|currency_id_to`”,”order_direction”:”incorrect `order direction`=`ASK`, must be one of `ASC|DESC`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entities”:false},”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

1.7 Information about a particular currency pair

This method is similar to #1.6. but it allows to obtain information about a specific currency pair:

  • currency pair id (id) – corresponds to pair_id,
  • first currency id in a currency pair (currency_id_from),
  • second currency id in a currency pair (currency_id_to)

api_method/api_action
GET pair/info
api_params * – required parameter
*nonce=<\d{10}>
*pair_id=<\d{10}>

entity format
{
“id”:<\d+> AS “pair_id”,
“currency_id_from”:<\d+>,
“currency_id_to”:<\d+>
}

example response
{“errors”:false,”response”:{“entity”:{“pair_id”:”12″,”currency_id_from”:”8″,”currency_id_to”:”1″}}}

example error response
{“errors”:{“nonce”:”incorrect range `nonce`=`1410364047`, must be from `1410364700` till `1410364707`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entity”:false}}

1.8 Statistics on the currency pairs

This method provides a summary of the market for a certain period:

  • currency pair id (pair_id),
  • Minimum (min), maximum (max) and average (avg) prices
  • volume of transactions (vol)

The time interval is set by parameters date_from anddate_to, by default API provides info for the last 30 days
If the option pair_id is set, it is possible to obtain info for one specific currency pair, in this case the parametersorder_by, pair_id,order_direction, items_per_page,page will be ignored.

api_method/api_action
GET stats/marketdepth

api_params * – required parameter ^-if the parameter is set, then ^ are parameters are ignored
*nonce=<\d{10}>
^pair_id=<\d+>:all
date_from=<\d{10}>:current time-30days
date_to=<\d{10}>:current time
^order_by=<‘field_name’>:’pair_id’
^order_direction=<asc|desc>:ASC
^items_per_page=<\d+>:100
^page=<\d+>:1

entity format
{
“pair_id”:<\d+>,
“min”:<\d{1,8}\.d{0,8}>,
“max”:<\d{1,8}\.d{0,8}>,
“avg”:<\d{1,8}\.d{0,8}>,
“vol”:<\d{1,8}\.d{0,8}>
}

example response
pair_id not set:
{“errors”:false,”response”:{“entities”:[{“pair_id”:”10″,”min”:”3250.00000000″,”max”:”4010.00000000″,”avg”:”3729.54867956″,”vol”:”698.32600000″},{“pair_id”:”11″,”min”:”3000.00000000″,”max”:”3952.00000000″,”avg”:”3528.71959356″,”vol”:”1038.05361212″},{“pair_id”:”2″,”min”:”449.00000000″,”max”:”681.00000000″,”avg”:”627.76569416″,”vol”:”1564.83499200″},{“pair_id”:”8″,”min”:”395.00000000″,”max”:”510.00000000″,”avg”:”463.74052959″,”vol”:”828.14981620″},{“pair_id”:”9″,”min”:”315.00000000″,”max”:”390.00000000″,”avg”:”361.95224874″,”vol”:”532.60248000″},{“pair_id”:”4″,”min”:”7.00000000″,”max”:”10.00000000″,”avg”:”7.80000000″,”vol”:”10.00000000″},{“pair_id”:”33″,”min”:”0.03600000″,”max”:”0.05000000″,”avg”:”0.03824549″,”vol”:”183245.09883586″},{“pair_id”:”28″,”min”:”0.03000000″,”max”:”0.04000000″,”avg”:”0.03433735″,”vol”:”55.33333334″},{“pair_id”:”32″,”min”:”0.02760000″,”max”:”0.04000000″,”avg”:”0.03475733″,”vol”:”7449.40000000″},{“pair_id”:”31″,”min”:”0.02600000″,”max”:”0.06500000″,”avg”:”0.05388687″,”vol”:”90502.37800686″},{“pair_id”:”1″,”min”:”0.02000000″,”max”:”0.02000000″,”avg”:”0.02000000″,”vol”:”10.00000000″},{“pair_id”:”29″,”min”:”0.00500000″,”max”:”0.00809529″,”avg”:”0.00514631″,”vol”:”5350.80680000″},{“pair_id”:”13″,”min”:”0.00320000″,”max”:”0.00320000″,”avg”:”0.00320000″,”vol”:”6.12500000″},{“pair_id”:”30″,”min”:”0.00005000″,”max”:”0.00009000″,”avg”:”0.00007985″,”vol”:”168443.79353160″},{“pair_id”:”27″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”5″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”19″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”38″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”20″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”39″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”14″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”17″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”24″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”25″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”3″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”6″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”22″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”37″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”23″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”12″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”15″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”18″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”36″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”26″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”7″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”34″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”41″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”35″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”16″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”21″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″},{“pair_id”:”40″,”min”:”0.00000000″,”max”:”0.00000000″,”avg”:”0.00000000″,”vol”:”0.00000000″}]},”pagination”:{“total_items”:41,”items_per_page”:100,”current_page”:1,”total_pages”:1}}
pair_id set:
{“errors”:false,”response”:{“entity”:{“pair_id”:”13″,”min”:”0.0032″,”max”:”0.0032″,”avg”:”0.0032″,”vol”:”6.125″}}}

example error response
{“errors”:{“nonce”:”incorrect range `nonce`=`1410425690`, must be from `1410426700` till `1410426700`”,”order_by”:”incorrect `order by`=`maks`, must be one of `pair_id|min|max|avg|vol`”,”order_direction”:”incorrect `order direction`=`DESK`, must be one of `ASC|DESC`”,”date_from”:”incorrect range `date from`=`1888534400`, must be from `1388534400` till `1410426700`”,”date_to”:”incorrect range `date to`=`1709584030`, must be from `1388534400` till `1410426700`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}
{“errors”:{“nonce”:”incorrect range `nonce`=`1410425804`, must be from `1410426800` till `1410426812`”,”date_from”:”incorrect range `date from`=`1488534400`, must be from `1388534400` till `1410426812`”,”date_to”:”incorrect range `date to`=`1309584030`, must be from `1388534400` till `1410426812`”,”pair_id”:”incorrect `pair id`=`1.3`, must be digits”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entities”:false},”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}
{“errors”:false,”response”:{“entity”:false}}

1.9 Information on trades

This method provides archive information about transactions committed at our exchange for a certain period:

  • trading id (id),
  • Currency pair id (pair_id),
  • Type of the transaction – type = sell / buy,
  • Buying/selling price (price),
  • The volume of transactions (volume),
  • Exchange fee (fee),
  • The date of the transaction (created) in the unix format

This method also allows you to get information about a particular type of transaction, if you set up type. The time interval can be set up using parameters date_from and date_to, by default it provides info for the last 30 days

api_method/api_action
GET trade/list

api_params * – required parameter
*nonce=<\d{10}>
pair_id=<\d+>:all
type=<buy|sell>:all
date_from=<\d{10}>:current time-30days
date_to=<\d{10}>:current time
order_by=<‘field_name’>:’pair_id’
order_direction=<asc|desc>:DESC
items_per_page=<\d+>:1000
page=<\d+>:1

entity format
{
“id”:<\d+> AS “trade_id”,
“pair_id”:<\d+>,
“type”:<\w+>,
“price”:<\d{1,8}\.d{0,8}>,
“volume”:<\d{1,8}\.d{0,8}>,
“fee”:<\d{1,8}\.d{0,8}>,
“created”:<\d{10}>
}

example response
“errors”:false,”response”:{“entities”:[{“trade_id”:”103″,”pair_id”:”2″,”type”:”buy”,”price”:”580.00000000″,”volume”:”0.67000000″,”fee”:”0.00000000″,”created”:”1401839829″},{“trade_id”:”107″,”pair_id”:”2″,”type”:”buy”,”price”:”580.00000000″,”volume”:”0.07000000″,”fee”:”0.00000000″,”created”:”1401840101″},{“trade_id”:”111″,”pair_id”:”2″,”type”:”buy”,”price”:”580.00000000″,”volume”:”0.67000000″,”fee”:”0.00000000″,”created”:”1401840111″},{“trade_id”:”115″,”pair_id”:”2″,”type”:”buy”,”price”:”580.00000000″,”volume”:”0.04000000″,”fee”:”0.00000000″,”created”:”1401840121″},{“trade_id”:”119″,”pair_id”:”2″,”type”:”buy”,”price”:”580.00000000″,”volume”:”2.55000000″,”fee”:”0.00000000″,”created”:”1401840240″},{“trade_id”:”123″,”pair_id”:”2″,”type”:”buy”,”price”:”567.00000000″,”volume”:”10.00000000″,”fee”:”0.00000000″,”created”:”1401840240″},{“trade_id”:”127″,”pair_id”:”2″,”type”:”buy”,”price”:”550.00000000″,”volume”:”2.18130000″,”fee”:”0.00000000″,”created”:”1401840240″}]},”pagination”:{“total_items”:412,”items_per_page”:7,”current_page”:4,”total_pages”:59}}

example error response
{“errors”:{“order_by”:”incorrect `order by`=`id`, must be one of `trade_id|pair_id|type|price|volume|fee|created`”,”order_direction”:”incorrect `order direction`=`ASK`, must be one of `ASC|DESC`”,”items_per_page”:”incorrect `items per page`=`7.1`, must be digits”,”page”:”incorrect `page`=`0.4`, must be digits”,”type”:”incorrect `type`=`buuy`, must satisfy rule `NULL|buy|sell`”,”date_from”:”incorrect range `date from`=`1488534400`, must be from `1388534400` till `1410428445`”,”date_to”:”incorrect `date to`=`1409584030`, must be more than `date from`=`1488534400`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entities”:false},”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

1.10 Information about a particular trade

The method provides information about a specific transaction (trade_id):

  • trading id (id),
  • currency pair id (pair_id),
  • Type of transaction – type = sell / buy,
  • Buying / selling price (price),
  • The volume of transactions (volume),
  • Exchange fee(fee),
  • The date of the transaction (created) in the unix format

api_method/api_action
GET trade/info

api_params * – required parameter
*nonce=<\d{10}>
*trade_id=<\d{10}>

entity format
{
“id”:<\d+> AS “trade_id”,
“pair_id”:<\d+>,
“type”:<\w+>,
“price”:<\d{1,8}\.d{0,8}>,
“volume”:<\d{1,8}\.d{0,8}>,
“fee”:<\d{1,8}\.d{0,8}>,
“created”:<\d{10}>
}

example response
“errors”:false,”response”:{“entity”:{“trade_id”:”1705″,”pair_id”:”30″,”type”:”sell”,”price”:”0.00008995″,”volume”:”2.00000000″,”fee”:”0.00400000″,”created”:”1405786448″}}}

example error response
{“errors”:{“nonce”:”incorrect range `nonce`=`1410428426`, must be from `1410428600` till `1410428615`”,”trade_id”:”incorrect `trade id`=`17.05`, must be digits”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entity”:false}}</asc|desc></buy|sell></asc|desc></asc|desc></asc|desc></asc|desc></ask|bid></asc|desc></asc|desc>

Private API OF ICE3X.COM

Private API
=====================
To access this API requires authentication and you must use POST method. The exception is the receipt of the invoice pdf file.

Authorization is performed by sending to the server the following headings:

Key – The public key, it is necessary to take the user’s profile settings
(example: 1KАF69ZVYNHGG109SBKSSX5VI8TUC7CA236VPTXEH7JLRMB2RIWZH1VFHVGBLZU4)
Sign – POST data (param = val &amp; param1 = val1 … &amp; paramN = valN), signed by the secret key HMAC-SHA512, secret key is also necessary to take in the user profile settings (example: 1e0oe19wfn11s3t2lzmvrt26izlaky8k22ko88zroki74cp1y9kdd812i0y7rtxj)

Code examples in PHP:

function api_post ( $url, array $data )
{
$public = ‘…your public key…’;
$private = ‘…your private key…’;
$post_data = http_build_query ( $data );
$sign = hash_hmac ( ‘sha512’, $post_data, $private );
$headers = array( “Key: $public”, “Sign: {$sign}” );
$ch = curl_init ();
curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt ( $ch, CURLOPT_USERAGENT, ‘Mozilla/4.0 (compatible; ICE3X PHP client; ‘ . php_uname ( ‘s’ ) . ‘; PHP/’ . phpversion () . ‘)’ );
curl_setopt ( $ch, CURLOPT_URL, URL::site ( $url ) );
curl_setopt ( $ch, CURLOPT_POSTFIELDS, $post_data );
curl_setopt ( $ch, CURLOPT_HTTPHEADER, $headers );
$result = curl_exec ( $ch );
curl_close ( $ch );
if ( $result === false )
{
throw new Exception(‘Could not get reply: ‘ . curl_error ( $ch ));
}
if ( !($result = json_decode ( $result, true )) )
{
switch ( json_last_error () )
{
case JSON_ERROR_DEPTH:
$error = ‘Reached the maximum stack depth’;
break;
case JSON_ERROR_STATE_MISMATCH:
$error = ‘Incorrect discharges or mismatch mode’;
break;
case JSON_ERROR_CTRL_CHAR:
$error = ‘Incorrect control character’;
break;
case JSON_ERROR_SYNTAX:
$error = ‘Syntax error or JSON invalid’;
break;
case JSON_ERROR_UTF8:
$error = ‘Invalid UTF-8 characters, possibly invalid encoding’;
break;
default:
$error = ‘Unknown error’;
}
throw new Exception($error);
}
return $result;
}
function api_get ( $url, array $data, $auth = false )
{
$ch = curl_init ();
curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt ( $ch, CURLOPT_USERAGENT, ‘Mozilla/4.0 (compatible; ICE3X PHP client; ‘ . php_uname ( ‘s’ ) . ‘; PHP/’ . phpversion () . ‘)’ );
$get_data = http_build_query ( $data );
if ( $auth )
{
$public = ‘…your public key…’;
$private = ‘…your private key…’;
$sign = hash_hmac ( ‘sha512’, $get_data, $private );
$headers = array( “Key: $public”, “Sign: $sign” );
curl_setopt ( $ch, CURLOPT_HTTPHEADER, $headers );
}
curl_setopt ( $ch, CURLOPT_URL, URL::site ( $url ) . “?$get_data” );
$result = curl_exec ( $ch );
curl_close ( $ch );
if ( $result === false )
{
throw new Exception(‘Could not get reply: ‘ . curl_error ( $ch ));
}
if ( strpos ( $result, ‘PDF’ ) !== false )
{
$file = ‘file.pdf’;
$filename = ‘file_name.pdf’;
file_put_contents ( $file, $result );
header ( ‘Content-type: application/pdf’ );
header ( ‘Content-Disposition: inline; filename=”‘ . $filename . ‘”‘ );
header ( ‘Content-Transfer-Encoding: binary’ );
header ( ‘Content-Length: ‘ . filesize ( $file ) );
header ( ‘Accept-Ranges: bytes’ );
readfile ( $file );
die();
}
if ( !($result = json_decode ( $result, true )) )
{
switch ( json_last_error () )
{
case JSON_ERROR_DEPTH:
$error = ‘Reached the maximum stack depth’;
break;
case JSON_ERROR_STATE_MISMATCH:
$error = ‘Incorrect discharges or mismatch mode’;
break;
case JSON_ERROR_CTRL_CHAR:
$error = ‘Incorrect control character’;
break;
case JSON_ERROR_SYNTAX:
$error = ‘Syntax error or JSON invalid’;
break;
case JSON_ERROR_UTF8:
$error = ‘Invalid UTF-8 characters, possibly invalid encoding’;
break;
default:
$error = ‘Unknown error’;
}
throw new Exception($error);
}
return $result;
}

2 Description PRIVATE API

2.1 List of User’s balances

The method allows to obtain a list of user’s balances:

  • Currency id on the balance (currency_id)
  • The amount of money on the balance (balance)
  • A unique account address (address)

api_method/api_action
POST balance/list

api_params * – required parameter
*nonce=<\d{10}>
order_by=<‘field_name’>:’balance_id’
order_direction=<asc|desc>:ASC
items_per_page=<\d+>:100
page=<\d+>:1

entity format
{
“currency_id”:<\d+>,
“balance”:<\d{1,8}\.d{0,8}>,
“address”:<null|[0-9a-za-z]+>
}

example response
{“errors”:false,”response”:{“entities”:[{“currency_id”:”1″,”balance”:”0.00000000″,”address”:”LLHVnrXrQP1sjxNXLrRQTnZmnpc9N33KL6″},{“currency_id”:”2″,”balance”:”0.75000000″,”address”:”1GzUJoStC9CHpzFPBGtZF7D7or9c3PdsG7″},{“currency_id”:”3″,”balance”:”90.00000000″,”address”:null},{“currency_id”:”4″,”balance”:”10.00000000″,”address”:null},{“currency_id”:”5″,”balance”:”0.00000000″,”address”:null}]},”pagination”:{“total_items”:13,”items_per_page”:5,”current_page”:1,”total_pages”:3}}

example error response
{“errors”:{“nonce”:”incorrect range `nonce`=`1410436278`, must be from `1410436300` till `1410436378`”,”order_by”:”incorrect `order by`=`id`, must be one of `currency_id|balance|address`”,”order_direction”:”incorrect `order direction`=`ASSC`, must be one of `ASC|DESC`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entities”:false},”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

2.2 Information on the user’s balance

The method returns information about user’s balance in the specified currency (currency_id):

  • Currency id on the balance (currency_id)
  • The amount of money on the balance (balance)
  • unique account address (address)

api_method/api_action
POST balance/info

api_params * – required parameter
*nonce=<\d{10}>
*currency_id=<\d+>
entity format
{
“currency_id”:<\d+>,
“balance”:<\d{1,8}\.d{0,8}>,
“address”:<null|[0-9a-za-z]+>
}

example response
{“errors”:false,”response”:{“entity”:{“currency_id”:”12″,”balance”:”0.00000000″,”address”:null}}}
example error response
{“errors”:{“nonce”:”incorrect range `nonce`=`1410436378`, must be from `1410436400` till `1410436402`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entity”:false}}

2.3 List of user’s trades

The method provides information on the transactions which were made by the user for a certain period (by default 30 days):

  • transaction id (id)
  • Currency pair id of transaction (pair_id)
  • Transaction type (type=buy|sell)
  • The user’s role in the transaction is determined by the flags is_buyer – buyer andis_seller – seller
  • Price of purchase / sale (price)
  • The volume of transactions (volume),
  • Exchange fee (fee),
  • The date of the transaction (created) in the unix format

api_method/api_action
POST trade/list

api_params * – required parameter
*nonce=<\d{10}>
pair_id=<\d+>:all
type=<buy|sell>:all
date_from=<\d{10}>:current time-30days
date_to=<\d{10}>:current time
order_by=<‘field_name’>:’trade_id’
order_direction=<asc|desc>:DESC
items_per_page=<\d+>:1000
page=<\d+>:1

entity format
{
“id”:<\d+> AS “trade_id”,
“pair_id”:<\d+>,
“type”:<buy|sell>,
“is_buyer”:<0|1>,
“is_seller”:<0|1>,
“price”:<\d{1,8}\.d{0,8}>,
“volume”:<\d{1,8}\.d{0,8}>,
“fee”:<\d{1,8}\.d{0,8}>,
“created”:<\d{10}>
}

example response
{“errors”:false,”response”:{“entities”:[{“trade_id”:”1710″,”pair_id”:”30″,”type”:”buy”,”is_buyer”:”0″,”is_seller”:”1″,”price”:”0.00005505″,”volume”:”1.22320232″,”fee”:”0.00000013″,”created”:”1405787314″},{“trade_id”:”1714″,”pair_id”:”30″,”type”:”buy”,”is_buyer”:”0″,”is_seller”:”1″,”price”:”0.00005505″,”volume”:”1.00000000″,”fee”:”0.00000011″,”created”:”1405787314″},{“trade_id”:”1718″,”pair_id”:”30″,”type”:”buy”,”is_buyer”:”0″,”is_seller”:”1″,”price”:”0.00005505″,”volume”:”1.03679768″,”fee”:”0.00000011″,”created”:”1405787314″},{“trade_id”:”1720″,”pair_id”:”30″,”type”:”buy”,”is_buyer”:”0″,”is_seller”:”1″,”price”:”0.00005505″,”volume”:”2.22000000″,”fee”:”0.00000024″,”created”:”1405787369″},{“trade_id”:”1780″,”pair_id”:”30″,”type”:”buy”,”is_buyer”:”0″,”is_seller”:”1″,”price”:”0.00007600″,”volume”:”5000.00000000″,”fee”:”0.00076000″,”created”:”1405964079″}]},”pagination”:{“total_items”:5,”items_per_page”:10,”current_page”:1,”total_pages”:1}}

example error response
{“errors”:{“nonce”:”incorrect range `nonce`=`1410437250`, must be from `1410437300` till `1410437350`”,”order_by”:”incorrect `order by`=`id`, must be one of `trade_id|pair_id|type|is_buyer|is_seller|price|volume|fee|created`”,”pair_id”:”incorrect `pair id`=`30.1`, must satisfy rule `d+|NULL`”,”date_from”:”incorrect range `date from`=`1488534400`, must be from `1388534400` till `1410437350`”,”date_to”:”incorrect `date to`=`1409584030`, must be more than `date from`=`1488534400`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entities”:false},”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

2.4 Information about user’s trade

The method provides information about a transaction specified (trade_id) advanced user:

  • Transaction id (id)
  • Currency pair id of the transaction (pair_id)
  • Transaction type (type=buy|sell)
  • User’s role in the transaction is determined by the flags is_buyer for buyer andis_seller for seller
  • Price of purchase / sale (price)
  • The volume of transactions (volume),
  • Exchange fee (fee),
  • The date of the transaction (created) in the unix format

api_method/api_action
POST trade/info
api_params * – required parameter
*nonce=<\d{10}>
*currency_id=<\d+>

entity format
{
“id”:<\d+> AS “trade_id”,
“pair_id”:<\d+>,
“type”:<buy|sell>,
“is_buyer”:<0|1>,
“is_seller”:<0|1>,
“price”:<\d{1,8}\.d{0,8}>,
“volume”:<\d{1,8}\.d{0,8}>,
“fee”:<\d{1,8}\.d{0,8}>,
“created”:<\d{10}>
}

example response
{“errors”:false,”response”:{“entity”:{“trade_id”:”1705″,”pair_id”:”30″,”type”:”sell”,”is_buyer”:”1″,”is_seller”:”0″,”price”:”0.00008995″,”volume”:”2.00000000″,”fee”:”0.00400000″,”created”:”1405786448″}}}

example error response
{“errors”:{“nonce”:”incorrect range `nonce`=`1410436378`, must be from `1410436400` till `1410436402`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entity”:false}}

2.5 List of user’s transactions

The method returns data on transactions performed by the user for a certain period (default 30 days):

  • transaction id (transaction_id)
  • Transaction type (type)
  • currency id (currency_id)
  • invoice id (invoice_id)
  • Payment transaction id (Payment_transaction_id)
  • The amount of money of the transaction (volume)
  • The date of the transaction (created) in the unix format

Possible values for type:

  • balance_deposit – money deposite
  • balance_withdraw – withdrawal
  • order_create – creating order
  • order_cancel – cancellation of order
  • order_trade – trading on active order
  • system_commission – Exchange trading fees
  • payment_transaction – payment transaction

api_method/api_action
POST transaction/list
api_params * – required parameter
*nonce=<\d{10}>
currency_id=<\d+>:all
type=<balance_deposit|balance_withdraw|order_create|order_cancel|order_trade|system_commission|payment_transaction>:all
date_from=<\d{10}>:current time-30days
date_to=<\d{10}>:current time
order_by=<‘field_name’>:’transaction_id’
order_direction=<asc|desc>:DESC
items_per_page=<\d+>:1000
page=<\d+>:1

entity format
{
“id”:<\d+> AS “transaction_id”,
“type”:<\w+>,
“currency_id”:<\d+>,
“invoice_id”:<\d+>,
“payment_transaction_id”:<\d+>,
“volume”:<\d{1,8}\.d{0,8}>,
“created”:<\d{10}>
}

example response
{“errors”:false,”response”:{“entities”:[{“transaction_id”:”6496″,”type”:”system_commission”,”currency_id”:”3″,”invoice_id”:”745″,”payment_transaction_id”:null,”volume”:”5.00000000″,”created”:”1408618711″},{“transaction_id”:”6497″,”type”:”balance_withdraw”,”currency_id”:”2″,”invoice_id”:”746″,”payment_transaction_id”:null,”volume”:”0.81154800″,”created”:”1409325491″},{“transaction_id”:”6498″,”type”:”system_commission”,”currency_id”:”2″,”invoice_id”:”746″,”payment_transaction_id”:null,”volume”:”0.00100000″,”created”:”1409325491″},{“transaction_id”:”6499″,”type”:”balance_withdraw”,”currency_id”:”2″,”invoice_id”:”747″,”payment_transaction_id”:null,”volume”:”0.25000000″,”created”:”1409574606″},{“transaction_id”:”6500″,”type”:”system_commission”,”currency_id”:”2″,”invoice_id”:”747″,”payment_transaction_id”:null,”volume”:”0.00100000″,”created”:”1409574606″}]},”pagination”:{“total_items”:22,”items_per_page”:5,”current_page”:2,”total_pages”:5}}

example error response
{“errors”:{“order_by”:”incorrect `order by`=`id`, must be one of `transaction_id|type|currency_id|invoice_id|payment_transaction_id|volume|created`”,”type”:”incorrect `type`=`payment_id`, must satisfy rule `NULL|balance_deposit|balance_withdraw|order_create|order_cancel|order_trade|system_commission|payment_transaction`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}
empty response

2.6 Information about user’s transaction

The method provides data for one particular user’s transaction (transaction_id)

  • transaction id (transaction_id)
  • Transaction type (type)
  • currency id (currency_id)
  • invoice id (invoice_id)
  • Payment transaction id (Payment_transaction_id)
  • The amount of money of the transaction (volume)
  • The date of the transaction (created) in the unix format

Possible values for type:

  • balance_deposit – money deposite
  • balance_withdraw – withdrawal
  • order_create – creating order
  • order_cancel – cancellation of order
  • order_trade – trading on active order
  • system_commission – Exchange trading fees
  • payment_transaction – payment transaction

api_method/api_action
POST transaction /info

api_params * – required parameter
*nonce=<\d{10}>
*transaction_id=<\d+>

entity format
{
“id”:<\d+> AS “transaction_id”,
“type”:<\w+>,
“currency_id”:<\d+>,
“invoice_id”:<\d+>,
“payment_transaction_id”:<\d+>,
“volume”:<\d{1,8}\.d{0,8}>,
“created”:<\d{10}>
}

example response
{“errors”:false,”response”:{“entity”:{“transaction_id”:”6513″,”type”:”order_create”,”currency_id”:”2″,”invoice_id”:null,”payment_transaction_id”:null,”volume”:”0.55000000″,”created”:”1410342617″}}}

example error response
{“errors”:{“transaction_id”:”incorrect `transaction id`=`a`, must be digits”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entity”:false}}

2.7 The list of user’s active orders

The method provides the list of active orders of the user

  • order id (order_id)
  • Currency pair id (pair_id)
  • Order type (type) – buy / sell
  • The volume of transactions (volume)
  • Price purchase / sale (price)
  • Exchange fee (fee)
  • The status of the order (active) – 0/1
  • The date of order creation (created)

api_method/api_action
POST order/list

entity format
{
“id”:<\d+> AS “order_id”,
“pair_id”:<\d+>,
“type”:<buy|sell>,
“volume”:<\d{1,8}\.d{0,8}>,
“price”:<\d{1,8}\.d{0,8}>,
“fee”:<\d{1,8}\.d{0,8}>,
“active”:<0|1>,
“created”:<\d{10}>
}

example response
{“errors”:false,”response”:{“entities”:[{“order_id”:”1617″,”pair_id”:”3″,”type”:”sell”,”volume”:”48.00000000″,”price”:”9.50000000″,”fee”:”0.91200000″,”active”:”1″,”created”:”1406098537″},{“order_id”:”1618″,”pair_id”:”29″,”type”:”buy”,”volume”:”400000.00000000″,”price”:”0.00000490″,”fee”:”0.00392000″,”active”:”1″,”created”:”1406098846″},{“order_id”:”1619″,”pair_id”:”3″,”type”:”sell”,”volume”:”100.00000000″,”price”:”9.04000000″,”fee”:”1.80800000″,”active”:”1″,”created”:”1406100051″},{“order_id”:”1620″,”pair_id”:”29″,”type”:”buy”,”volume”:”7451.05660000″,”price”:”0.00500000″,”fee”:”0.07451057″,”active”:”1″,”created”:”1406687985″},{“order_id”:”1621″,”pair_id”:”1″,”type”:”sell”,”volume”:”150.03600000″,”price”:”0.01900000″,”fee”:”0.00570137″,”active”:”1″,”created”:”1406100573″},{“order_id”:”1668″,”pair_id”:”31″,”type”:”sell”,”volume”:”5018.00000000″,”price”:”0.08500000″,”fee”:”0.85306000″,”active”:”1″,”created”:”1406243639″},{“order_id”:”1951″,”pair_id”:”31″,”type”:”sell”,”volume”:”2060.51217987″,”price”:”0.06000000″,”fee”:”0.24726146″,”active”:”1″,”created”:”1407354806″},{“order_id”:”2009″,”pair_id”:”29″,”type”:”sell”,”volume”:”499.00000000″,”price”:”0.01000000″,”fee”:”0.00998000″,”active”:”1″,”created”:”1408455864″}]},”pagination”:{“total_items”:8,”items_per_page”:10,”current_page”:1,”total_pages”:1}}

example error response
{“errors”:{“nonce”:”incorrect range `nonce`=`1410442611`, must be from `1410442700` till `1410442711`”,”order_by”:”incorrect `order by`=`id`, must be one of `order_id|pair_id|type|volume|price|fee|active|created`”,”order_direction”:”incorrect `order direction`=`ACK`, must be one of `ASC|DESC`”,”pair_id”:”incorrect `pair id`=`1.3`, must satisfy rule `d+|NULL`”,”type”:”incorrect `type`=`buyy`, must satisfy rule `NULL|buy|sell`”,”date_from”:”incorrect range `date from`=`1488534400`, must be from `1388534400` till `1410442711`”,”date_to”:”incorrect `date to`=`1410345156`, must be more than `date from`=`1488534400`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entities”:false},”pagination”:{“total_items”:0,”items_per_page”:0,”
current_page”:0,”total_pages”:0}}

2.8 Information about user’s order

The method provides information about a particular user’s active order(order_id)

  • order id (order_id)
  • Currency pair id (pair_id)
  • Order type (type) – buy / sell
  • The volume of transactions (volume)
  • Price purchase / sale (price)
  • Exchange fee (fee)
  • The status of the order (active) – 0/1
  • The date of order creation (created)

api_method/api_action
POST order /info

api_params * – required parameter
*nonce=<\d{10}>
*order _id=<\d+>

entity format
{
“id”:<\d+> AS “order_id”,
“pair_id”:<\d+>,
“type”:<buy|sell>,
“volume”:<\d{1,8}\.d{0,8}>,
“price”:<\d{1,8}\.d{0,8}>,
“fee”:<\d{1,8}\.d{0,8}>,
“active”:<0|1>,
“created”:<\d{10}>
}

example response
{“errors”:false,”response”:{“entity”:{“order_id”:”1617″,”pair_id”:”3″,”type”:”sell”,”volume”:”48.00000000″,”price”:”9.50000000″,”fee”:”0.91200000″,”active”:”1″,”created”:”1406098537″}}}

example error response
{“errors”:{“order_id”:”incorrect `transaction id`=`ah`, must be digits”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entity”:false}}

2.9 Creation of user’s new order

The method creates a new order by the following parameters:

  • Currency pair id (pair_id)
  • Transaction type (type) – buy / sell
  • The volume of transactions (amount)
  • The price of the buy / sell

And returns the following information about created order:

  • Order id (order_id)
  • Transaction id (transaction_id)

api_method/api_action
POST order /new

api_params * – required parameter
*nonce=<\d{10}>
*pair_id=<\d+>
*type=<buy|sell>
*amount=<\d{0,8}\.\d{0,8}>
*price=<\d{0,8}\.\d{0,8}>

entity format
{
“order_id”:<\d+>,
“transaction_id”:<\d+>
}

example response
{“errors”:false,”response”:{“entity”:{“order_id”:”2011″,”transaction_id”:”6517″}}}

example error response
{“errors”:{“response”:”response error”,”balance”:”not enough funds: `balance`=`0.20000000`”,”currency_id”:”operation can not be performed for `currency id`=`2`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

2.10 Deleting of user’s order

Method removes an existing user’s order with the specified id (order_id) and returns the transaction id (transaction_id)

api_method/api_action
POST order /cancel

api_params * – required parameter
*nonce=<\d{10}>
*order_id=<\d+>

entity format
{
“transaction_id”:<\d+>
}

example response
{“errors”:false,”response”:{“entity”:{“transaction_id”:”6518″}}}

example error response
{“errors”:{“response”:”response error”,”order_id”:”operation can not be performed for `order id`=`2010`”,”user_id”:”operation can not be performed for `user id`=`29`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

2.11 List of user’s invoices (requests)

The method provides a list of invoices user for a specified period (default 30 days)

  • invoice id (id)
  • Invoice type (type=deposite|withdraw)
  • Type of payment (payment_type)
  • Currency of payment (currency_id)
  • Transaction id(transaction_id)
  • The payment amount (amount)
  • Exchange fee (fee)
  • Creation date of the transaction (created) in the unix format
  • Link to pdf-invoice (pdf)

api_method/api_action
POST invoice/list

api_params * – required parameter
*nonce=<\d{10}>
currency_id=<\d+>:all
type=<deposit|withdraw>:all
payment_type=<\w+>:all
date_from=<\d{10}>:time-30days
date_to=<\d{10}>:time()
order_by=<‘field_name’>:’invoice_id’
order_direction=<asc|desc>:DESC
items_per_page=<\d+>:1000
page=<\d+>:1

entity format
{
“id”:<\d+> AS “invoice_id”,
“type”:< deposit|withdraw >,
“payment_type”:<\w+>,
“currency_id”:<\d+>,
“transaction_id”:<null|\d+>,
“amount”:<\d{1,8}\.d{0,8}>,
“fee”:<\d{1,8}\.d{0,8}>,
“created”:<\d{10}>,
“pdf”:URL_BASE/api/v1/invoice/pdf/<fingerprint:[0-9a-f]{40}>
}

example response
{“errors”:false,”response”:{“entities”:[{“invoice_id”:”677″,”type”:”deposit”,”payment_type”:”payeer”,”currency_id”:”13″,”transaction_id”:”6067″,”amount”:”1.00000000″,”fee”:”0.00000000″,”created”:”1407197538″,”pdf”:”http:\/\/e.loc\/api\/v1\/invoice\/pdf\/81c9d3478e6b7376415c108b03ef271dc87ea1c1″},{“invoice_id”:”742″,”type”:”deposit”,”payment_type”:”nextcoin”,”currency_id”:”11″,”transaction_id”:”6492″,”amount”:”15500.00000000″,”fee”:”0.00000000″,”created”:”1408529376″,”pdf”:”http:\/\/e.loc\/api\/v1\/invoice\/pdf\/26284792b497d08209e8c53bc6be39278252a908″},{“invoice_id”:”744″,”type”:”deposit”,”payment_type”:”swift”,”currency_id”:”3″,”transaction_id”:”6493″,”amount”:”99.64534560″,”fee”:”5.00000000″,”created”:”1408618589″,”pdf”:”http:\/\/e.loc\/api\/v1\/invoice\/pdf\/09eea89445970a47e4dc601524a15c49e5cb05b8″},{“invoice_id”:”745″,”type”:”deposit”,”payment_type”:”swift”,”currency_id”:”3″,”transaction_id”:”6495″,”amount”:”0.35465440″,”fee”:”5.00000000″,”created”:”1408618645″,”pdf”:”http:\/\/e.loc\/api\/v1\/invoice\/pdf\/e038fce4c54f0aa3c67a49614e8157f1c6ba4ef9″},{“invoice_id”:”746″,”type”:”withdraw”,”payment_type”:”cryptopay”,”currency_id”:”2″,”transaction_id”:”6497″,”amount”:”0.81154800″,”fee”:”0.00100000″,”created”:”1409325115″,”pdf”:”http:\/\/e.loc\/api\/v1\/invoice\/pdf\/2a5d83ae4cc612c9051f7d2c6ebef7e18c82c92d”},{“invoice_id”
:”747″,”type”:”withdraw”,”payment_type”:”cryptopay”,”currency_id”:”2″,”transaction_id”:”6499″,”amount”:”0.25000000″,”fee”:”0.00100000″,”created”:”1409574586″,”pdf”:”http:\/\/e.loc\/api\/v1\/invoice\/pdf\/4ab0283818ac222e8083a88f0165295447e345a7″}]},”pagination”:{“total_items”:6,”items_per_page”:7,”current_page”:1,”total_pages”:1}}

example error response
{“errors”:{“order_by”:”incorrect `order by`=`id`, must be one of `invoice_id|type|payment_type|currency_id|transaction_id|price|fee|created`”,”currency_id”:”incorrect `currency id`=`1.3`, must satisfy rule `d+|NULL`”,”type”:”incorrect `type`=`depost`, must satisfy rule `NULL|deposit|withdraw`”,”payment_type”:”incorrect `payment type`=`crypto`, must satisfy rule `NULL|cryptopay|sepa|swift|sofort_banking|nextcoin|payeer|payeer_api`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entities”:false},”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

2.12 Information on user’s invoice (request)

The method provides information on the user’s specified invoice (invoice_id)

  • invoice id (id)
  • Invoice type (type=deposite|withdraw)
  • Type of payment (payment_type)
  • Currency of payment (currency_id)
  • Transaction id(transaction_id)
  • The payment amount (amount)
  • Exchange fee (fee)
  • Creation date of the transaction (created) in the unix format
  • Link to pdf-invoice (pdf)

api_method/api_action
POST invoice /info

api_params * – required parameter
*nonce=<\d{10}>
• invoice_id=<\d+>

entity format
{
“id”:<\d+> AS “invoice_id”,
“type”:< deposit|withdraw >,
“payment_type”:<\w+>,
“currency_id”:<\d+>,
“transaction_id”:<null|\d+>,
“amount”:<\d{1,8}\.d{0,8}>,
“fee”:<\d{1,8}\.d{0,8}>,
“created”:<\d{10}>,
“pdf”:URL_BASE/api/v1/invoice/pdf/<fingerprint:[0-9a-f]{40}>
}

example response
{“errors”:false,”response”:{“entity”:{“invoice_id”:”677″,”type”:”deposit”,”payment_type”:”payeer”,”currency_id”:”13″,”transaction_id”:”6067″,”amount”:”1.00000000″,”fee”:”0.00000000″,”c
reated”:”1407197538″,”pdf”:”http:\/\/e.loc\/api\/v1\/invoice\/pdf\/81c9d3478e6b7376415c108b03ef271dc87ea1c1″}}}

example error response
{“errors”:{“invoice_id”:”incorrect `invoice id`=`67.7`, must be digits”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entity”:false}}

2.13 Generation of the invoice (request) in PDF format

The method provides a pdf-invoice (invoice_id)

api_method/api_action
GET invoice /pdf
api_params * – required parameter
*nonce=<\d{10}>
* invoice_id=<\d+>

entity format
PDF file upload into the browser

example response

example error response
{“errors”:{“invoice_id”:”incorrect `invoice id`=`gh7`, must be digits”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

empty response
{“errors”:false,”response”:{“entity”:false}}</fingerprint:[0-9a-f]{40}></null|\d+></fingerprint:[0-9a-f]{40}></null|\d+></asc|desc></deposit|withdraw></buy|sell></buy|sell></buy|sell></asc|desc></balance_deposit|balance_withdraw|order_create|order_cancel|order_trade|system_commission|payment_transaction></buy|sell></buy|sell></asc|desc></buy|sell></null|[0-9a-za-z]+></null|[0-9a-za-z]+></asc|desc>

Error responses of ICE3X.COM API

Error responses of API
==========

3.1 The non-existent method/action call error

example error response
{“errors”:{“url”:”incorrect api method or request string: `/api/v1/invoices/info`”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}

3.2 Authorization error

example error response
{“errors”:{“Key”:”auth field `Key` must not be empty; authorization failed”,”Sign”:”auth field `Sign` must not be empty; authorization failed”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}
{“errors”:{“user_id”:”user by Key not found or incorrect `user id`; authorization failed”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}
{“errors”:{“Sign”:”auth field `Sign`=`87226b1q0ed64ddce8297d975b8ce646eb1e345b4f3f5cac8850a8f54e2bfba94f45556bd83e4e83c6ceff98e81d4fa1174ec837fe6fd1d69a12b7df28b85cdd` not equals; authorization failed”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}
{“errors”:{“Sign”:”auth field `Sign`=`5ae44caQ24f3cc090018456f0edcb6985bbfb65339cc7bc0c59f3df2398ce96b6426567e0b30a94ebe71079a953b699cc6f4a81f585620dc9124808dd40ffc27` incorrect; authorization failed”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}
{“errors”:{“Key”:”auth field `Key`=`1KNF69ZdYNHGG109SBKSSX5VI8TUC7CA1I6VPTXEH7JLRMB2RIWZH1VFHVGBLGU4` incorrect; authorization failed”},”response”:false,”pagination”:{“total_items”:0,”items_per_page”:0,”current_page”:0,”total_pages”:0}}