Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.plurex.io/llms.txt

Use this file to discover all available pages before exploring further.

The Plurex Platform API is designed to expose the full range of functionality available through the Plurex web application.

​
CQS Architecture

The API follows a Command & Query Separation (CQS) pattern:
  • Queries: Read-only operations used to fetch state. (e.g., listing venues, getting balances)
  • Commands: State-changing operations used to perform actions. (e.g., submitting orders, creating accounts)
All operations use HTTP POST with JSON payloads, regardless of whether they are commands or queries.

​
Key Modules

The Platform API is structured around several key functional areas:

Venues

Explore available liquidity venues and their markets.

Hosts

Manage execution hosts (brokers), query wallets, positions, and orders.

Accounts

Programmatically manage your linked exchange accounts.

Paper Trading

Create and manage paper trading accounts for testing.

​
Authentication

All requests require authentication using your API Key and API Secret, which can be managed in your Plurex account settings.