Revision History Introduction What Is an API? Using the EQUOS API
Total Page:16
File Type:pdf, Size:1020Kb
2021/3/1 Revision History – API Reference Revision History Introduction What is an API? Using the EQUOS API? Support Terms of Service Authentication REST API Overview Overview REST Public Endpoints Get Instruments Get Instrument Pairs Get Order Book Get Trade History Get Funding Rate History Get Chart REST Private Endpoints Roles Logon Signing REST API Calls Place a New Order Cancel Order Cancel Replace Get Orders List Get Order Status Get Order History Get User Trade History List Position Cancel All Orders Get User History Get Risk REST Wallet Endpoints Get Deposit Addresses List Withdraw Requests Send Withdraw Request Get Transfer History WebSocket Overview Protocol Overview Heartbeat / Websocket Ping Pong Subscribe Unsubscribe WebSocket Public Channels Order Book Channel Trade History Channel Chart Channel Ticker WebSocket Private Channels User Orders Channel https://developer.equos.io/#revision-history 1/113 2021/3/1 Revision History – API Reference User Position Channel User Risk Channel FIX Overview FIX Dictionary Testnet Environment SSL Proxy Third Party Platform and Network Support Instruments and Trading Pairs Symbols Message Identifiers Data Types Standard Header Standard Trailer FIX Session Management Commencing a Session Ending a Session Logon < A > Logout < 5 > Heartbeat <0> TestRequest <1> ResendRequest <2> Reject < 3 > SequenceReset < 4 > BusinessMessageReject < j > FIX Market Data SecurityListRequest < x > SecurityList < y > MarketDataRequest < V > MarketDataRequestReject < Y > MarketDataSnapshotFullRefresh < W > MarketDataIncrementalRefresh < X > FIX Order Management NewOrderSingle< D > ExecutionReport<8> OrderCancelRequest < F > OrderCancel/ReplaceRequest< G > OrderCancelReject<9> OrderMassStatusRequest < AF > FIX Drop Copy ccxt Revision History Revision History Date Ver API End Point Type Description https://developer.equos.io/#revision-history 2/113 2021/3/1 Revision History – API Reference Date Ver API End Point Type Description REST https://equos.io/api/sendWithdrawRequest https://equos.io/api/getTransferHistory Updates for crypto New Features 2021/02/03 5.0 REST withdrawal endpoint and https://equos.io/api/getUserHistory and updates order endpoints https://equos.io/api/cancelOrder https://equos.io/api/userTrades https://equos.io/api/cancelAll REST https://equos.io/api/getRisk REST & Updated mandatory fields 2021/01/12 4.13 WSS Updates WSS for Institutional User wss://equos.io/ws/userrisk wss://equos.io/ws/userorders wss://equos.io/ws/userposition REST updated REST api/getRisk https://equos.io/api/getRisk wss/userrisk wss://equos.io/ws/userrisk api/getOrderStatus( REST & 2021/01/11 4.12 https://equos.io/api/getOrderStatus Updates removed old endpoint FIX /getOrder) FIX MarketDataRequest < V > FIX updated MDEntryType<269> https://equos.io/api/userTrades https://equos.io/api/getInstrumentPairs https://equos.io/api/getRisk wss://equos.io/ws/userrisk updates to api/userTrades REST & https://equos.io/api/getOrder and updates to 2021/01/08 4.11 Updates WSS https://equos.io/api/getInstruments getInstrumentPairs with https://equos.io/api/getInstrumentPairs example for Perpetuals https://equos.io/api/getOrderBook https://equos.io/api/getTradeHistory https://equos.io/api/getChart New API health check https://equos.io/api/health New Feature endpoint and 2020/12/24 4.10 REST https://equos.io/api/getOrderStatus and updates api/getOrderStatus endpoint wss://equos.io/ws/ticker wss://equos.io/w Public Websocket endpoints with Unsubscribe s/orderbook wss://equos.io/ws/tradehistor 2020/11/24 4.9 WSS New Feature and updates on description y wss://equos.io/ws/chart https://equos.i of the FIX and REST o/api/userTrades endpoints and examples. 2020/09/20 4.8 WSS wss://equos.io/ws/ticker New Feature Ticker Endpoint GET https://equos.io/api/getFundingRateHis Perpetual Funding Rate 2020/09/05 4.7 REST New Feature tory History https://developer.equos.io/#revision-history 3/113 2021/3/1 Revision History – API Reference Date Ver API End Point Type Description User History Reports 2020/09/05 4.7 REST POST https://equos.io/api/getUserHistory New Feature supporting Order, Trade, Funding History, Position Expanded reference data GET https://equos.io/api/getInstrumentPai 2020/08/25 4.6 REST Enhancement fields to support Perpetuals, rs Futures & Options Expanded fields for 2020/08/25 4.6 WSS wss://equos.io/ws/orderbook Enhancement perpetual contract data Wait for orderId from 2020/08/25 4.6 REST POST https://equos.io/api/order Enhancement matching engine control flag added Python Sample Codes Python Sample Codes for REST / WS and Up to date added for REST / WS APIs 2020/08/06 4.5 REST/WS Enhancement REST / WS / FIX API documents and Updated REST/WS/FIX APIs documentation GET https://equos.io/api/userTrades Average execution price 2020/07/28 4.4 REST/WS Enhancement wss://equos.io/ws//userTrades added GET https://equos.io/api/getTradeHistory AggressorSide added to 2020/07/21 4.2.7 REST/WS Enhancement wss://equos.io/ws/tradehistory tradeHistory endpoint Commission fields added to 2020/06/17 4.2 FIX ExecutionReport<8> Enhancement ExecutionReport USD/USDC Book 2020/05/15 3.10 All All New Feature consolidation System USD Instruments removed 2020/05/15 3.10 All All Change from the trading list New https://equos.io/api/ System 2020/05/15 3.10 REST Endpoint URL change Legacy https://trade.equos.io/api/ Change 2020/05/06 3.02 FIX Logon<1> New Feature Cancel on Disconnect 2020/04/28 3.00 ccxt github developer resources New Feature ccxt API support released POST https://trade.equos.io/api/logon POST https://trade.equos.io/api/order POST https://trade.equos.io/api/cancelOrd er POST https://trade.equos.io/api/cancelRepl Institutional/multiple 2020/04/06 2.20 REST aceOrder Update account support in REST POST https://trade.equos.io/api/getOrders POST https://trade.equos.io/api/getOrder POST https://trade.equos.io/api/getPositi ons POST https://trade.equos.io/api/getRisk 2020/03/27 2.00 All EQUOS developer documentation site Initial Document Release https://developer.equos.io/#revision-history 4/113 2021/3/1 Revision History – API Reference Introduction Welcome to the EQUOS Exchange developer site What is an API? API is the acronym for Application Programming Interface. An API provides a means for one application to interact with another according to a rules of engagement. The EQUOS developer documentation, describes the rules by which your application can interact with the EQUOS exchange. EQUOS supports a variety of popular Application Programming Interfaces: REST Web Sockets FIX Protocol ccxt library If you would like to discuss which API might best suits your business requirements, please feel free to reach out to our API support team. Using the EQUOS API? The EQUOS Exchange API allows access to all the features of the EQUOS Exchange platform. Developers can leverage the API to build custom trading applications, or connect existing application with the EQUOS Exchange. Through use of our comprehensive suite of APIs you can: Instrument information on the products traded on the EQUOS Exchange Retrieve historical or stream live market data Submit and manage orders Retrieve Order History Retrieve Positions Check balances Automate Deposit and Withdrawal Requests Generally every function which you might use via the GUI web application can be replicated through use of the API. Support Please refer to your account manager, or integration support for further information. Integration Support and technical onboarding please contact [email protected] API support, errors or omissions in this document [email protected] https://developer.equos.io/#revision-history 5/113 2021/3/1 Revision History – API Reference Terms of Service By accessing or using any EQUOS public or private API endpoint you have agreed to be bound by the EQUOS API Terms of Service. Usage of, or interaction with any product or service offered by EQUOS, whether by API or any other method of access is bound by the EQUOS Terms and Conditions and Business Rules of EQUOS. References in this API to “EQUOS”, “we”, “our”, or “us”, are to Diginex Capital Pte. Ltd. (company number 079903) and the Diginex Group depending on the services being discussed. API Keys All API keys are used at your own risk and expense. EQUOS will not be held responsible for any error, malfunction, negligence, compromised security, cyber attack, or other force majeure affecting this platform. Users of the API will indemnify and hold harmless, the Diginex Group EQUOS, its Affiliates, and affiliated and other group companies from all damages losses and claims associate with the usage of this API and trading system. Authentication A registered user should have API access to Equos via FIX, REST, and WebSocket. Please refer to this help article on how to obtain your credentials for API access: API Username API Password SenderCompID (specific for FIX connectivity) Once you have completed this step, you can follow the authentication steps as in the respective section for FIX, REST, and WebSocket. REST API Overview Overview The REST API has endpoints for Public market data access Account management Order management Data fields use enums defined in the FIX 4.4 standard, unless otherwise specified. REST Public Endpoints The Market Data API is a public set of endpoints for retrieving market data. These endpoints provide snapshots of market data. For real-time market data updates, see the Websocket Feed documentation for connecting and re-creating a perfect real-time copy of the order book and trades. https://developer.equos.io/#revision-history