API Definitions
Platfomr is committed to empowering you with the tools necessary to provide seamless and independent support to your users. To facilitate this, we offer a suite of basic APIs by default, eliminating the need to rely on the Level2 team for routine actions.
API Documentation
The table below summarizes our REST APIs, categorized by functionality. These endpoints allow for deep integration with your internal support dashboards and automated workflows.
Available APIs
Account Management
These APIs handle user-level administrative tasks and security.
| API Name | Type | Category | Description |
|---|---|---|---|
| Reset user’s password | REST | Account | Initiates a password reset flow for a specific user. |
| Update user’s email/phone | REST | Account | Modifies contact credentials for account notifications. |
| Update account status | REST | Account | Toggle between Activate or Deactivate for user access. |
Trading & Strategy Operations
These APIs allow you to monitor, manage, and modify trading activity and strategy lifecycle.
| API Name | Type | Category | Description |
|---|---|---|---|
| List all strategies | REST | Trading | Retrieves a comprehensive list of a user’s strategies. |
| Update strategy (Delete) | REST | Trading | Allows for the administrative removal of a specific strategy. |
| List all deployments | REST | Trading | View all Active or Inactive deployments for a user. |
| List all trades | REST | Trading | Retrieves historical and current trade data from deployments. |
| Update a deployment | REST | Trading | Modify parameters or state of a live deployment. |
| Update a trade | REST | Trading | Manually adjust trade metadata (closed/taken at, strike, result). |
| Publish/Unpublish Strategy | REST | Trading | Manage strategy visibility in the Level2 Marketplace. |
| List/Delete Scanners | REST | Trading | Manage the custom scanners created by a user. |
Performance & Execution Analytics
Use these endpoints to troubleshoot execution quality and strategy efficiency.
| API Name | Type | Category | Description |
|---|---|---|---|
| Get Latency | REST | Trading | Retrieve real-time or historical execution latency data. |
| Get Slippage | REST | Trading | Retrieve price impact data for a user’s orders. |
| Get Strategy Performance | REST | Trading | Access high-level metrics (Win Rate, PnL, Drawdown). |
Implementation Notes
- Authentication: All REST APIs require a valid
Bearer Tokenpassed in the header. - Rate Limiting: Standard rate limits apply to prevent abuse. Please refer to the specific documentation for threshold details.
- Response Format: All responses are returned in standard
JSONformat.
Last updated on