For safety reasons during API activation withdrawals are blocked for 48 hours.
The quantity of accessing to API methods is limited to 180 requests per minute from one IP address or from one user.
API is available without HTTP authorization by GET or POST methods.
Method name: | trades |
HTTP query method: | POST / GET |
Incoming parameters: | pair - one or several currency pairs, separated by a comma (example BTC_USD, BTC_EUR) |
Example use: | https://api.incorex.com/v1/trades?pair=BTC_USD |
Returnable response: |
|
Field description: |
trade_id - transaction identification code type - type of transaction, where 0 – is selling, 1 – is buying quantity - amount per transaction price - price of transaction amount - amount of transaction date - date and time of the transaction in the format |
Method name: | order_book |
HTTP query method: | POST / GET |
Incoming parameters: |
pair - one or several currency pairs, separated by a comma (example BTC_USD, BTC_EUR) limit – the number of displayed positions (as a default 100, maximum 1000) |
Example use: | https://api.incorex.com/v1/order_book?pair=BTC_USD |
Returnable response: |
|
Field description: |
ask - a list of orders for disposal, where each line is the price, quantity and amount bid - a list of orders for purchase, where each line is the price, quantity and amount ask_quantity - a quantity of all orders for disposal ask_amount - an amount of all orders for disposal ask_top - minimum selling price bid_quantity - a quantity of all orders for purchase bid_amount - an amount of all orders for purchase bid_top - maximum purchase price |
Method name: | ticker |
HTTP query method: | POST / GET |
Incoming parameters: | No |
Example use: | https://api.incorex.com/v1/ticker |
Returnable response: |
|
Field description: | Array of information, where:
|
Method name: | pair_settings |
HTTP query method: | POST / GET |
Incoming parameters: | No |
Example use: | https://api.incorex.com/v1/pair_settings |
Returnable response: |
|
Field description: |
min_quantity - minimum quantity for order max_quantity - maximum quantity for order min_price - minimum price for order max_price - maximum price for order min_amount - minimum amount for order max_amount - maximum amount for order |
Method name: | currency |
HTTP query method: | POST / GET |
Incoming parameters: | No |
Example use: | https://api.incorex.com/v1/currency |
Returnable response: |
|
API requests are available only with HTTP by POST method with the use of authorization.
All API methods are available only by HTTP POST.
An authorization of all sent requests is carried out by sending HTTP headers to the server:
Key — is an API Key which is available in the user profile settings
(example: d876ff8da67c3731ae25d8335a4168b4)
Sign — is hash POST data (param=val¶m1=val1), signed by the secret key using the HMAC-SHA512 method. Secret key (API Secret) is available in the user profile settings.
(example: hash_hmac('sha512', 'param=val¶m1=val1', '1ddec0f92f297e937bdf409977df0c02'))
In all requests there must be mandatory POST-parameter nonce with an incremental numeric value (>0). This value should not be repeated or decreased.
Method name: | user_info |
HTTP query method: | POST |
Incoming parameters: | No |
Example use in PHP: |
|
Returnable response: |
|
Field description: |
uid - user identification code server_time - date and time of the server in Unix format balances - available user balance reserved - user balance in orders |
Method name: | order_create |
HTTP query method: | POST |
Incoming parameters: |
pair - currency pair quantity – order quantity price – order price position – the order position can take the following values:
|
Example use in PHP: |
|
Returnable response: |
|
Field description: |
name - name of API method status - ok in case of successful creation and error in case of error id - contains an error identification code msg - contains error text order_id - order identification code |
Method name: | order_cancel |
HTTP query method: | POST |
Incoming parameters: | order_id - order identification code |
Example use in PHP: |
|
Returnable response: |
|
Field description: |
name - name of API method status - ok in case of successful creation and error in case of error id - contains an error identifier msg - contains error text |
Method name: | user_open_orders |
HTTP query method: | POST |
Incoming parameters: | No |
Example use in PHP: |
|
Returnable response: |
|
Field description: |
date - date and time of order creation in Unix format order_id - order identification code pair - currency pair position - order position, where 0 – is selling, 1 – is buying type - order type(limit/market/stoplimit), limitprice - for stoplimit order type, quantity - order quantity price - order price amount - order amount |
Method name: | user_trades |
HTTP query method: | POST |
Incoming parameters: |
pair - one or several currency pairs, separated by a comma (example BTC_USD, BTC_EUR) offset - offset from the last transaction (as a default 0) limit - number of returned transactions (as a default 100, maximum 10,000) |
Example use in PHP: |
|
Returnable response: |
|
Field description: |
trade_id - transaction identification code date - date and time of transaction in Unix format type - type of transaction, where 0 – is selling, 1 – is buying pair - currency pair order_id - user order identification code quantity - transaction quantity price - transaction price amount - transaction amount |
Method name: | user_cancelled_orders |
HTTP query method: | POST |
Incoming parameters: |
offset - offset from the last transaction (as a default 0) limit – number of returned transactions (as a default 100, maximum 10,000) |
Example use in PHP: |
|
Returnable response: |
|
Field description: |
date - date and time of order cancelation in Unix format order_id - order identification code pair - currency pair position - order position, where 0 – is selling, 1 - is buying type - order type, where
price - order price amount - order amount |
Method name: | order_trades |
HTTP query method: | POST |
Incoming parameters: | order_id - order identification code |
Example use in PHP: |
|
Returnable response: |
|
Field description: |
position - order position, where 0 – is selling, 1 - is buying type - order type, where
in_amount - the amount of incoming currency out_currency - outgoing currency out_amount - the amount of outgoing currency percent_succesfull - order percentage completion trades - array of transactions, where:
|
Method name: | required_amount |
HTTP query method: | POST |
Incoming parameters: |
pair - currency pair quantity – quantity which is required to buy |
Example use in PHP: |
|
Returnable response: |
|
Field description: |
quantity - purchase quantity amount - an amount which you will spend for purchase avg_price - average price of a purchase |
Method name: | deposit_address |
HTTP query method: | POST | Incoming parameters: | No |
Example use in PHP: |
|
Returnable response: |
|
Method name: | withdraw_crypt |
HTTP query method: | POST | Incoming parameters: |
amount - amount of withdrawal currency currency – name of withdrawal currency address – address of withdrawal |
Example use in PHP: |
|
Returnable response: |
|
Field description: |
name - name of API method status - ok in case of successful creation and error in case of error id - contains error identification code msg - contains error text task_id - identifier of a request for withdrawal |
Method name: | withdraw_get_txid |
HTTP query method: | POST |
Incoming parameters: | task_id - identifier of a request for withdrawal |
Example use in PHP: |
|
Returnable response: |
|
Field description: |
name - name of API method status - ok in case of successful creation and error in case of error id - contains error identification code msg - contains error text status - true if the request for withdrawal has already made txid - transaction identifier by which it can be found in blockchain. If it contains an empty value, the request has not yet been processed |
Private functions are available only with an authorization. To activate these methods you have to contact technical support.
Method name: | create_xvoucher |
HTTP query method: | POST |
Incoming parameters: |
currency - name of voucher currency amount – voucher amount |
Example use in PHP: |
|
Returnable response: |
|
Field description: |
name - name of API method status - ok in case of successful creation and error in case of error id - contains error identification code msg - contains error text task_id - voucher identification code code - X-VOUCHER voucher amount - voucher amount currency - voucher currency balances - user balance after creation of a voucher |
Method name: | activate_xvoucher |
HTTP query method: | POST |
Incoming parameters: | code - X-VOUCHER voucher |
Example use in PHP: |
|
X-VOUCHER voucher: |
|
Field description: |
name - name of API method status - ok in case of successful creation and error in case of error id - contains error identification code msg - contains error text amount - voucher amount currency - voucher currency |
API requests are available only with HTTP by POST method with the use of authorization. To activate these methods you have to contact technical support.
Method name: | wallet_history |
HTTP query method: | POST |
Incoming parameters: | date - date in Unix format (timestamp) for which you need to get the transaction history (if it is not specified, the current day should be taken) |
Example use in PHP: |
|
Returnable response: |
|
Field description: |
name - name of API method status - ok in case of successful creation and error in case of error id - contains error identification code msg - contains error text begin - beginning of a period in Unix format end - end of period in Unix format history - an array of user operations (transaction history), where
|