Icrypex API Documentation
Welcome to Icrypex developer documentation.
This documentation details use of Icrypex REST API for spot exchange.
- The base endpoint is: https://api.icrypex.com
- All endpoints return either a JSON object or array if the status code is not 204 No Content.
- Some endpoints are authenticated and will require and API Key
- Once API key is created, it is recommended to set IP restrictions on the key for security reasons.
- Never share your API key/secret key to ANYONE.
API Architecture
- Authentication - HTTP Authentication with HMAC
- Status Codes - Commonly used HTTP Status Codes in Icrypex API
- Fields - Field name, type and formats
- Errors - Commonly used error codes and error messages
- Rate Limits - API Rate limiting rules
Public Trading Endpoints
- Exchange Info - Useful information about trading and funding operations
- Tickers - Exchange pair tickers data
- Order Book - Exchange pair order book data
- Last Trades - Last trades data for each pair
- K-Line Data - K-Line data for tradingview and trade history
Authenticated Trading Endpoints
- Place Order - Place (insert) a new order
- Cancel Order - Cancel an existing order
- Get Open Orders - Get open order with some criteria
- Get All Orders - Get all order history
- Get User Trades - Get all trade history
Funding Endpoints
- Spot Balance - Get spot balances for each asset
- Transfer Funds - Transfers funds between wallets
- Withdraw Funds - Withdraws funds to blockchain networks
- Withdrawals - Withdrawal history and reports
- Deposits - Deposit history and reports
- Addresses - User's active cryptocurrency addresses in Icrypex
WebSockets
- Introduction - Introduction to Icrypex websocket system
- Authentication - Authentication over websocket protocol
- Channel Subscriptions - Subscribe to websocket channels and unsubscribe
- Tickers Channel - Websocket ticker channels and receiving ticker data
- Order Book Channel - Websocket orderbook channels and receiving orderbook and difference data
- Trade Channel - Websocket Trade channels and receiving latest trades
- Tradingview Channel - Websocket tradingview channels and receiving last tradingview candle data
- User Order Trade - Receiving notifications about order status changes and new trade data over websockets
- Balance Changes - Receiving balance change notifications over websockets