CoinFLEX Trade Engine APIs
CoinFLEX's application programming interfaces (APIs) provide our clients programmatic access to control aspects of their accounts and to place orders on CoinFLEX's trading platforms.
CoinFLEX provides several APIs:
- our native WebSocket API
- a RESTful API
- an Event Stream resource
- a second futures Event Stream resource for your collateral, leverage and margin
Using these interfaces it is possible to make both authenticated and unauthenticated API calls, with the exception of the Futures Event Stream which is authenticated only.
Access keys are available on the CoinFLEX logged-in dashboard page for verified users which, in conjunction with your account password, allow authenticated use these APIs.
General notes
To protect the performance of the system, CoinFLEX imposes certain limits on the rates at which you may issue commands to the API. Please see LIMITS.md.
All quantities and prices are transmitted and received as integers with implicit scale factors. For scale information, please see SCALE.md.
CoinFLEX has published client libraries for several popular languages to aid you in implementing your client application.
Getting started with the WebSocket API
The WebSocket API is accessible via WebSocket connection to the following URLs:
DEMO/STAGE site
wss://stgapi.coinflex.com/v1 (encrypted)
LIVE site
wss://api.coinflex.com/v1 (encrypted)
Commands, replies, and notifications traverse the WebSocket in text frames with JSON-formatted payloads.
We strongly recommend that you use TLS transport for all connections.