API Integration for Perpetual Futures

REST API Overview

The REST API provides synchronous, request-response access to all core exchange functions. It follows standard REST conventions with JSON payloads and HTTP methods, making it straightforward to integrate with any programming language or framework.

Key REST API endpoints include:

• Market Data: Retrieve current prices, 24-hour statistics, available markets, and historical candle (OHLCV) data. These endpoints are typically public and do not require authentication.
• Order Management: Place, modify, and cancel orders. Supports all order types including market, limit, stop-loss, take-profit, and TWAP. Requires API key authentication.
• Position Management: Query open positions, modify margin allocations, and close positions. Provides real-time PnL, margin utilization, and liquidation price data.
• Account Information: Retrieve account balances, trading history, fee tier information, and sub-account details.
• Funding and Transfers: Manage deposits, withdrawals, and internal transfers between sub-accounts.

The REST API is ideal for operations that do not require real-time updates, such as placing orders based on periodic signals, querying account status, or integrating with portfolio management systems.

WebSocket API for Real-Time Data

The WebSocket API provides persistent, bidirectional streaming connections for real-time market data and account updates. Unlike REST, where the client must poll for updates, WebSocket pushes data to the client as soon as it is available, enabling sub-second response times.

Available WebSocket streams include:

• Order Book Stream: Real-time order book updates with snapshot and incremental delta delivery. Supports configurable depth levels (e.g., top 5, top 20, full book).
• Trade Stream: Live trade executions as they occur, including price, size, direction, and timestamp.
• Candle/OHLCV Stream: Real-time candle updates for charting and technical analysis, available in multiple timeframes.
• Ticker Stream: Continuous updates to market statistics including last price, 24-hour volume, high, low, and funding rate.
• User Data Stream: Private stream of account-level events including order fills, position updates, balance changes, and liquidation warnings. Requires authentication.

WebSocket connections are essential for algorithmic trading systems, market making bots, and any application that requires immediate reaction to market events.

Authentication and Security

API access is secured through a robust authentication system designed to protect user accounts while enabling seamless programmatic access:

• API Key Pairs: Users generate API key pairs (key and secret) through the exchange interface. Each pair can be assigned specific permissions (read, trade, withdraw) and optionally restricted to specific IP addresses.
• Request Signing: All authenticated requests are signed using HMAC-SHA256, ensuring that requests cannot be tampered with in transit. The signing process includes timestamps to prevent replay attacks.
• Sub-Account Scoping: API keys can be scoped to specific sub-accounts, limiting their access to only the designated account. This provides security isolation when running multiple trading bots.
• Rate Limiting: API endpoints are rate-limited to prevent abuse and ensure fair access for all users. Rate limits are generous enough for normal trading activity and can be increased for verified institutional users.

The authentication scheme is modeled after industry-standard exchange APIs, so developers familiar with platforms like Binance, Bybit, or dYdX will find the integration process straightforward.

Use Cases for API Integration

The API enables a wide range of use cases that significantly expand the utility and trading volume of the exchange:

• Algorithmic Trading: Quantitative traders and trading firms deploy automated strategies that place, modify, and cancel orders based on market signals without manual intervention.
• Market Making: Professional market makers use the API to continuously quote bid and ask prices across multiple markets, providing liquidity and earning the bid-ask spread.
• Arbitrage: Arbitrage bots monitor prices across multiple venues and use the API to execute trades that capture pricing discrepancies.
• Portfolio Management: Fund managers integrate the API with portfolio management systems to track positions, calculate NAV, and execute rebalancing trades.
• Risk Management: External risk monitoring systems connect to the API to track exposure across all accounts and trigger position reductions when risk limits are breached.
• Custom Interfaces: Teams can build custom front-end applications or mobile apps that connect to the exchange through the API, creating tailored user experiences for specific audiences.

API Documentation and Developer Experience

A well-documented API is essential for developer adoption. The perps.studio API comes with comprehensive documentation that includes:

• Endpoint Reference: Detailed documentation for every REST endpoint and WebSocket stream, including request parameters, response schemas, error codes, and rate limits.
• Code Examples: Working code snippets in popular programming languages (Python, JavaScript, Go, Rust) for common operations like placing orders, subscribing to market data, and managing positions.
• SDKs and Libraries: Pre-built client libraries that abstract the low-level HTTP and WebSocket communication, allowing developers to interact with the API using idiomatic code in their language of choice.
• Sandbox Environment: A testnet environment where developers can test their integrations without risking real funds. The sandbox mirrors the production API behavior with simulated market data.

Good documentation reduces the time to integration and lowers the barrier for trading firms to connect their systems to the exchange. This directly impacts the exchange's ability to attract API-driven volume.

API Access for Exchange Operators

For whitelabel operators, the API is provided as part of the perps.studio infrastructure. Operators do not need to build, host, or maintain the API themselves. The API endpoints are served from the same infrastructure that powers the trading terminal, ensuring consistency between the web interface and programmatic access.

Operators benefit from the API in several ways:

• Volume from API Traders: Algorithmic traders and market makers who trade through the API often generate significantly higher volume than manual web traders. Attracting API users can dramatically increase the exchange's fee revenue.
• Ecosystem Development: The API allows third-party developers to build tools, bots, and integrations that enhance the exchange ecosystem, creating additional value for all users.
• Custom Integrations: Operators can use the API to build custom dashboards, alerting systems, or marketing tools that connect directly to their exchange data.

The API infrastructure scales automatically with trading volume, so operators do not need to worry about capacity planning or performance degradation during high-activity periods.