Coinfloor's application programming interfaces (APIs) provide our clients programmatic access to control aspects of their accounts and to place orders on Coinfloor's trading platforms.
Coinfloor provides several APIs:
- our native WebSocket API
- a RESTful API
- an Event Stream resource
- a Bitstamp Emulation API (not recommended for new projects)
Using these interfaces, it is possible to make both authenticated and unauthenticated API calls.
Access keys are available on the Coinfloor logged-in dashboard page for verified users which, in conjunction with your account password, allow authenticated use these APIs.
To protect the performance of the system, Coinfloor 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.
Coinfloor has published client libraries for several popular languages to aid you in implementing your client application.
The WebSocket API is accessible via WebSocket connection to the following URLs:
ws://api.coinfloor.co.uk/ (unencrypted)
wss://api.coinfloor.co.uk/ (encrypted)
ws://api.coinfloorex.com/ (unencrypted)
wss://api.coinfloorex.com/ (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.
WebSocket connections to the API will time out after 60 seconds of no traffic passing in either direction. To prevent timeouts, send a Ping frame approximately every 45 seconds while the connection is otherwise idle. You do not need to send Ping frames if you are otherwise sending or receiving data frames on the socket.