API Reference
This section provides detailed documentation for all classes, functions, and types in the Hyperliquid SDK.
Core Classes
| Class |
Description |
| Api |
Main entry point for the SDK. Provides access to all other components and handles initialization. |
| Account |
Authentication credentials and account management for API operations. |
Endpoint Classes
| Class |
Description |
| Info |
Methods for retrieving market data, account information, and other read-only operations. |
| Exchange |
Methods for placing orders, managing positions, and other trading operations. |
| Subscriptions |
WebSocket subscription methods for real-time market data and account updates. |
| Ws |
WebSocket client for managing connections and accessing real-time interfaces. |
Utility Classes
| Class |
Description |
| Universe |
Asset information, metadata, and utility functions for price/size formatting. |
| Transport |
Low-level transport classes for HTTP and WebSocket communication. |
| Cloid |
Client order ID generation and management utilities. |
Reference Materials
| Reference |
Description |
| Constants |
Predefined constants for order types, sides, groupings, and other common values. |
| Types |
Type definitions for all API requests, responses, and data structures. |
| Errors |
Exception classes and error handling utilities. |