GMXMarketData
Documentation for eth_defi.gmx.data.GMXMarketData Python class.
- class GMXMarketData
Bases:
objectComprehensive market data provider for the GMX protocol.
Provides unified access to all GMX protocol market data through a single, consistent interface. Uses read-only access to ensure safe data retrieval without requiring wallet credentials or transaction signing capabilities.
- Variables
gmx_config (GMXConfig) – Complete GMX configuration object for network settings
config (GMXConfigManager) – Read-only configuration manager for safe data access operations
Initialize the market data service.
Sets up the market data provider by extracting a read-only configuration from the provided GMXConfig. The read-only configuration ensures that all data access operations are safe and cannot accidentally trigger transactions.
- Parameters
gmx_config – Complete GMX configuration object containing network settings and optional wallet information. Only the read-only configuration component will be used for data access operations.
Methods summary
__init__(gmx_config)Initialize the market data service.
Get current available liquidity across all GMX markets and trading pairs.
Retrieve comprehensive information about all trading markets available on GMX.
Retrieve current annual percentage rates (APR) for borrowing across all markets.
Get information about fees that can be claimed by liquidity providers.
Get Total Value Locked (TVL) at the individual contract level.
Retrieve current funding rates (APR) for perpetual futures positions.
Get comprehensive statistics for GLV (GMX Liquidity Vector) tokens.
Get current prices and valuation data for GM (liquidity provider) tokens.
Retrieve current open interest statistics across all trading markets.
Get current oracle price data for all assets supported by GMX protocol.
Get Total Value Locked (TVL) in all GMX liquidity pools.
get_user_positions([address])Retrieve all open trading positions for a specific user address.
- __init__(gmx_config)
Initialize the market data service.
Sets up the market data provider by extracting a read-only configuration from the provided GMXConfig. The read-only configuration ensures that all data access operations are safe and cannot accidentally trigger transactions.
- Parameters
gmx_config (eth_defi.gmx.config.GMXConfig) – Complete GMX configuration object containing network settings and optional wallet information. Only the read-only configuration component will be used for data access operations.
- get_available_markets()
Retrieve comprehensive information about all trading markets available on GMX.
Returns detailed metadata about every trading pair and market supported by the GMX protocol on the configured network. The information includes market identifiers, supported assets, trading parameters, and current market status.
- Returns
Dictionary containing complete market information including market names, supported tokens, trading parameters, fees, and current status for all available GMX trading markets
- Return type
MarketData
- get_available_liquidity()
Get current available liquidity across all GMX markets and trading pairs.
Retrieves real-time liquidity information showing how much capital is available for trading in each market. Available liquidity directly impacts the maximum position sizes that can be opened and the potential slippage for large trades, making this crucial information for trading strategy and risk management.
- Returns
Nested dictionary structure where outer keys are position sides (long/short) and inner dictionaries contain liquidity amounts for different markets
- Return type
PositionSideData
- get_borrow_apr()
Retrieve current annual percentage rates (APR) for borrowing across all markets.
Borrowing rates represent the cost of leverage in perpetual futures trading. When traders open leveraged positions, they effectively borrow capital from liquidity providers and pay these rates as borrowing fees. The rates are dynamic and adjust based on utilization, market conditions, and available liquidity in each market.
- Returns
Nested dictionary where outer keys are market identifiers and inner dictionaries contain APR values for different assets and position types, expressed as decimal percentages
- Return type
PositionSideData
- get_claimable_fees()
Get information about fees that can be claimed by liquidity providers.
Liquidity providers on GMX earn fees from trading activity and can periodically claim these accumulated rewards. This method returns information about unclaimed fees available to the configured wallet address, including the amounts and types of rewards that have been earned but not yet withdrawn.
- Returns
Dictionary containing claimable fee information including amounts, asset types, and claiming mechanisms available to liquidity providers based on their LP token holdings
- Return type
MarketData
- get_contract_tvl()
Get Total Value Locked (TVL) at the individual contract level.
This method provides granular TVL information showing the value of assets locked in specific GMX protocol contracts. Contract-level TVL gives insight into how capital is distributed across different protocol components and can be useful for understanding protocol health and capital efficiency.
- Returns
Dictionary containing TVL information organized by contract addresses, showing the value and composition of assets locked in each component of the GMX protocol
- Return type
TVLData
- get_funding_apr()
Retrieve current funding rates (APR) for perpetual futures positions.
Funding rates are periodic payments between long and short position holders that help keep perpetual futures prices aligned with spot prices. When funding rates are positive, long position holders pay short position holders, and vice versa. These rates adjust dynamically based on the imbalance between long and short positions.
- Returns
Nested dictionary where outer keys are market identifiers and inner dictionaries contain funding APR values for different position types, with positive values indicating longs pay shorts
- Return type
PositionSideData
- get_gm_price()
Get current prices and valuation data for GM (liquidity provider) tokens.
GM tokens represent shares in GMX liquidity pools and their prices reflect the underlying value of the pooled assets plus accumulated fees. This pricing information is essential for liquidity providers to understand the value of their holdings and calculate returns on their liquidity provision activities.
- Returns
Dictionary containing GM token prices, underlying asset values, and other valuation metrics that determine the worth of liquidity provider positions in various GMX pools
- Return type
PriceData
- get_open_interest()
Retrieve current open interest statistics across all trading markets.
Open interest represents the total value of all outstanding positions in each market, providing insight into market activity levels and potential liquidity demands. High open interest indicates active trading and significant capital deployment, while changes in open interest can signal shifting market sentiment and trader positioning.
- Returns
Nested dictionary where outer keys are market identifiers and inner dictionaries contain open interest values for different position types (long/short) and underlying assets
- Return type
PositionSideData
- get_oracle_prices()
Get current oracle price data for all assets supported by GMX protocol.
Oracle prices are authoritative price feeds used by the GMX protocol for position valuation, liquidation calculations, and trade execution. These prices come from external price oracles and represent the protocol’s view of current market values for all supported assets, ensuring accurate and manipulation-resistant pricing.
- Returns
Dictionary containing current oracle prices and metadata for all supported assets, including timestamps, confidence intervals, and other price feed quality indicators
- Return type
PriceData
- get_pool_tvl()
Get Total Value Locked (TVL) in all GMX liquidity pools.
Pool TVL shows the total value of assets deposited by liquidity providers across all GMX trading pools. This metric is crucial for understanding protocol scale, liquidity depth, and the overall health of the GMX ecosystem. Higher TVL generally indicates greater trading capacity and reduced slippage for large trades.
- Returns
Dictionary containing detailed TVL information for each liquidity pool, including asset breakdown, pool composition, and total values across different asset types and markets
- Return type
TVLData
- get_glv_stats()
Get comprehensive statistics for GLV (GMX Liquidity Vector) tokens.
GLV tokens represent a more sophisticated liquidity provision mechanism that may include auto-compounding features, dynamic rebalancing, or other advanced strategies. These statistics provide insight into the performance and composition of GLV token holdings, helping liquidity providers understand the efficiency of these enhanced LP products.
- Returns
Dictionary containing GLV token statistics including performance metrics, composition data, yield information, and other relevant analytics for advanced liquidity provision strategies
- Return type
MarketData
- get_user_positions(address=None)
Retrieve all open trading positions for a specific user address.
This method provides detailed information about a user’s current trading positions, including position sizes, entry prices, current profit/loss, margin requirements, and liquidation thresholds. This information is essential for position management, risk assessment, and portfolio analysis.
- Parameters
address (Optional[str]) – Ethereum wallet address to query positions for. If not provided, uses the wallet address from the GMX configuration. Must be a valid Ethereum address format (0x…).
- Returns
Dictionary containing detailed information about all open positions for the specified address, including position metrics, PnL data, margin information, and risk parameters
- Return type