developers:apiv2 [Documentation]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Plus500 Futures Technologies WebSocket API (V2) ======

A single, streaming WebSocket connection for real-time market data, account/position updates and order routing. Messages are encoded with [[https://protobuf.dev/|Google Protocol Buffers]].

**Proto Files:** the ''.proto'' files define every message and field. This wiki explains the connection model and the common flows. For message field details, see the proto files and the [[developers:apiv2:reference|Message Catalog]].

===== Key Capabilities =====

^ Feature ^ Included ^ Description ^
| **Real-time Quotes** | ✅ | Stream live bid/ask price updates for any instrument. |
| **Level 1 Data** | ✅ | Access top-of-book best bid and offer (BBO). |
| **Level 2 (Market Depth)** | ✅ | View **up to 10 levels** of bid/ask depth. |
| **Market by Order (MBO)** | ✅ | See individual resting orders in the order book. |
| **Trade Feed (Ticker)** | ✅ | Get a **real-time execution stream** of all trades. |
| **Order Management** | ✅ | Submit, modify, and cancel orders programmatically. |
| **Position & Account Monitoring** | ✅ | Track open positions, P&L, and margin usage. |
| **Instrument Metadata** | ✅ | Retrieve contract specs, tick sizes, and margin requirements. |
| **Spread Trading** | ✅ | Execute spread orders with **complex multi-leg strategies**. |
| **Risk & Margin Data** | ✅ | Get real-time margin requirements and risk exposure. |
| **Historical Data Requests** | ✅ | Fetch recent trade history and market activity. |
| **Efficient Binary Encoding** | ✅ | Uses Protobuf for **low-bandwidth, high-speed** messaging. |
| **Secure Authentication** | ✅ | Ensures safe access with API key-based authentication. |
| **Robust Reconnection** | ✅ | Auto-reconnect and resume subscriptions on disconnection. |

===== Why Use This API? =====

  * **Fast & Reliable** – Designed for **high-frequency updates and real-time execution**.
  * **Compact & Efficient** – Protobuf minimizes bandwidth, ensuring **fast message processing**.
  * **Comprehensive Market Data** – Access **Level 1, Level 2, and Market by Order** data.
  * **Built for Futures Trading** – Includes **contract metadata, spread trading, and risk monitoring**.
  * **Scalable & Industry-Proven** – Handles **thousands of concurrent connections**.
  * **Secure & Encrypted** – Uses **WSS (WebSocket Secure) over SSL/TLS** to protect data.
  * **Event-Driven & Easy to Integrate** – A simple subscription model delivers the data you need.

===== Developer Guides =====

^ **Section**                                        ^ **Description**  ^
| **[[developers:apiv2:connecting|Connecting and Authenticating]]** | Instructions on establishing a connection and handling authentication. |
| **[[developers:apiv2:markets|Market Data & Definitions]]** | How to retrieve market lists, subscribe to quotes, and understand market definition messages. |
| **[[developers:apiv2:accounts|Account Feed]]** | Receiving account, position, and order updates in real time. |
| **[[developers:apiv2:orders|Order Routing]]** | Submitting orders, supported order types, and handling updates. |
| **[[developers:apiv2:pricing|Pricing and Data Types]]** | Understanding price formatting and how decimal values are represented. |
| **[[developers:apiv2:reference|Message Catalog]]** | Every message, mapped to its proto definition. |
| **[[developers:apiv2:migrating|Migrating from V1]]** | What changed from V1 and how to upgrade. |
| **[[developers:apiv2:certification|Certification and Testing]]** | Development checklist and pre/post-certification requirements. |
| **[[developers:apiv2:faq|FAQ]]** | Answers to common questions about the API. |