/** * * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; export interface Account { 'code': number; 'message'?: string; 'account_type': number; 'index': number; 'l1_address': string; 'cancel_all_time': number; 'total_order_count': number; 'pending_order_count': number; 'available_balance': string; 'status': number; 'collateral': string; } export interface AccountApiKeys { 'code': number; 'message'?: string; 'api_keys': Array; } export interface AccountAsset { 'symbol': string; 'asset_id': number; 'balance': string; 'locked_balance': string; } export interface AccountLimits { 'code': number; 'message'?: string; 'max_llp_percentage': number; 'max_llp_amount': string; 'user_tier': string; 'can_create_public_pool': boolean; } export interface AccountMarginStats { 'collateral': string; 'portfolio_value': string; 'leverage': string; 'available_balance': string; 'margin_usage': string; 'buying_power': string; } export interface AccountMarketStats { 'market_id': number; 'daily_trades_count': number; 'daily_base_token_volume': number; 'daily_quote_token_volume': number; 'weekly_trades_count': number; 'weekly_base_token_volume': number; 'weekly_quote_token_volume': number; 'monthly_trades_count': number; 'monthly_base_token_volume': number; 'monthly_quote_token_volume': number; 'total_trades_count': number; 'total_base_token_volume': number; 'total_quote_token_volume': number; } export interface AccountMetadata { 'account_index': number; 'name': string; 'description': string; /** * Remove After FE uses L1 meta endpoint */ 'can_invite': boolean; /** * Remove After FE uses L1 meta endpoint */ 'referral_points_percentage': string; } export interface AccountMetadatas { 'code': number; 'message'?: string; 'account_metadatas': Array; } export interface AccountPnL { 'code': number; 'message'?: string; 'resolution': string; 'pnl': Array; } export interface AccountPosition { 'market_id': number; 'symbol': string; 'initial_margin_fraction': string; 'open_order_count': number; 'pending_order_count': number; 'position_tied_order_count': number; 'sign': number; 'position': string; 'avg_entry_price': string; 'position_value': string; 'unrealized_pnl': string; 'realized_pnl': string; 'liquidation_price': string; 'total_funding_paid_out'?: string; 'margin_mode': number; 'allocated_margin': string; } export interface AccountStats { 'collateral': string; 'portfolio_value': string; 'leverage': string; 'available_balance': string; 'margin_usage': string; 'buying_power': string; 'cross_stats': AccountMarginStats; 'total_stats': AccountMarginStats; } export interface AccountTradeStats { 'daily_trades_count': number; 'daily_volume': number; 'weekly_trades_count': number; 'weekly_volume': number; 'monthly_trades_count': number; 'monthly_volume': number; 'total_trades_count': number; 'total_volume': number; } export interface Announcement { 'title': string; 'content': string; 'created_at': number; 'expired_at': number; } export interface Announcements { 'code': number; 'message'?: string; 'announcements': Array; } export interface ApiKey { 'account_index': number; 'api_key_index': number; 'nonce': number; 'public_key': string; } export interface Asset { 'asset_id': number; 'symbol': string; 'l1_decimals': number; 'decimals': number; 'min_transfer_amount': string; 'min_withdrawal_amount': string; 'margin_mode': AssetMarginModeEnum; 'index_price': string; 'l1_address': string; } export declare const AssetMarginModeEnum: { readonly Enabled: "enabled"; readonly Disabled: "disabled"; }; export type AssetMarginModeEnum = typeof AssetMarginModeEnum[keyof typeof AssetMarginModeEnum]; export interface AssetDetails { 'code': number; 'message'?: string; 'asset_details': Array; } export interface Block { 'commitment': string; 'height': number; 'state_root': string; 'priority_operations': number; 'on_chain_l2_operations': number; 'pending_on_chain_operations_pub_data': string; 'committed_tx_hash': string; 'committed_at': number; 'verified_tx_hash': string; 'verified_at': number; 'txs': Array; 'status': number; 'size': number; } export interface Blocks { 'code': number; 'message'?: string; 'total': number; 'blocks': Array; } export interface Bridge { 'id': number; 'version': BridgeVersionEnum; 'source': string; 'source_chain_id': string; 'fast_bridge_tx_hash': string; 'batch_claim_tx_hash': string; 'cctp_burn_tx_hash': string; 'amount': string; 'intent_address': string; 'status': BridgeStatusEnum; 'step': string; 'description': string; 'created_at': number; 'updated_at': number; 'is_external_deposit': boolean; } export declare const BridgeVersionEnum: { readonly NUMBER_1: 1; readonly NUMBER_2: 2; }; export type BridgeVersionEnum = typeof BridgeVersionEnum[keyof typeof BridgeVersionEnum]; export declare const BridgeStatusEnum: { readonly Pending: "pending"; readonly Bridging: "bridging"; readonly Completed: "completed"; }; export type BridgeStatusEnum = typeof BridgeStatusEnum[keyof typeof BridgeStatusEnum]; export interface BridgeSupportedNetwork { 'name': string; 'chain_id': string; 'explorer': string; } export interface Candlestick { 'timestamp': number; 'open': number; 'high': number; 'low': number; 'close': number; 'open_raw': number; 'high_raw': number; 'low_raw': number; 'close_raw': number; 'volume0': number; 'volume1': number; 'last_trade_id': number; } export interface Candlesticks { 'code': number; 'message'?: string; 'resolution': string; 'candlesticks': Array; } export interface ContractAddress { 'name': string; 'address': string; } export interface CurrentHeight { 'code': number; 'message'?: string; 'height': number; } export interface Cursor { 'next_cursor'?: string; } export interface DailyReturn { 'timestamp': number; 'daily_return': number; } export interface DepositHistory { 'code': number; 'message'?: string; 'deposits': Array; 'cursor': string; } export interface DepositHistoryItem { 'id': string; 'asset_id': number; 'amount': string; 'timestamp': number; 'status': DepositHistoryItemStatusEnum; 'l1_tx_hash': string; } export declare const DepositHistoryItemStatusEnum: { readonly Failed: "failed"; readonly Pending: "pending"; readonly Completed: "completed"; readonly Claimable: "claimable"; }; export type DepositHistoryItemStatusEnum = typeof DepositHistoryItemStatusEnum[keyof typeof DepositHistoryItemStatusEnum]; export interface DetailedAccount { 'code': number; 'message'?: string; 'account_type': number; 'index': number; 'l1_address': string; 'cancel_all_time': number; 'total_order_count': number; 'pending_order_count': number; 'available_balance': string; 'status': number; 'collateral': string; 'account_index': number; 'name': string; 'description': string; /** * Remove After FE uses L1 meta endpoint */ 'can_invite': boolean; /** * Remove After FE uses L1 meta endpoint */ 'referral_points_percentage': string; 'positions': Array; 'assets': Array; 'total_asset_value': string; 'cross_asset_value': string; 'pool_info': PublicPoolInfo; 'shares': Array; } export interface DetailedAccounts { 'code': number; 'message'?: string; 'total': number; 'accounts': Array; } export interface DetailedCandlestick { 'timestamp': number; 'open': number; 'high': number; 'low': number; 'close': number; 'open_raw': number; 'high_raw': number; 'low_raw': number; 'close_raw': number; 'volume0': number; 'volume1': number; 'last_trade_id': number; 'trade_count': number; } export interface EnrichedTx { 'code': number; 'message'?: string; 'hash': string; 'type': number; 'info': string; 'event_info': string; 'status': number; 'transaction_index': number; 'l1_address': string; 'account_index': number; 'nonce': number; 'expire_at': number; 'block_height': number; 'queued_at': number; 'executed_at': number; 'sequence_index': number; 'parent_hash': string; 'api_key_index': number; 'committed_at': number; 'verified_at': number; } export interface ExchangeStats { 'code': number; 'message'?: string; 'total': number; 'order_book_stats': Array; 'daily_usd_volume': number; 'daily_trades_count': number; } export interface ExportData { 'code': number; 'message'?: string; 'data_url': string; } export interface Funding { 'timestamp': number; 'value': string; 'rate': string; 'direction': string; } export interface FundingRate { 'market_id': number; 'exchange': FundingRateExchangeEnum; 'symbol': string; 'rate': number; } export declare const FundingRateExchangeEnum: { readonly Binance: "binance"; readonly Bybit: "bybit"; readonly Hyperliquid: "hyperliquid"; readonly Lighter: "lighter"; }; export type FundingRateExchangeEnum = typeof FundingRateExchangeEnum[keyof typeof FundingRateExchangeEnum]; export interface FundingRates { 'code': number; 'message'?: string; 'funding_rates': Array; } export interface Fundings { 'code': number; 'message'?: string; 'resolution': string; 'fundings': Array; } export interface L1Metadata { 'l1_address': string; 'can_invite': boolean; 'referral_points_percentage': string; } export interface L1ProviderInfo { 'chainId': number; 'networkId': number; 'latestBlockNumber': number; } export interface LiqTrade { 'price': string; 'size': string; 'taker_fee': string; 'maker_fee': string; } export interface Liquidation { 'id': number; 'market_id': number; 'type': LiquidationTypeEnum; 'trade': LiqTrade; 'info': LiquidationInfo; 'executed_at': number; } export declare const LiquidationTypeEnum: { readonly Partial: "partial"; readonly Deleverage: "deleverage"; }; export type LiquidationTypeEnum = typeof LiquidationTypeEnum[keyof typeof LiquidationTypeEnum]; export interface LiquidationInfo { 'positions': Array; 'risk_info_before': RiskInfo; 'risk_info_after': RiskInfo; 'mark_prices': { [key: string]: number; }; } export interface LiquidationInfos { 'code': number; 'message'?: string; 'liquidations': Array; 'next_cursor'?: string; } export interface MarketConfig { 'market_margin_mode': number; 'insurance_fund_account_index': number; 'liquidation_mode': number; 'force_reduce_only': boolean; 'trading_hours': string; } export interface NextNonce { 'code': number; 'message'?: string; 'nonce': number; } export interface Order { 'order_index': number; 'client_order_index': number; 'order_id': string; 'client_order_id': string; 'market_index': number; 'owner_account_index': number; 'initial_base_amount': string; 'price': string; 'nonce': number; 'remaining_base_amount': string; 'is_ask': boolean; 'base_size': number; 'base_price': number; 'filled_base_amount': string; 'filled_quote_amount': string; /** * TODO: remove this */ 'side': string; 'type': OrderTypeEnum; 'time_in_force': OrderTimeInForceEnum; 'reduce_only': boolean; 'trigger_price': string; 'order_expiry': number; 'status': OrderStatusEnum; 'trigger_status': OrderTriggerStatusEnum; 'trigger_time': number; 'parent_order_index': number; 'parent_order_id': string; 'to_trigger_order_id_0': string; 'to_trigger_order_id_1': string; 'to_cancel_order_id_0': string; 'block_height': number; 'timestamp': number; 'created_at': number; 'updated_at': number; } export declare const OrderTypeEnum: { readonly Limit: "limit"; readonly Market: "market"; readonly StopLoss: "stop-loss"; readonly StopLossLimit: "stop-loss-limit"; readonly TakeProfit: "take-profit"; readonly TakeProfitLimit: "take-profit-limit"; readonly Twap: "twap"; readonly TwapSub: "twap-sub"; readonly Liquidation: "liquidation"; }; export type OrderTypeEnum = typeof OrderTypeEnum[keyof typeof OrderTypeEnum]; export declare const OrderTimeInForceEnum: { readonly GoodTillTime: "good-till-time"; readonly ImmediateOrCancel: "immediate-or-cancel"; readonly PostOnly: "post-only"; readonly Unknown: "Unknown"; }; export type OrderTimeInForceEnum = typeof OrderTimeInForceEnum[keyof typeof OrderTimeInForceEnum]; export declare const OrderStatusEnum: { readonly InProgress: "in-progress"; readonly Pending: "pending"; readonly Open: "open"; readonly Filled: "filled"; readonly Canceled: "canceled"; readonly CanceledPostOnly: "canceled-post-only"; readonly CanceledReduceOnly: "canceled-reduce-only"; readonly CanceledPositionNotAllowed: "canceled-position-not-allowed"; readonly CanceledMarginNotAllowed: "canceled-margin-not-allowed"; readonly CanceledTooMuchSlippage: "canceled-too-much-slippage"; readonly CanceledNotEnoughLiquidity: "canceled-not-enough-liquidity"; readonly CanceledSelfTrade: "canceled-self-trade"; readonly CanceledExpired: "canceled-expired"; readonly CanceledOco: "canceled-oco"; readonly CanceledChild: "canceled-child"; readonly CanceledLiquidation: "canceled-liquidation"; readonly CanceledInvalidBalance: "canceled-invalid-balance"; }; export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum]; export declare const OrderTriggerStatusEnum: { readonly Na: "na"; readonly Ready: "ready"; readonly MarkPrice: "mark-price"; readonly Twap: "twap"; readonly ParentOrder: "parent-order"; }; export type OrderTriggerStatusEnum = typeof OrderTriggerStatusEnum[keyof typeof OrderTriggerStatusEnum]; export interface OrderBook { 'symbol': string; 'market_id': number; 'market_type': OrderBookMarketTypeEnum; 'base_asset_id': number; 'quote_asset_id': number; 'status': OrderBookStatusEnum; 'taker_fee': string; 'maker_fee': string; 'liquidation_fee': string; 'min_base_amount': string; 'min_quote_amount': string; 'order_quote_limit': string; 'supported_size_decimals': number; 'supported_price_decimals': number; 'supported_quote_decimals': number; } export declare const OrderBookMarketTypeEnum: { readonly Perp: "perp"; readonly Spot: "spot"; }; export type OrderBookMarketTypeEnum = typeof OrderBookMarketTypeEnum[keyof typeof OrderBookMarketTypeEnum]; export declare const OrderBookStatusEnum: { readonly Inactive: "inactive"; readonly Active: "active"; }; export type OrderBookStatusEnum = typeof OrderBookStatusEnum[keyof typeof OrderBookStatusEnum]; export interface OrderBookDepth { 'code': number; 'message'?: string; 'asks': Array; 'bids': Array; 'offset': number; 'nonce': number; } export interface OrderBookDetails { 'code': number; 'message'?: string; 'order_book_details': Array; 'spot_order_book_details': Array; } export interface OrderBookOrders { 'code': number; 'message'?: string; 'total_asks': number; 'asks': Array; 'total_bids': number; 'bids': Array; } export interface OrderBookStats { 'symbol': string; 'last_trade_price': number; 'daily_trades_count': number; 'daily_base_token_volume': number; 'daily_quote_token_volume': number; 'daily_price_change': number; } export interface OrderBooks { 'code': number; 'message'?: string; 'order_books': Array; } export interface Orders { 'code': number; 'message'?: string; 'next_cursor'?: string; 'orders': Array; } export interface PerpsMarketStats { 'symbol': string; 'market_id': number; 'index_price': string; 'mark_price': string; 'open_interest': string; 'open_interest_limit': string; 'funding_clamp_small': string; 'funding_clamp_big': string; 'last_trade_price': string; 'current_funding_rate': string; 'funding_rate': string; 'funding_timestamp': number; 'daily_base_token_volume': number; 'daily_quote_token_volume': number; 'daily_price_low': number; 'daily_price_high': number; 'daily_price_change': number; } export interface PerpsOrderBookDetail { 'symbol': string; 'market_id': number; 'market_type': PerpsOrderBookDetailMarketTypeEnum; 'base_asset_id': number; 'quote_asset_id': number; 'status': PerpsOrderBookDetailStatusEnum; 'taker_fee': string; 'maker_fee': string; 'liquidation_fee': string; 'min_base_amount': string; 'min_quote_amount': string; 'order_quote_limit': string; 'supported_size_decimals': number; 'supported_price_decimals': number; 'supported_quote_decimals': number; 'size_decimals': number; 'price_decimals': number; 'quote_multiplier': number; 'default_initial_margin_fraction': number; 'min_initial_margin_fraction': number; 'maintenance_margin_fraction': number; 'closeout_margin_fraction': number; 'last_trade_price': number; 'daily_trades_count': number; 'daily_base_token_volume': number; 'daily_quote_token_volume': number; 'daily_price_low': number; 'daily_price_high': number; 'daily_price_change': number; 'open_interest': number; 'daily_chart': { [key: string]: number; }; 'market_config': MarketConfig; } export declare const PerpsOrderBookDetailMarketTypeEnum: { readonly Perp: "perp"; readonly Spot: "spot"; }; export type PerpsOrderBookDetailMarketTypeEnum = typeof PerpsOrderBookDetailMarketTypeEnum[keyof typeof PerpsOrderBookDetailMarketTypeEnum]; export declare const PerpsOrderBookDetailStatusEnum: { readonly Inactive: "inactive"; readonly Active: "active"; }; export type PerpsOrderBookDetailStatusEnum = typeof PerpsOrderBookDetailStatusEnum[keyof typeof PerpsOrderBookDetailStatusEnum]; export interface PnLEntry { 'timestamp': number; 'trade_pnl': number; 'trade_spot_pnl': number; 'inflow': number; 'outflow': number; 'spot_outflow': number; 'spot_inflow': number; 'pool_pnl': number; 'pool_inflow': number; 'pool_outflow': number; 'pool_total_shares': number; } export interface PositionFunding { 'timestamp': number; 'market_id': number; 'funding_id': number; 'change': string; 'rate': string; 'position_size': string; 'position_side': PositionFundingPositionSideEnum; } export declare const PositionFundingPositionSideEnum: { readonly Long: "long"; readonly Short: "short"; }; export type PositionFundingPositionSideEnum = typeof PositionFundingPositionSideEnum[keyof typeof PositionFundingPositionSideEnum]; export interface PositionFundings { 'code': number; 'message'?: string; 'position_fundings': Array; 'next_cursor'?: string; } export interface PriceLevel { 'price': string; 'size': string; } export interface PublicPoolInfo { 'status': number; 'operator_fee': string; 'min_operator_share_rate': string; 'total_shares': number; 'operator_shares': number; 'annual_percentage_yield': number; 'sharpe_ratio': number; 'daily_returns': Array; 'share_prices': Array; } export interface PublicPoolMetadata { 'code': number; 'message'?: string; 'account_index': number; 'created_at': number; 'master_account_index': number; 'account_type': number; 'name': string; 'l1_address': string; 'annual_percentage_yield': number; 'sharpe_ratio': number; 'status': number; 'operator_fee': string; 'total_asset_value': string; 'total_shares': number; 'account_share'?: PublicPoolShare; } export interface PublicPoolShare { 'public_pool_index': number; 'shares_amount': number; 'entry_usdc': string; } export interface ReferralPointEntry { 'l1_address': string; 'total_points': number; 'week_points': number; 'total_reward_points': number; 'week_reward_points': number; 'reward_point_multiplier': string; } export interface ReferralPoints { 'referrals': Array; 'user_total_points': number; 'user_last_week_points': number; 'user_total_referral_reward_points': number; 'user_last_week_referral_reward_points': number; 'reward_point_multiplier': string; } export interface ReqExportData { 'auth'?: string; 'account_index'?: number; 'market_id'?: number; 'type': ReqExportDataTypeEnum; } export declare const ReqExportDataTypeEnum: { readonly Funding: "funding"; readonly Trade: "trade"; }; export type ReqExportDataTypeEnum = typeof ReqExportDataTypeEnum[keyof typeof ReqExportDataTypeEnum]; export interface ReqGetAccount { 'by': ReqGetAccountByEnum; 'value': string; } export declare const ReqGetAccountByEnum: { readonly Index: "index"; readonly L1Address: "l1_address"; }; export type ReqGetAccountByEnum = typeof ReqGetAccountByEnum[keyof typeof ReqGetAccountByEnum]; export interface ReqGetAccountActiveOrders { 'account_index': number; 'market_id': number; /** * made optional to support header auth clients */ 'auth'?: string; } export interface ReqGetAccountApiKeys { 'account_index': number; 'api_key_index'?: number; } export interface ReqGetAccountByL1Address { 'l1_address': string; } export interface ReqGetAccountInactiveOrders { /** * made optional to support header auth clients */ 'auth'?: string; 'account_index': number; 'market_id'?: number; 'ask_filter'?: number; 'between_timestamps'?: string; 'cursor'?: string; 'limit': number; } export interface ReqGetAccountLimits { 'account_index': number; /** * made optional to support header auth clients */ 'auth'?: string; } export interface ReqGetAccountMetadata { 'by': ReqGetAccountMetadataByEnum; 'value': string; 'auth'?: string; } export declare const ReqGetAccountMetadataByEnum: { readonly Index: "index"; readonly L1Address: "l1_address"; }; export type ReqGetAccountMetadataByEnum = typeof ReqGetAccountMetadataByEnum[keyof typeof ReqGetAccountMetadataByEnum]; export interface ReqGetAccountPnL { 'auth'?: string; 'by': ReqGetAccountPnLByEnum; 'value': string; 'resolution': ReqGetAccountPnLResolutionEnum; 'start_timestamp': number; 'end_timestamp': number; 'count_back': number; 'ignore_transfers'?: boolean; } export declare const ReqGetAccountPnLByEnum: { readonly Index: "index"; }; export type ReqGetAccountPnLByEnum = typeof ReqGetAccountPnLByEnum[keyof typeof ReqGetAccountPnLByEnum]; export declare const ReqGetAccountPnLResolutionEnum: { readonly _1m: "1m"; readonly _5m: "5m"; readonly _15m: "15m"; readonly _1h: "1h"; readonly _4h: "4h"; readonly _1d: "1d"; }; export type ReqGetAccountPnLResolutionEnum = typeof ReqGetAccountPnLResolutionEnum[keyof typeof ReqGetAccountPnLResolutionEnum]; export interface ReqGetAccountTxs { 'index'?: number; 'limit'?: number; 'by'?: ReqGetAccountTxsByEnum; 'value'?: string; 'types'?: Array; 'auth'?: string; } export declare const ReqGetAccountTxsByEnum: { readonly AccountIndex: "account_index"; }; export type ReqGetAccountTxsByEnum = typeof ReqGetAccountTxsByEnum[keyof typeof ReqGetAccountTxsByEnum]; export interface ReqGetAssetDetails { 'asset_id'?: number; } export interface ReqGetBlock { 'by': ReqGetBlockByEnum; 'value': string; } export declare const ReqGetBlockByEnum: { readonly Commitment: "commitment"; readonly Height: "height"; }; export type ReqGetBlockByEnum = typeof ReqGetBlockByEnum[keyof typeof ReqGetBlockByEnum]; export interface ReqGetBlockTxs { 'by': ReqGetBlockTxsByEnum; 'value': string; } export declare const ReqGetBlockTxsByEnum: { readonly BlockHeight: "block_height"; readonly BlockCommitment: "block_commitment"; }; export type ReqGetBlockTxsByEnum = typeof ReqGetBlockTxsByEnum[keyof typeof ReqGetBlockTxsByEnum]; export interface ReqGetBridgesByL1Addr { 'l1_address': string; } export interface ReqGetByAccount { 'by': ReqGetByAccountByEnum; 'value': string; } export declare const ReqGetByAccountByEnum: { readonly AccountIndex: "account_index"; }; export type ReqGetByAccountByEnum = typeof ReqGetByAccountByEnum[keyof typeof ReqGetByAccountByEnum]; export interface ReqGetCandlesticks { 'market_id': number; 'resolution': ReqGetCandlesticksResolutionEnum; 'start_timestamp': number; 'end_timestamp': number; 'count_back': number; 'set_timestamp_to_end'?: boolean; } export declare const ReqGetCandlesticksResolutionEnum: { readonly _1m: "1m"; readonly _5m: "5m"; readonly _15m: "15m"; readonly _30m: "30m"; readonly _1h: "1h"; readonly _4h: "4h"; readonly _12h: "12h"; readonly _1d: "1d"; readonly _1w: "1w"; }; export type ReqGetCandlesticksResolutionEnum = typeof ReqGetCandlesticksResolutionEnum[keyof typeof ReqGetCandlesticksResolutionEnum]; export interface ReqGetDepositHistory { 'account_index': number; /** * made optional to support header auth clients */ 'auth'?: string; 'l1_address': string; 'cursor'?: string; 'filter'?: ReqGetDepositHistoryFilterEnum; } export declare const ReqGetDepositHistoryFilterEnum: { readonly All: "all"; readonly Pending: "pending"; readonly Claimable: "claimable"; }; export type ReqGetDepositHistoryFilterEnum = typeof ReqGetDepositHistoryFilterEnum[keyof typeof ReqGetDepositHistoryFilterEnum]; export interface ReqGetFastWithdrawInfo { 'account_index': number; /** * made optional to support header auth clients */ 'auth'?: string; } export interface ReqGetFundings { 'market_id': number; 'resolution': ReqGetFundingsResolutionEnum; 'start_timestamp': number; 'end_timestamp': number; 'count_back': number; } export declare const ReqGetFundingsResolutionEnum: { readonly _1h: "1h"; readonly _1d: "1d"; }; export type ReqGetFundingsResolutionEnum = typeof ReqGetFundingsResolutionEnum[keyof typeof ReqGetFundingsResolutionEnum]; export interface ReqGetL1Metadata { /** * made optional to support header auth clients */ 'auth'?: string; 'l1_address': string; } export interface ReqGetL1Tx { 'hash': string; } export interface ReqGetLatestDeposit { 'l1_address': string; } export interface ReqGetLiquidationInfos { /** * made optional to support header auth clients */ 'auth'?: string; 'account_index': number; 'market_id'?: number; 'cursor'?: string; 'limit': number; } export interface ReqGetNextNonce { 'account_index': number; 'api_key_index': number; } export interface ReqGetOrderBookDetails { 'market_id'?: number; 'filter'?: ReqGetOrderBookDetailsFilterEnum; } export declare const ReqGetOrderBookDetailsFilterEnum: { readonly All: "all"; readonly Spot: "spot"; readonly Perp: "perp"; }; export type ReqGetOrderBookDetailsFilterEnum = typeof ReqGetOrderBookDetailsFilterEnum[keyof typeof ReqGetOrderBookDetailsFilterEnum]; export interface ReqGetOrderBookOrders { 'market_id': number; 'limit': number; } export interface ReqGetOrderBooks { 'market_id'?: number; 'filter'?: ReqGetOrderBooksFilterEnum; } export declare const ReqGetOrderBooksFilterEnum: { readonly All: "all"; readonly Spot: "spot"; readonly Perp: "perp"; }; export type ReqGetOrderBooksFilterEnum = typeof ReqGetOrderBooksFilterEnum[keyof typeof ReqGetOrderBooksFilterEnum]; export interface ReqGetPositionFunding { 'auth'?: string; 'account_index': number; 'market_id'?: number; 'cursor'?: string; 'limit': number; 'side'?: ReqGetPositionFundingSideEnum; } export declare const ReqGetPositionFundingSideEnum: { readonly Long: "long"; readonly Short: "short"; readonly All: "all"; }; export type ReqGetPositionFundingSideEnum = typeof ReqGetPositionFundingSideEnum[keyof typeof ReqGetPositionFundingSideEnum]; export interface ReqGetPublicPoolsMetadata { 'auth'?: string; 'filter'?: ReqGetPublicPoolsMetadataFilterEnum; 'index': number; 'limit': number; 'account_index'?: number; } export declare const ReqGetPublicPoolsMetadataFilterEnum: { readonly All: "all"; readonly User: "user"; readonly Protocol: "protocol"; readonly AccountIndex: "account_index"; }; export type ReqGetPublicPoolsMetadataFilterEnum = typeof ReqGetPublicPoolsMetadataFilterEnum[keyof typeof ReqGetPublicPoolsMetadataFilterEnum]; export interface ReqGetRangeWithCursor { 'cursor'?: string; 'limit': number; } export interface ReqGetRangeWithIndex { 'index'?: number; 'limit': number; } export interface ReqGetRangeWithIndexSortable { 'index'?: number; 'limit'?: number; 'sort'?: ReqGetRangeWithIndexSortableSortEnum; } export declare const ReqGetRangeWithIndexSortableSortEnum: { readonly Asc: "asc"; readonly Desc: "desc"; }; export type ReqGetRangeWithIndexSortableSortEnum = typeof ReqGetRangeWithIndexSortableSortEnum[keyof typeof ReqGetRangeWithIndexSortableSortEnum]; export interface ReqGetRecentTrades { 'market_id': number; 'limit': number; } export interface ReqGetReferralPoints { /** * made optional to support header auth clients */ 'auth'?: string; 'account_index': number; } export interface ReqGetTrades { 'auth'?: string; 'market_id'?: number; 'account_index'?: number; 'order_index'?: number; 'sort_by': ReqGetTradesSortByEnum; 'sort_dir'?: ReqGetTradesSortDirEnum; 'cursor'?: string; 'from'?: number; 'ask_filter'?: number; 'role'?: ReqGetTradesRoleEnum; 'type'?: ReqGetTradesTypeEnum; 'limit': number; 'aggregate'?: boolean; } export declare const ReqGetTradesSortByEnum: { readonly BlockHeight: "block_height"; readonly Timestamp: "timestamp"; readonly TradeId: "trade_id"; }; export type ReqGetTradesSortByEnum = typeof ReqGetTradesSortByEnum[keyof typeof ReqGetTradesSortByEnum]; export declare const ReqGetTradesSortDirEnum: { readonly Desc: "desc"; }; export type ReqGetTradesSortDirEnum = typeof ReqGetTradesSortDirEnum[keyof typeof ReqGetTradesSortDirEnum]; export declare const ReqGetTradesRoleEnum: { readonly All: "all"; readonly Maker: "maker"; readonly Taker: "taker"; }; export type ReqGetTradesRoleEnum = typeof ReqGetTradesRoleEnum[keyof typeof ReqGetTradesRoleEnum]; export declare const ReqGetTradesTypeEnum: { readonly All: "all"; readonly Trade: "trade"; readonly Liquidation: "liquidation"; readonly Deleverage: "deleverage"; readonly MarketSettlement: "market-settlement"; }; export type ReqGetTradesTypeEnum = typeof ReqGetTradesTypeEnum[keyof typeof ReqGetTradesTypeEnum]; export interface ReqGetTransferFeeInfo { 'auth'?: string; 'account_index': number; 'to_account_index'?: number; } export interface ReqGetTransferHistory { 'account_index': number; /** * made optional to support header auth clients */ 'auth'?: string; 'cursor'?: string; } export interface ReqGetTx { 'by': ReqGetTxByEnum; 'value': string; } export declare const ReqGetTxByEnum: { readonly Hash: "hash"; readonly SequenceIndex: "sequence_index"; }; export type ReqGetTxByEnum = typeof ReqGetTxByEnum[keyof typeof ReqGetTxByEnum]; export interface ReqGetWithdrawHistory { 'account_index': number; /** * made optional to support header auth clients */ 'auth'?: string; 'cursor'?: string; 'filter'?: ReqGetWithdrawHistoryFilterEnum; } export declare const ReqGetWithdrawHistoryFilterEnum: { readonly All: "all"; readonly Pending: "pending"; readonly Claimable: "claimable"; }; export type ReqGetWithdrawHistoryFilterEnum = typeof ReqGetWithdrawHistoryFilterEnum[keyof typeof ReqGetWithdrawHistoryFilterEnum]; export interface RespChangeAccountTier { 'code': number; 'message'?: string; } export interface RespGetBridgesByL1Addr { 'code': number; 'message'?: string; 'bridges': Array; } export interface RespGetFastBridgeInfo { 'code': number; 'message'?: string; 'fast_bridge_limit': string; } export interface RespGetIsNextBridgeFast { 'code': number; 'message'?: string; 'is_next_bridge_fast': boolean; } export interface RespPublicPoolsMetadata { 'code': number; 'message'?: string; 'public_pools': Array; } export interface RespSendTx { 'code': number; 'message'?: string; 'tx_hash': string; 'predicted_execution_time_ms': number; 'volume_quota_remaining': number; } export interface RespSendTxBatch { 'code': number; 'message'?: string; 'tx_hash': Array; 'predicted_execution_time_ms': number; 'volume_quota_remaining': number; } export interface RespUpdateKickback { 'code': number; 'message'?: string; 'success': boolean; } export interface RespUpdateReferralCode { 'code': number; 'message'?: string; 'success': boolean; } export interface RespWithdrawalDelay { 'seconds': number; } export interface ResultCode { 'code': number; 'message'?: string; } export interface RiskInfo { 'cross_risk_parameters': RiskParameters; 'isolated_risk_parameters': Array; } export interface RiskParameters { 'market_id': number; 'collateral': string; 'total_account_value': string; 'initial_margin_req': string; 'maintenance_margin_req': string; 'close_out_margin_req': string; } export interface SharePrice { 'timestamp': number; 'share_price': number; } export interface SimpleOrder { 'order_index': number; 'order_id': string; 'owner_account_index': number; 'initial_base_amount': string; 'remaining_base_amount': string; 'price': string; 'order_expiry': number; } export interface SpotMarketStats { 'symbol': string; 'market_id': number; 'index_price': string; 'mid_price': string; 'last_trade_price': string; 'daily_base_token_volume': number; 'daily_quote_token_volume': number; 'daily_price_low': number; 'daily_price_high': number; 'daily_price_change': number; } export interface SpotOrderBookDetail { 'symbol': string; 'market_id': number; 'market_type': SpotOrderBookDetailMarketTypeEnum; 'base_asset_id': number; 'quote_asset_id': number; 'status': SpotOrderBookDetailStatusEnum; 'taker_fee': string; 'maker_fee': string; 'liquidation_fee': string; 'min_base_amount': string; 'min_quote_amount': string; 'order_quote_limit': string; 'supported_size_decimals': number; 'supported_price_decimals': number; 'supported_quote_decimals': number; 'size_decimals': number; 'price_decimals': number; 'last_trade_price': number; 'daily_trades_count': number; 'daily_base_token_volume': number; 'daily_quote_token_volume': number; 'daily_price_low': number; 'daily_price_high': number; 'daily_price_change': number; 'daily_chart': { [key: string]: number; }; } export declare const SpotOrderBookDetailMarketTypeEnum: { readonly Perp: "perp"; readonly Spot: "spot"; }; export type SpotOrderBookDetailMarketTypeEnum = typeof SpotOrderBookDetailMarketTypeEnum[keyof typeof SpotOrderBookDetailMarketTypeEnum]; export declare const SpotOrderBookDetailStatusEnum: { readonly Inactive: "inactive"; readonly Active: "active"; }; export type SpotOrderBookDetailStatusEnum = typeof SpotOrderBookDetailStatusEnum[keyof typeof SpotOrderBookDetailStatusEnum]; export interface Status { 'status': number; 'network_id': number; 'timestamp': number; } export interface SubAccounts { 'code': number; 'message'?: string; 'l1_address': string; 'sub_accounts': Array; } export interface Ticker { 's': string; 'a': PriceLevel; 'b': PriceLevel; } export interface Trade { 'trade_id': number; 'tx_hash': string; 'type': TradeTypeEnum; 'market_id': number; 'size': string; 'price': string; 'usd_amount': string; 'ask_id': number; 'bid_id': number; 'ask_client_id': number; 'bid_client_id': number; 'ask_account_id': number; 'bid_account_id': number; 'is_maker_ask': boolean; 'block_height': number; 'timestamp': number; 'taker_fee': number; 'taker_position_size_before': string; 'taker_entry_quote_before': string; 'taker_initial_margin_fraction_before': number; 'taker_position_sign_changed': boolean; 'maker_fee': number; 'maker_position_size_before': string; 'maker_entry_quote_before': string; 'maker_initial_margin_fraction_before': number; 'maker_position_sign_changed': boolean; } export declare const TradeTypeEnum: { readonly Trade: "trade"; readonly Liquidation: "liquidation"; readonly Deleverage: "deleverage"; readonly MarketSettlement: "market-settlement"; }; export type TradeTypeEnum = typeof TradeTypeEnum[keyof typeof TradeTypeEnum]; export interface Trades { 'code': number; 'message'?: string; 'next_cursor'?: string; 'trades': Array; } export interface TransferFeeInfo { 'code': number; 'message'?: string; 'transfer_fee_usdc': number; } export interface TransferHistory { 'code': number; 'message'?: string; 'transfers': Array; 'cursor': string; } export interface TransferHistoryItem { 'id': string; 'asset_id': number; 'amount': string; 'timestamp': number; 'type': TransferHistoryItemTypeEnum; 'from_l1_address': string; 'to_l1_address': string; 'from_account_index': number; 'to_account_index': number; 'from_route': TransferHistoryItemFromRouteEnum; 'to_route': TransferHistoryItemToRouteEnum; 'tx_hash': string; } export declare const TransferHistoryItemTypeEnum: { readonly L2TransferInflow: "L2TransferInflow"; readonly L2TransferOutflow: "L2TransferOutflow"; readonly L2BurnSharesInflow: "L2BurnSharesInflow"; readonly L2BurnSharesOutflow: "L2BurnSharesOutflow"; readonly L2MintSharesInflow: "L2MintSharesInflow"; readonly L2MintSharesOutflow: "L2MintSharesOutflow"; readonly L2SelfTransfer: "L2SelfTransfer"; }; export type TransferHistoryItemTypeEnum = typeof TransferHistoryItemTypeEnum[keyof typeof TransferHistoryItemTypeEnum]; export declare const TransferHistoryItemFromRouteEnum: { readonly Spot: "spot"; readonly Perps: "perps"; }; export type TransferHistoryItemFromRouteEnum = typeof TransferHistoryItemFromRouteEnum[keyof typeof TransferHistoryItemFromRouteEnum]; export declare const TransferHistoryItemToRouteEnum: { readonly Spot: "spot"; readonly Perps: "perps"; }; export type TransferHistoryItemToRouteEnum = typeof TransferHistoryItemToRouteEnum[keyof typeof TransferHistoryItemToRouteEnum]; export interface Tx { 'hash': string; 'type': number; 'info': string; 'event_info': string; 'status': number; 'transaction_index': number; 'l1_address': string; 'account_index': number; 'nonce': number; 'expire_at': number; 'block_height': number; 'queued_at': number; 'executed_at': number; 'sequence_index': number; 'parent_hash': string; 'api_key_index': number; } export interface TxHash { 'code': number; 'message'?: string; 'tx_hash': string; } export interface TxHashes { 'code': number; 'message'?: string; 'tx_hash': Array; } export interface Txs { 'code': number; 'message'?: string; 'txs': Array; } export interface ValidatorInfo { 'address': string; 'is_active': boolean; } export interface WithdrawHistory { 'code': number; 'message'?: string; 'withdraws': Array; 'cursor': string; } export interface WithdrawHistoryItem { 'id': string; 'asset_id': number; 'amount': string; 'timestamp': number; 'status': WithdrawHistoryItemStatusEnum; 'type': WithdrawHistoryItemTypeEnum; 'l1_tx_hash': string; } export declare const WithdrawHistoryItemStatusEnum: { readonly Failed: "failed"; readonly Pending: "pending"; readonly Claimable: "claimable"; readonly Refunded: "refunded"; readonly Completed: "completed"; }; export type WithdrawHistoryItemStatusEnum = typeof WithdrawHistoryItemStatusEnum[keyof typeof WithdrawHistoryItemStatusEnum]; export declare const WithdrawHistoryItemTypeEnum: { readonly Secure: "secure"; readonly Fast: "fast"; }; export type WithdrawHistoryItemTypeEnum = typeof WithdrawHistoryItemTypeEnum[keyof typeof WithdrawHistoryItemTypeEnum]; export interface ZkLighterInfo { 'contract_address': string; } /** * AccountApi - axios parameter creator */ export declare const AccountApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get account by account\'s index.
More details about account index: [Account Index](https://apidocs.lighter.xyz/docs/account-index)
**Response Description:**

1) **Status:** 1 is active 0 is inactive.
2) **Collateral:** The amount of collateral in the account.
**Position Details Description:**
1) **OOC:** Open order count in that market.
2) **Sign:** 1 for Long, -1 for Short.
3) **Position:** The amount of position in that market.
4) **Avg Entry Price:** The average entry price of the position.
5) **Position Value:** The value of the position.
6) **Unrealized PnL:** The unrealized profit and loss of the position.
7) **Realized PnL:** The realized profit and loss of the position. * @summary account * @param {AccountByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ account: (by: AccountByEnum, value: string, options?: RawAxiosRequestConfig) => Promise; /** * Get account limits * @summary accountLimits * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountLimits: (accountIndex: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get account metadatas * @summary accountMetadata * @param {AccountMetadataByEnum} by * @param {string} value * @param {string} [authorization] * @param {string} [auth] * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountMetadata: (by: AccountMetadataByEnum, value: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get accounts by l1_address returns all accounts associated with the given L1 address * @summary accountsByL1Address * @param {string} l1Address * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountsByL1Address: (l1Address: string, options?: RawAxiosRequestConfig) => Promise; /** * Get account api key. Set `api_key_index` to 255 to retrieve all api keys associated with the account. * @summary apikeys * @param {number} accountIndex * @param {number} [apiKeyIndex] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apikeys: (accountIndex: number, apiKeyIndex?: number, options?: RawAxiosRequestConfig) => Promise; /** * Change account tier * @summary changeAccountTier * @param {number} accountIndex * @param {string} newTier * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeAccountTier: (accountIndex: number, newTier: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get L1 metadata * @summary l1Metadata * @param {string} l1Address * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ l1Metadata: (l1Address: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get liquidation infos * @summary liquidations * @param {number} accountIndex * @param {number} limit * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {number} [marketId] * @param {string} [cursor] * @param {*} [options] Override http request option. * @throws {RequiredError} */ liquidations: (accountIndex: number, limit: number, authorization?: string, auth?: string, marketId?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get account PnL chart * @summary pnl * @param {PnlByEnum} by * @param {string} value * @param {PnlResolutionEnum} resolution * @param {number} startTimestamp * @param {number} endTimestamp * @param {number} countBack * @param {string} [authorization] * @param {string} [auth] * @param {boolean} [ignoreTransfers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pnl: (by: PnlByEnum, value: string, resolution: PnlResolutionEnum, startTimestamp: number, endTimestamp: number, countBack: number, authorization?: string, auth?: string, ignoreTransfers?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get accounts position fundings * @summary positionFunding * @param {number} accountIndex * @param {number} limit * @param {string} [authorization] * @param {string} [auth] * @param {number} [marketId] * @param {string} [cursor] * @param {PositionFundingSideEnum} [side] * @param {*} [options] Override http request option. * @throws {RequiredError} */ positionFunding: (accountIndex: number, limit: number, authorization?: string, auth?: string, marketId?: number, cursor?: string, side?: PositionFundingSideEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get public pools metadata * @summary publicPoolsMetadata * @param {number} index * @param {number} limit * @param {string} [authorization] * @param {string} [auth] * @param {PublicPoolsMetadataFilterEnum} [filter] * @param {number} [accountIndex] * @param {*} [options] Override http request option. * @throws {RequiredError} */ publicPoolsMetadata: (index: number, limit: number, authorization?: string, auth?: string, filter?: PublicPoolsMetadataFilterEnum, accountIndex?: number, options?: RawAxiosRequestConfig) => Promise; }; /** * AccountApi - functional programming interface */ export declare const AccountApiFp: (configuration?: Configuration) => { /** * Get account by account\'s index.
More details about account index: [Account Index](https://apidocs.lighter.xyz/docs/account-index)
**Response Description:**

1) **Status:** 1 is active 0 is inactive.
2) **Collateral:** The amount of collateral in the account.
**Position Details Description:**
1) **OOC:** Open order count in that market.
2) **Sign:** 1 for Long, -1 for Short.
3) **Position:** The amount of position in that market.
4) **Avg Entry Price:** The average entry price of the position.
5) **Position Value:** The value of the position.
6) **Unrealized PnL:** The unrealized profit and loss of the position.
7) **Realized PnL:** The realized profit and loss of the position. * @summary account * @param {AccountByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ account(by: AccountByEnum, value: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get account limits * @summary accountLimits * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountLimits(accountIndex: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get account metadatas * @summary accountMetadata * @param {AccountMetadataByEnum} by * @param {string} value * @param {string} [authorization] * @param {string} [auth] * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountMetadata(by: AccountMetadataByEnum, value: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get accounts by l1_address returns all accounts associated with the given L1 address * @summary accountsByL1Address * @param {string} l1Address * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountsByL1Address(l1Address: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get account api key. Set `api_key_index` to 255 to retrieve all api keys associated with the account. * @summary apikeys * @param {number} accountIndex * @param {number} [apiKeyIndex] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apikeys(accountIndex: number, apiKeyIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Change account tier * @summary changeAccountTier * @param {number} accountIndex * @param {string} newTier * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeAccountTier(accountIndex: number, newTier: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get L1 metadata * @summary l1Metadata * @param {string} l1Address * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ l1Metadata(l1Address: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get liquidation infos * @summary liquidations * @param {number} accountIndex * @param {number} limit * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {number} [marketId] * @param {string} [cursor] * @param {*} [options] Override http request option. * @throws {RequiredError} */ liquidations(accountIndex: number, limit: number, authorization?: string, auth?: string, marketId?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get account PnL chart * @summary pnl * @param {PnlByEnum} by * @param {string} value * @param {PnlResolutionEnum} resolution * @param {number} startTimestamp * @param {number} endTimestamp * @param {number} countBack * @param {string} [authorization] * @param {string} [auth] * @param {boolean} [ignoreTransfers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pnl(by: PnlByEnum, value: string, resolution: PnlResolutionEnum, startTimestamp: number, endTimestamp: number, countBack: number, authorization?: string, auth?: string, ignoreTransfers?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get accounts position fundings * @summary positionFunding * @param {number} accountIndex * @param {number} limit * @param {string} [authorization] * @param {string} [auth] * @param {number} [marketId] * @param {string} [cursor] * @param {PositionFundingSideEnum} [side] * @param {*} [options] Override http request option. * @throws {RequiredError} */ positionFunding(accountIndex: number, limit: number, authorization?: string, auth?: string, marketId?: number, cursor?: string, side?: PositionFundingSideEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get public pools metadata * @summary publicPoolsMetadata * @param {number} index * @param {number} limit * @param {string} [authorization] * @param {string} [auth] * @param {PublicPoolsMetadataFilterEnum} [filter] * @param {number} [accountIndex] * @param {*} [options] Override http request option. * @throws {RequiredError} */ publicPoolsMetadata(index: number, limit: number, authorization?: string, auth?: string, filter?: PublicPoolsMetadataFilterEnum, accountIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AccountApi - factory interface */ export declare const AccountApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get account by account\'s index.
More details about account index: [Account Index](https://apidocs.lighter.xyz/docs/account-index)
**Response Description:**

1) **Status:** 1 is active 0 is inactive.
2) **Collateral:** The amount of collateral in the account.
**Position Details Description:**
1) **OOC:** Open order count in that market.
2) **Sign:** 1 for Long, -1 for Short.
3) **Position:** The amount of position in that market.
4) **Avg Entry Price:** The average entry price of the position.
5) **Position Value:** The value of the position.
6) **Unrealized PnL:** The unrealized profit and loss of the position.
7) **Realized PnL:** The realized profit and loss of the position. * @summary account * @param {AccountByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ account(by: AccountByEnum, value: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get account limits * @summary accountLimits * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountLimits(accountIndex: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get account metadatas * @summary accountMetadata * @param {AccountMetadataByEnum} by * @param {string} value * @param {string} [authorization] * @param {string} [auth] * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountMetadata(by: AccountMetadataByEnum, value: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get accounts by l1_address returns all accounts associated with the given L1 address * @summary accountsByL1Address * @param {string} l1Address * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountsByL1Address(l1Address: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get account api key. Set `api_key_index` to 255 to retrieve all api keys associated with the account. * @summary apikeys * @param {number} accountIndex * @param {number} [apiKeyIndex] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apikeys(accountIndex: number, apiKeyIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Change account tier * @summary changeAccountTier * @param {number} accountIndex * @param {string} newTier * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeAccountTier(accountIndex: number, newTier: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get L1 metadata * @summary l1Metadata * @param {string} l1Address * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ l1Metadata(l1Address: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get liquidation infos * @summary liquidations * @param {number} accountIndex * @param {number} limit * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {number} [marketId] * @param {string} [cursor] * @param {*} [options] Override http request option. * @throws {RequiredError} */ liquidations(accountIndex: number, limit: number, authorization?: string, auth?: string, marketId?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get account PnL chart * @summary pnl * @param {PnlByEnum} by * @param {string} value * @param {PnlResolutionEnum} resolution * @param {number} startTimestamp * @param {number} endTimestamp * @param {number} countBack * @param {string} [authorization] * @param {string} [auth] * @param {boolean} [ignoreTransfers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pnl(by: PnlByEnum, value: string, resolution: PnlResolutionEnum, startTimestamp: number, endTimestamp: number, countBack: number, authorization?: string, auth?: string, ignoreTransfers?: boolean, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get accounts position fundings * @summary positionFunding * @param {number} accountIndex * @param {number} limit * @param {string} [authorization] * @param {string} [auth] * @param {number} [marketId] * @param {string} [cursor] * @param {PositionFundingSideEnum} [side] * @param {*} [options] Override http request option. * @throws {RequiredError} */ positionFunding(accountIndex: number, limit: number, authorization?: string, auth?: string, marketId?: number, cursor?: string, side?: PositionFundingSideEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get public pools metadata * @summary publicPoolsMetadata * @param {number} index * @param {number} limit * @param {string} [authorization] * @param {string} [auth] * @param {PublicPoolsMetadataFilterEnum} [filter] * @param {number} [accountIndex] * @param {*} [options] Override http request option. * @throws {RequiredError} */ publicPoolsMetadata(index: number, limit: number, authorization?: string, auth?: string, filter?: PublicPoolsMetadataFilterEnum, accountIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * AccountApi - object-oriented interface */ export declare class AccountApi extends BaseAPI { /** * Get account by account\'s index.
More details about account index: [Account Index](https://apidocs.lighter.xyz/docs/account-index)
**Response Description:**

1) **Status:** 1 is active 0 is inactive.
2) **Collateral:** The amount of collateral in the account.
**Position Details Description:**
1) **OOC:** Open order count in that market.
2) **Sign:** 1 for Long, -1 for Short.
3) **Position:** The amount of position in that market.
4) **Avg Entry Price:** The average entry price of the position.
5) **Position Value:** The value of the position.
6) **Unrealized PnL:** The unrealized profit and loss of the position.
7) **Realized PnL:** The realized profit and loss of the position. * @summary account * @param {AccountByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ account(by: AccountByEnum, value: string, options?: RawAxiosRequestConfig): Promise>; /** * Get account limits * @summary accountLimits * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountLimits(accountIndex: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise>; /** * Get account metadatas * @summary accountMetadata * @param {AccountMetadataByEnum} by * @param {string} value * @param {string} [authorization] * @param {string} [auth] * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountMetadata(by: AccountMetadataByEnum, value: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise>; /** * Get accounts by l1_address returns all accounts associated with the given L1 address * @summary accountsByL1Address * @param {string} l1Address * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountsByL1Address(l1Address: string, options?: RawAxiosRequestConfig): Promise>; /** * Get account api key. Set `api_key_index` to 255 to retrieve all api keys associated with the account. * @summary apikeys * @param {number} accountIndex * @param {number} [apiKeyIndex] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apikeys(accountIndex: number, apiKeyIndex?: number, options?: RawAxiosRequestConfig): Promise>; /** * Change account tier * @summary changeAccountTier * @param {number} accountIndex * @param {string} newTier * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeAccountTier(accountIndex: number, newTier: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise>; /** * Get L1 metadata * @summary l1Metadata * @param {string} l1Address * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ l1Metadata(l1Address: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise>; /** * Get liquidation infos * @summary liquidations * @param {number} accountIndex * @param {number} limit * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {number} [marketId] * @param {string} [cursor] * @param {*} [options] Override http request option. * @throws {RequiredError} */ liquidations(accountIndex: number, limit: number, authorization?: string, auth?: string, marketId?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise>; /** * Get account PnL chart * @summary pnl * @param {PnlByEnum} by * @param {string} value * @param {PnlResolutionEnum} resolution * @param {number} startTimestamp * @param {number} endTimestamp * @param {number} countBack * @param {string} [authorization] * @param {string} [auth] * @param {boolean} [ignoreTransfers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ pnl(by: PnlByEnum, value: string, resolution: PnlResolutionEnum, startTimestamp: number, endTimestamp: number, countBack: number, authorization?: string, auth?: string, ignoreTransfers?: boolean, options?: RawAxiosRequestConfig): Promise>; /** * Get accounts position fundings * @summary positionFunding * @param {number} accountIndex * @param {number} limit * @param {string} [authorization] * @param {string} [auth] * @param {number} [marketId] * @param {string} [cursor] * @param {PositionFundingSideEnum} [side] * @param {*} [options] Override http request option. * @throws {RequiredError} */ positionFunding(accountIndex: number, limit: number, authorization?: string, auth?: string, marketId?: number, cursor?: string, side?: PositionFundingSideEnum, options?: RawAxiosRequestConfig): Promise>; /** * Get public pools metadata * @summary publicPoolsMetadata * @param {number} index * @param {number} limit * @param {string} [authorization] * @param {string} [auth] * @param {PublicPoolsMetadataFilterEnum} [filter] * @param {number} [accountIndex] * @param {*} [options] Override http request option. * @throws {RequiredError} */ publicPoolsMetadata(index: number, limit: number, authorization?: string, auth?: string, filter?: PublicPoolsMetadataFilterEnum, accountIndex?: number, options?: RawAxiosRequestConfig): Promise>; } export declare const AccountByEnum: { readonly Index: "index"; readonly L1Address: "l1_address"; }; export type AccountByEnum = typeof AccountByEnum[keyof typeof AccountByEnum]; export declare const AccountMetadataByEnum: { readonly Index: "index"; readonly L1Address: "l1_address"; }; export type AccountMetadataByEnum = typeof AccountMetadataByEnum[keyof typeof AccountMetadataByEnum]; export declare const PnlByEnum: { readonly Index: "index"; }; export type PnlByEnum = typeof PnlByEnum[keyof typeof PnlByEnum]; export declare const PnlResolutionEnum: { readonly _1m: "1m"; readonly _5m: "5m"; readonly _15m: "15m"; readonly _1h: "1h"; readonly _4h: "4h"; readonly _1d: "1d"; }; export type PnlResolutionEnum = typeof PnlResolutionEnum[keyof typeof PnlResolutionEnum]; export declare const PositionFundingSideEnum: { readonly Long: "long"; readonly Short: "short"; readonly All: "all"; }; export type PositionFundingSideEnum = typeof PositionFundingSideEnum[keyof typeof PositionFundingSideEnum]; export declare const PublicPoolsMetadataFilterEnum: { readonly All: "all"; readonly User: "user"; readonly Protocol: "protocol"; readonly AccountIndex: "account_index"; }; export type PublicPoolsMetadataFilterEnum = typeof PublicPoolsMetadataFilterEnum[keyof typeof PublicPoolsMetadataFilterEnum]; /** * AnnouncementApi - axios parameter creator */ export declare const AnnouncementApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get announcement * @summary announcement * @param {*} [options] Override http request option. * @throws {RequiredError} */ announcement: (options?: RawAxiosRequestConfig) => Promise; }; /** * AnnouncementApi - functional programming interface */ export declare const AnnouncementApiFp: (configuration?: Configuration) => { /** * Get announcement * @summary announcement * @param {*} [options] Override http request option. * @throws {RequiredError} */ announcement(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AnnouncementApi - factory interface */ export declare const AnnouncementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get announcement * @summary announcement * @param {*} [options] Override http request option. * @throws {RequiredError} */ announcement(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * AnnouncementApi - object-oriented interface */ export declare class AnnouncementApi extends BaseAPI { /** * Get announcement * @summary announcement * @param {*} [options] Override http request option. * @throws {RequiredError} */ announcement(options?: RawAxiosRequestConfig): Promise>; } /** * BlockApi - axios parameter creator */ export declare const BlockApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get block by its height or commitment * @summary block * @param {BlockByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ block: (by: BlockByEnum, value: string, options?: RawAxiosRequestConfig) => Promise; /** * Get blocks * @summary blocks * @param {number} limit * @param {number} [index] * @param {BlocksSortEnum} [sort] * @param {*} [options] Override http request option. * @throws {RequiredError} */ blocks: (limit: number, index?: number, sort?: BlocksSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get current height * @summary currentHeight * @param {*} [options] Override http request option. * @throws {RequiredError} */ currentHeight: (options?: RawAxiosRequestConfig) => Promise; }; /** * BlockApi - functional programming interface */ export declare const BlockApiFp: (configuration?: Configuration) => { /** * Get block by its height or commitment * @summary block * @param {BlockByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ block(by: BlockByEnum, value: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get blocks * @summary blocks * @param {number} limit * @param {number} [index] * @param {BlocksSortEnum} [sort] * @param {*} [options] Override http request option. * @throws {RequiredError} */ blocks(limit: number, index?: number, sort?: BlocksSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get current height * @summary currentHeight * @param {*} [options] Override http request option. * @throws {RequiredError} */ currentHeight(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * BlockApi - factory interface */ export declare const BlockApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get block by its height or commitment * @summary block * @param {BlockByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ block(by: BlockByEnum, value: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get blocks * @summary blocks * @param {number} limit * @param {number} [index] * @param {BlocksSortEnum} [sort] * @param {*} [options] Override http request option. * @throws {RequiredError} */ blocks(limit: number, index?: number, sort?: BlocksSortEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get current height * @summary currentHeight * @param {*} [options] Override http request option. * @throws {RequiredError} */ currentHeight(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * BlockApi - object-oriented interface */ export declare class BlockApi extends BaseAPI { /** * Get block by its height or commitment * @summary block * @param {BlockByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ block(by: BlockByEnum, value: string, options?: RawAxiosRequestConfig): Promise>; /** * Get blocks * @summary blocks * @param {number} limit * @param {number} [index] * @param {BlocksSortEnum} [sort] * @param {*} [options] Override http request option. * @throws {RequiredError} */ blocks(limit: number, index?: number, sort?: BlocksSortEnum, options?: RawAxiosRequestConfig): Promise>; /** * Get current height * @summary currentHeight * @param {*} [options] Override http request option. * @throws {RequiredError} */ currentHeight(options?: RawAxiosRequestConfig): Promise>; } export declare const BlockByEnum: { readonly Commitment: "commitment"; readonly Height: "height"; }; export type BlockByEnum = typeof BlockByEnum[keyof typeof BlockByEnum]; export declare const BlocksSortEnum: { readonly Asc: "asc"; readonly Desc: "desc"; }; export type BlocksSortEnum = typeof BlocksSortEnum[keyof typeof BlocksSortEnum]; /** * BridgeApi - axios parameter creator */ export declare const BridgeApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get bridges for given l1 address * @summary bridges * @param {string} l1Address * @param {*} [options] Override http request option. * @throws {RequiredError} */ bridges: (l1Address: string, options?: RawAxiosRequestConfig) => Promise; /** * Get if next bridge is fast * @summary bridges_isNextBridgeFast * @param {string} l1Address * @param {*} [options] Override http request option. * @throws {RequiredError} */ bridgesIsNextBridgeFast: (l1Address: string, options?: RawAxiosRequestConfig) => Promise; /** * Get fast bridge info * @summary fastbridge_info * @param {*} [options] Override http request option. * @throws {RequiredError} */ fastbridgeInfo: (options?: RawAxiosRequestConfig) => Promise; }; /** * BridgeApi - functional programming interface */ export declare const BridgeApiFp: (configuration?: Configuration) => { /** * Get bridges for given l1 address * @summary bridges * @param {string} l1Address * @param {*} [options] Override http request option. * @throws {RequiredError} */ bridges(l1Address: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get if next bridge is fast * @summary bridges_isNextBridgeFast * @param {string} l1Address * @param {*} [options] Override http request option. * @throws {RequiredError} */ bridgesIsNextBridgeFast(l1Address: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get fast bridge info * @summary fastbridge_info * @param {*} [options] Override http request option. * @throws {RequiredError} */ fastbridgeInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * BridgeApi - factory interface */ export declare const BridgeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get bridges for given l1 address * @summary bridges * @param {string} l1Address * @param {*} [options] Override http request option. * @throws {RequiredError} */ bridges(l1Address: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get if next bridge is fast * @summary bridges_isNextBridgeFast * @param {string} l1Address * @param {*} [options] Override http request option. * @throws {RequiredError} */ bridgesIsNextBridgeFast(l1Address: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get fast bridge info * @summary fastbridge_info * @param {*} [options] Override http request option. * @throws {RequiredError} */ fastbridgeInfo(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * BridgeApi - object-oriented interface */ export declare class BridgeApi extends BaseAPI { /** * Get bridges for given l1 address * @summary bridges * @param {string} l1Address * @param {*} [options] Override http request option. * @throws {RequiredError} */ bridges(l1Address: string, options?: RawAxiosRequestConfig): Promise>; /** * Get if next bridge is fast * @summary bridges_isNextBridgeFast * @param {string} l1Address * @param {*} [options] Override http request option. * @throws {RequiredError} */ bridgesIsNextBridgeFast(l1Address: string, options?: RawAxiosRequestConfig): Promise>; /** * Get fast bridge info * @summary fastbridge_info * @param {*} [options] Override http request option. * @throws {RequiredError} */ fastbridgeInfo(options?: RawAxiosRequestConfig): Promise>; } /** * CandlestickApi - axios parameter creator */ export declare const CandlestickApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get candlesticks * @summary candlesticks * @param {number} marketId * @param {CandlesticksResolutionEnum} resolution * @param {number} startTimestamp * @param {number} endTimestamp * @param {number} countBack * @param {boolean} [setTimestampToEnd] * @param {*} [options] Override http request option. * @throws {RequiredError} */ candlesticks: (marketId: number, resolution: CandlesticksResolutionEnum, startTimestamp: number, endTimestamp: number, countBack: number, setTimestampToEnd?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get fundings * @summary fundings * @param {number} marketId * @param {FundingsResolutionEnum} resolution * @param {number} startTimestamp * @param {number} endTimestamp * @param {number} countBack * @param {*} [options] Override http request option. * @throws {RequiredError} */ fundings: (marketId: number, resolution: FundingsResolutionEnum, startTimestamp: number, endTimestamp: number, countBack: number, options?: RawAxiosRequestConfig) => Promise; }; /** * CandlestickApi - functional programming interface */ export declare const CandlestickApiFp: (configuration?: Configuration) => { /** * Get candlesticks * @summary candlesticks * @param {number} marketId * @param {CandlesticksResolutionEnum} resolution * @param {number} startTimestamp * @param {number} endTimestamp * @param {number} countBack * @param {boolean} [setTimestampToEnd] * @param {*} [options] Override http request option. * @throws {RequiredError} */ candlesticks(marketId: number, resolution: CandlesticksResolutionEnum, startTimestamp: number, endTimestamp: number, countBack: number, setTimestampToEnd?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get fundings * @summary fundings * @param {number} marketId * @param {FundingsResolutionEnum} resolution * @param {number} startTimestamp * @param {number} endTimestamp * @param {number} countBack * @param {*} [options] Override http request option. * @throws {RequiredError} */ fundings(marketId: number, resolution: FundingsResolutionEnum, startTimestamp: number, endTimestamp: number, countBack: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CandlestickApi - factory interface */ export declare const CandlestickApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get candlesticks * @summary candlesticks * @param {number} marketId * @param {CandlesticksResolutionEnum} resolution * @param {number} startTimestamp * @param {number} endTimestamp * @param {number} countBack * @param {boolean} [setTimestampToEnd] * @param {*} [options] Override http request option. * @throws {RequiredError} */ candlesticks(marketId: number, resolution: CandlesticksResolutionEnum, startTimestamp: number, endTimestamp: number, countBack: number, setTimestampToEnd?: boolean, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get fundings * @summary fundings * @param {number} marketId * @param {FundingsResolutionEnum} resolution * @param {number} startTimestamp * @param {number} endTimestamp * @param {number} countBack * @param {*} [options] Override http request option. * @throws {RequiredError} */ fundings(marketId: number, resolution: FundingsResolutionEnum, startTimestamp: number, endTimestamp: number, countBack: number, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * CandlestickApi - object-oriented interface */ export declare class CandlestickApi extends BaseAPI { /** * Get candlesticks * @summary candlesticks * @param {number} marketId * @param {CandlesticksResolutionEnum} resolution * @param {number} startTimestamp * @param {number} endTimestamp * @param {number} countBack * @param {boolean} [setTimestampToEnd] * @param {*} [options] Override http request option. * @throws {RequiredError} */ candlesticks(marketId: number, resolution: CandlesticksResolutionEnum, startTimestamp: number, endTimestamp: number, countBack: number, setTimestampToEnd?: boolean, options?: RawAxiosRequestConfig): Promise>; /** * Get fundings * @summary fundings * @param {number} marketId * @param {FundingsResolutionEnum} resolution * @param {number} startTimestamp * @param {number} endTimestamp * @param {number} countBack * @param {*} [options] Override http request option. * @throws {RequiredError} */ fundings(marketId: number, resolution: FundingsResolutionEnum, startTimestamp: number, endTimestamp: number, countBack: number, options?: RawAxiosRequestConfig): Promise>; } export declare const CandlesticksResolutionEnum: { readonly _1m: "1m"; readonly _5m: "5m"; readonly _15m: "15m"; readonly _30m: "30m"; readonly _1h: "1h"; readonly _4h: "4h"; readonly _12h: "12h"; readonly _1d: "1d"; readonly _1w: "1w"; }; export type CandlesticksResolutionEnum = typeof CandlesticksResolutionEnum[keyof typeof CandlesticksResolutionEnum]; export declare const FundingsResolutionEnum: { readonly _1h: "1h"; readonly _1d: "1d"; }; export type FundingsResolutionEnum = typeof FundingsResolutionEnum[keyof typeof FundingsResolutionEnum]; /** * FundingApi - axios parameter creator */ export declare const FundingApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get funding rates * @summary funding-rates * @param {*} [options] Override http request option. * @throws {RequiredError} */ fundingRates: (options?: RawAxiosRequestConfig) => Promise; }; /** * FundingApi - functional programming interface */ export declare const FundingApiFp: (configuration?: Configuration) => { /** * Get funding rates * @summary funding-rates * @param {*} [options] Override http request option. * @throws {RequiredError} */ fundingRates(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FundingApi - factory interface */ export declare const FundingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get funding rates * @summary funding-rates * @param {*} [options] Override http request option. * @throws {RequiredError} */ fundingRates(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * FundingApi - object-oriented interface */ export declare class FundingApi extends BaseAPI { /** * Get funding rates * @summary funding-rates * @param {*} [options] Override http request option. * @throws {RequiredError} */ fundingRates(options?: RawAxiosRequestConfig): Promise>; } /** * InfoApi - axios parameter creator */ export declare const InfoApiAxiosParamCreator: (configuration?: Configuration) => { /** * Transfer fee info * @summary transferFeeInfo * @param {number} accountIndex * @param {string} [authorization] * @param {string} [auth] * @param {number} [toAccountIndex] * @param {*} [options] Override http request option. * @throws {RequiredError} */ transferFeeInfo: (accountIndex: number, authorization?: string, auth?: string, toAccountIndex?: number, options?: RawAxiosRequestConfig) => Promise; /** * Withdrawal delay in seconds * @summary withdrawalDelay * @param {*} [options] Override http request option. * @throws {RequiredError} */ withdrawalDelay: (options?: RawAxiosRequestConfig) => Promise; }; /** * InfoApi - functional programming interface */ export declare const InfoApiFp: (configuration?: Configuration) => { /** * Transfer fee info * @summary transferFeeInfo * @param {number} accountIndex * @param {string} [authorization] * @param {string} [auth] * @param {number} [toAccountIndex] * @param {*} [options] Override http request option. * @throws {RequiredError} */ transferFeeInfo(accountIndex: number, authorization?: string, auth?: string, toAccountIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Withdrawal delay in seconds * @summary withdrawalDelay * @param {*} [options] Override http request option. * @throws {RequiredError} */ withdrawalDelay(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * InfoApi - factory interface */ export declare const InfoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Transfer fee info * @summary transferFeeInfo * @param {number} accountIndex * @param {string} [authorization] * @param {string} [auth] * @param {number} [toAccountIndex] * @param {*} [options] Override http request option. * @throws {RequiredError} */ transferFeeInfo(accountIndex: number, authorization?: string, auth?: string, toAccountIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Withdrawal delay in seconds * @summary withdrawalDelay * @param {*} [options] Override http request option. * @throws {RequiredError} */ withdrawalDelay(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * InfoApi - object-oriented interface */ export declare class InfoApi extends BaseAPI { /** * Transfer fee info * @summary transferFeeInfo * @param {number} accountIndex * @param {string} [authorization] * @param {string} [auth] * @param {number} [toAccountIndex] * @param {*} [options] Override http request option. * @throws {RequiredError} */ transferFeeInfo(accountIndex: number, authorization?: string, auth?: string, toAccountIndex?: number, options?: RawAxiosRequestConfig): Promise>; /** * Withdrawal delay in seconds * @summary withdrawalDelay * @param {*} [options] Override http request option. * @throws {RequiredError} */ withdrawalDelay(options?: RawAxiosRequestConfig): Promise>; } /** * NotificationApi - axios parameter creator */ export declare const NotificationApiAxiosParamCreator: (configuration?: Configuration) => { /** * Ack notification * @summary notification_ack * @param {string} notifId * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ notificationAck: (notifId: string, accountIndex: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * NotificationApi - functional programming interface */ export declare const NotificationApiFp: (configuration?: Configuration) => { /** * Ack notification * @summary notification_ack * @param {string} notifId * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ notificationAck(notifId: string, accountIndex: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * NotificationApi - factory interface */ export declare const NotificationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Ack notification * @summary notification_ack * @param {string} notifId * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ notificationAck(notifId: string, accountIndex: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * NotificationApi - object-oriented interface */ export declare class NotificationApi extends BaseAPI { /** * Ack notification * @summary notification_ack * @param {string} notifId * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ notificationAck(notifId: string, accountIndex: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise>; } /** * OrderApi - axios parameter creator */ export declare const OrderApiAxiosParamCreator: (configuration?: Configuration) => { /** * Export data * @summary export * @param {ExportTypeEnum} type * @param {string} [authorization] * @param {string} [auth] * @param {number} [accountIndex] * @param {number} [marketId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ _export: (type: ExportTypeEnum, authorization?: string, auth?: string, accountIndex?: number, marketId?: number, options?: RawAxiosRequestConfig) => Promise; /** * Get account active orders. `auth` can be generated using the SDK. * @summary accountActiveOrders * @param {number} accountIndex * @param {number} marketId * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountActiveOrders: (accountIndex: number, marketId: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get account inactive orders * @summary accountInactiveOrders * @param {number} accountIndex * @param {number} limit * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {number} [marketId] * @param {number} [askFilter] * @param {string} [betweenTimestamps] * @param {string} [cursor] * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountInactiveOrders: (accountIndex: number, limit: number, authorization?: string, auth?: string, marketId?: number, askFilter?: number, betweenTimestamps?: string, cursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get asset details * @summary assetDetails * @param {number} [assetId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ assetDetails: (assetId?: number, options?: RawAxiosRequestConfig) => Promise; /** * Get exchange stats * @summary exchangeStats * @param {*} [options] Override http request option. * @throws {RequiredError} */ exchangeStats: (options?: RawAxiosRequestConfig) => Promise; /** * Get order books metadata * @summary orderBookDetails * @param {number} [marketId] * @param {OrderBookDetailsFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBookDetails: (marketId?: number, filter?: OrderBookDetailsFilterEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get order book orders * @summary orderBookOrders * @param {number} marketId * @param {number} limit * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBookOrders: (marketId: number, limit: number, options?: RawAxiosRequestConfig) => Promise; /** * Get order books metadata.
**Response Description:**

1) **Taker and maker fees** are in percentage.
2) **Min base amount:** The amount of base token that can be traded in a single order.
3) **Min quote amount:** The amount of quote token that can be traded in a single order.
4) **Supported size decimals:** The number of decimal places that can be used for the size of the order.
5) **Supported price decimals:** The number of decimal places that can be used for the price of the order.
6) **Supported quote decimals:** Size Decimals + Quote Decimals. * @summary orderBooks * @param {number} [marketId] * @param {OrderBooksFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBooks: (marketId?: number, filter?: OrderBooksFilterEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get recent trades * @summary recentTrades * @param {number} marketId * @param {number} limit * @param {*} [options] Override http request option. * @throws {RequiredError} */ recentTrades: (marketId: number, limit: number, options?: RawAxiosRequestConfig) => Promise; /** * Get trades * @summary trades * @param {TradesSortByEnum} sortBy * @param {number} limit * @param {string} [authorization] * @param {string} [auth] * @param {number} [marketId] * @param {number} [accountIndex] * @param {number} [orderIndex] * @param {TradesSortDirEnum} [sortDir] * @param {string} [cursor] * @param {number} [from] * @param {number} [askFilter] * @param {TradesRoleEnum} [role] * @param {TradesTypeEnum} [type] * @param {boolean} [aggregate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ trades: (sortBy: TradesSortByEnum, limit: number, authorization?: string, auth?: string, marketId?: number, accountIndex?: number, orderIndex?: number, sortDir?: TradesSortDirEnum, cursor?: string, from?: number, askFilter?: number, role?: TradesRoleEnum, type?: TradesTypeEnum, aggregate?: boolean, options?: RawAxiosRequestConfig) => Promise; }; /** * OrderApi - functional programming interface */ export declare const OrderApiFp: (configuration?: Configuration) => { /** * Export data * @summary export * @param {ExportTypeEnum} type * @param {string} [authorization] * @param {string} [auth] * @param {number} [accountIndex] * @param {number} [marketId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ _export(type: ExportTypeEnum, authorization?: string, auth?: string, accountIndex?: number, marketId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get account active orders. `auth` can be generated using the SDK. * @summary accountActiveOrders * @param {number} accountIndex * @param {number} marketId * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountActiveOrders(accountIndex: number, marketId: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get account inactive orders * @summary accountInactiveOrders * @param {number} accountIndex * @param {number} limit * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {number} [marketId] * @param {number} [askFilter] * @param {string} [betweenTimestamps] * @param {string} [cursor] * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountInactiveOrders(accountIndex: number, limit: number, authorization?: string, auth?: string, marketId?: number, askFilter?: number, betweenTimestamps?: string, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get asset details * @summary assetDetails * @param {number} [assetId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ assetDetails(assetId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get exchange stats * @summary exchangeStats * @param {*} [options] Override http request option. * @throws {RequiredError} */ exchangeStats(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get order books metadata * @summary orderBookDetails * @param {number} [marketId] * @param {OrderBookDetailsFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBookDetails(marketId?: number, filter?: OrderBookDetailsFilterEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get order book orders * @summary orderBookOrders * @param {number} marketId * @param {number} limit * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBookOrders(marketId: number, limit: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get order books metadata.
**Response Description:**

1) **Taker and maker fees** are in percentage.
2) **Min base amount:** The amount of base token that can be traded in a single order.
3) **Min quote amount:** The amount of quote token that can be traded in a single order.
4) **Supported size decimals:** The number of decimal places that can be used for the size of the order.
5) **Supported price decimals:** The number of decimal places that can be used for the price of the order.
6) **Supported quote decimals:** Size Decimals + Quote Decimals. * @summary orderBooks * @param {number} [marketId] * @param {OrderBooksFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBooks(marketId?: number, filter?: OrderBooksFilterEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get recent trades * @summary recentTrades * @param {number} marketId * @param {number} limit * @param {*} [options] Override http request option. * @throws {RequiredError} */ recentTrades(marketId: number, limit: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get trades * @summary trades * @param {TradesSortByEnum} sortBy * @param {number} limit * @param {string} [authorization] * @param {string} [auth] * @param {number} [marketId] * @param {number} [accountIndex] * @param {number} [orderIndex] * @param {TradesSortDirEnum} [sortDir] * @param {string} [cursor] * @param {number} [from] * @param {number} [askFilter] * @param {TradesRoleEnum} [role] * @param {TradesTypeEnum} [type] * @param {boolean} [aggregate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ trades(sortBy: TradesSortByEnum, limit: number, authorization?: string, auth?: string, marketId?: number, accountIndex?: number, orderIndex?: number, sortDir?: TradesSortDirEnum, cursor?: string, from?: number, askFilter?: number, role?: TradesRoleEnum, type?: TradesTypeEnum, aggregate?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * OrderApi - factory interface */ export declare const OrderApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Export data * @summary export * @param {ExportTypeEnum} type * @param {string} [authorization] * @param {string} [auth] * @param {number} [accountIndex] * @param {number} [marketId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ _export(type: ExportTypeEnum, authorization?: string, auth?: string, accountIndex?: number, marketId?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get account active orders. `auth` can be generated using the SDK. * @summary accountActiveOrders * @param {number} accountIndex * @param {number} marketId * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountActiveOrders(accountIndex: number, marketId: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get account inactive orders * @summary accountInactiveOrders * @param {number} accountIndex * @param {number} limit * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {number} [marketId] * @param {number} [askFilter] * @param {string} [betweenTimestamps] * @param {string} [cursor] * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountInactiveOrders(accountIndex: number, limit: number, authorization?: string, auth?: string, marketId?: number, askFilter?: number, betweenTimestamps?: string, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get asset details * @summary assetDetails * @param {number} [assetId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ assetDetails(assetId?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get exchange stats * @summary exchangeStats * @param {*} [options] Override http request option. * @throws {RequiredError} */ exchangeStats(options?: RawAxiosRequestConfig): AxiosPromise; /** * Get order books metadata * @summary orderBookDetails * @param {number} [marketId] * @param {OrderBookDetailsFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBookDetails(marketId?: number, filter?: OrderBookDetailsFilterEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get order book orders * @summary orderBookOrders * @param {number} marketId * @param {number} limit * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBookOrders(marketId: number, limit: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get order books metadata.
**Response Description:**

1) **Taker and maker fees** are in percentage.
2) **Min base amount:** The amount of base token that can be traded in a single order.
3) **Min quote amount:** The amount of quote token that can be traded in a single order.
4) **Supported size decimals:** The number of decimal places that can be used for the size of the order.
5) **Supported price decimals:** The number of decimal places that can be used for the price of the order.
6) **Supported quote decimals:** Size Decimals + Quote Decimals. * @summary orderBooks * @param {number} [marketId] * @param {OrderBooksFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBooks(marketId?: number, filter?: OrderBooksFilterEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get recent trades * @summary recentTrades * @param {number} marketId * @param {number} limit * @param {*} [options] Override http request option. * @throws {RequiredError} */ recentTrades(marketId: number, limit: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get trades * @summary trades * @param {TradesSortByEnum} sortBy * @param {number} limit * @param {string} [authorization] * @param {string} [auth] * @param {number} [marketId] * @param {number} [accountIndex] * @param {number} [orderIndex] * @param {TradesSortDirEnum} [sortDir] * @param {string} [cursor] * @param {number} [from] * @param {number} [askFilter] * @param {TradesRoleEnum} [role] * @param {TradesTypeEnum} [type] * @param {boolean} [aggregate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ trades(sortBy: TradesSortByEnum, limit: number, authorization?: string, auth?: string, marketId?: number, accountIndex?: number, orderIndex?: number, sortDir?: TradesSortDirEnum, cursor?: string, from?: number, askFilter?: number, role?: TradesRoleEnum, type?: TradesTypeEnum, aggregate?: boolean, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * OrderApi - object-oriented interface */ export declare class OrderApi extends BaseAPI { /** * Export data * @summary export * @param {ExportTypeEnum} type * @param {string} [authorization] * @param {string} [auth] * @param {number} [accountIndex] * @param {number} [marketId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ _export(type: ExportTypeEnum, authorization?: string, auth?: string, accountIndex?: number, marketId?: number, options?: RawAxiosRequestConfig): Promise>; /** * Get account active orders. `auth` can be generated using the SDK. * @summary accountActiveOrders * @param {number} accountIndex * @param {number} marketId * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountActiveOrders(accountIndex: number, marketId: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise>; /** * Get account inactive orders * @summary accountInactiveOrders * @param {number} accountIndex * @param {number} limit * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {number} [marketId] * @param {number} [askFilter] * @param {string} [betweenTimestamps] * @param {string} [cursor] * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountInactiveOrders(accountIndex: number, limit: number, authorization?: string, auth?: string, marketId?: number, askFilter?: number, betweenTimestamps?: string, cursor?: string, options?: RawAxiosRequestConfig): Promise>; /** * Get asset details * @summary assetDetails * @param {number} [assetId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ assetDetails(assetId?: number, options?: RawAxiosRequestConfig): Promise>; /** * Get exchange stats * @summary exchangeStats * @param {*} [options] Override http request option. * @throws {RequiredError} */ exchangeStats(options?: RawAxiosRequestConfig): Promise>; /** * Get order books metadata * @summary orderBookDetails * @param {number} [marketId] * @param {OrderBookDetailsFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBookDetails(marketId?: number, filter?: OrderBookDetailsFilterEnum, options?: RawAxiosRequestConfig): Promise>; /** * Get order book orders * @summary orderBookOrders * @param {number} marketId * @param {number} limit * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBookOrders(marketId: number, limit: number, options?: RawAxiosRequestConfig): Promise>; /** * Get order books metadata.
**Response Description:**

1) **Taker and maker fees** are in percentage.
2) **Min base amount:** The amount of base token that can be traded in a single order.
3) **Min quote amount:** The amount of quote token that can be traded in a single order.
4) **Supported size decimals:** The number of decimal places that can be used for the size of the order.
5) **Supported price decimals:** The number of decimal places that can be used for the price of the order.
6) **Supported quote decimals:** Size Decimals + Quote Decimals. * @summary orderBooks * @param {number} [marketId] * @param {OrderBooksFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBooks(marketId?: number, filter?: OrderBooksFilterEnum, options?: RawAxiosRequestConfig): Promise>; /** * Get recent trades * @summary recentTrades * @param {number} marketId * @param {number} limit * @param {*} [options] Override http request option. * @throws {RequiredError} */ recentTrades(marketId: number, limit: number, options?: RawAxiosRequestConfig): Promise>; /** * Get trades * @summary trades * @param {TradesSortByEnum} sortBy * @param {number} limit * @param {string} [authorization] * @param {string} [auth] * @param {number} [marketId] * @param {number} [accountIndex] * @param {number} [orderIndex] * @param {TradesSortDirEnum} [sortDir] * @param {string} [cursor] * @param {number} [from] * @param {number} [askFilter] * @param {TradesRoleEnum} [role] * @param {TradesTypeEnum} [type] * @param {boolean} [aggregate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ trades(sortBy: TradesSortByEnum, limit: number, authorization?: string, auth?: string, marketId?: number, accountIndex?: number, orderIndex?: number, sortDir?: TradesSortDirEnum, cursor?: string, from?: number, askFilter?: number, role?: TradesRoleEnum, type?: TradesTypeEnum, aggregate?: boolean, options?: RawAxiosRequestConfig): Promise>; } export declare const ExportTypeEnum: { readonly Funding: "funding"; readonly Trade: "trade"; }; export type ExportTypeEnum = typeof ExportTypeEnum[keyof typeof ExportTypeEnum]; export declare const OrderBookDetailsFilterEnum: { readonly All: "all"; readonly Spot: "spot"; readonly Perp: "perp"; }; export type OrderBookDetailsFilterEnum = typeof OrderBookDetailsFilterEnum[keyof typeof OrderBookDetailsFilterEnum]; export declare const OrderBooksFilterEnum: { readonly All: "all"; readonly Spot: "spot"; readonly Perp: "perp"; }; export type OrderBooksFilterEnum = typeof OrderBooksFilterEnum[keyof typeof OrderBooksFilterEnum]; export declare const TradesSortByEnum: { readonly BlockHeight: "block_height"; readonly Timestamp: "timestamp"; readonly TradeId: "trade_id"; }; export type TradesSortByEnum = typeof TradesSortByEnum[keyof typeof TradesSortByEnum]; export declare const TradesSortDirEnum: { readonly Desc: "desc"; }; export type TradesSortDirEnum = typeof TradesSortDirEnum[keyof typeof TradesSortDirEnum]; export declare const TradesRoleEnum: { readonly All: "all"; readonly Maker: "maker"; readonly Taker: "taker"; }; export type TradesRoleEnum = typeof TradesRoleEnum[keyof typeof TradesRoleEnum]; export declare const TradesTypeEnum: { readonly All: "all"; readonly Trade: "trade"; readonly Liquidation: "liquidation"; readonly Deleverage: "deleverage"; readonly MarketSettlement: "market-settlement"; }; export type TradesTypeEnum = typeof TradesTypeEnum[keyof typeof TradesTypeEnum]; /** * ReferralApi - axios parameter creator */ export declare const ReferralApiAxiosParamCreator: (configuration?: Configuration) => { /** * Update kickback percentage for referral rewards * @summary referral_kickback_update * @param {number} accountIndex * @param {number} kickbackPercentage * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ referralKickbackUpdate: (accountIndex: number, kickbackPercentage: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get referral points * @summary referral_points * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ referralPoints: (accountIndex: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig) => Promise; /** * Update referral code (allowed once per account) * @summary referral_update * @param {number} accountIndex * @param {string} newReferralCode * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ referralUpdate: (accountIndex: number, newReferralCode: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ReferralApi - functional programming interface */ export declare const ReferralApiFp: (configuration?: Configuration) => { /** * Update kickback percentage for referral rewards * @summary referral_kickback_update * @param {number} accountIndex * @param {number} kickbackPercentage * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ referralKickbackUpdate(accountIndex: number, kickbackPercentage: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get referral points * @summary referral_points * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ referralPoints(accountIndex: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update referral code (allowed once per account) * @summary referral_update * @param {number} accountIndex * @param {string} newReferralCode * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ referralUpdate(accountIndex: number, newReferralCode: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ReferralApi - factory interface */ export declare const ReferralApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Update kickback percentage for referral rewards * @summary referral_kickback_update * @param {number} accountIndex * @param {number} kickbackPercentage * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ referralKickbackUpdate(accountIndex: number, kickbackPercentage: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get referral points * @summary referral_points * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ referralPoints(accountIndex: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update referral code (allowed once per account) * @summary referral_update * @param {number} accountIndex * @param {string} newReferralCode * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ referralUpdate(accountIndex: number, newReferralCode: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ReferralApi - object-oriented interface */ export declare class ReferralApi extends BaseAPI { /** * Update kickback percentage for referral rewards * @summary referral_kickback_update * @param {number} accountIndex * @param {number} kickbackPercentage * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ referralKickbackUpdate(accountIndex: number, kickbackPercentage: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise>; /** * Get referral points * @summary referral_points * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ referralPoints(accountIndex: number, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise>; /** * Update referral code (allowed once per account) * @summary referral_update * @param {number} accountIndex * @param {string} newReferralCode * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ referralUpdate(accountIndex: number, newReferralCode: string, authorization?: string, auth?: string, options?: RawAxiosRequestConfig): Promise>; } /** * RootApi - axios parameter creator */ export declare const RootApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get info of zklighter * @summary info * @param {*} [options] Override http request option. * @throws {RequiredError} */ info: (options?: RawAxiosRequestConfig) => Promise; /** * Get status of zklighter * @summary status * @param {*} [options] Override http request option. * @throws {RequiredError} */ status: (options?: RawAxiosRequestConfig) => Promise; }; /** * RootApi - functional programming interface */ export declare const RootApiFp: (configuration?: Configuration) => { /** * Get info of zklighter * @summary info * @param {*} [options] Override http request option. * @throws {RequiredError} */ info(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get status of zklighter * @summary status * @param {*} [options] Override http request option. * @throws {RequiredError} */ status(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RootApi - factory interface */ export declare const RootApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get info of zklighter * @summary info * @param {*} [options] Override http request option. * @throws {RequiredError} */ info(options?: RawAxiosRequestConfig): AxiosPromise; /** * Get status of zklighter * @summary status * @param {*} [options] Override http request option. * @throws {RequiredError} */ status(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * RootApi - object-oriented interface */ export declare class RootApi extends BaseAPI { /** * Get info of zklighter * @summary info * @param {*} [options] Override http request option. * @throws {RequiredError} */ info(options?: RawAxiosRequestConfig): Promise>; /** * Get status of zklighter * @summary status * @param {*} [options] Override http request option. * @throws {RequiredError} */ status(options?: RawAxiosRequestConfig): Promise>; } /** * TransactionApi - axios parameter creator */ export declare const TransactionApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get transactions of a specific account * @summary accountTxs * @param {number} limit * @param {AccountTxsByEnum} by * @param {string} value * @param {string} [authorization] * @param {number} [index] * @param {Array} [types] * @param {string} [auth] * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountTxs: (limit: number, by: AccountTxsByEnum, value: string, authorization?: string, index?: number, types?: Array, auth?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get transactions in a block * @summary blockTxs * @param {BlockTxsByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ blockTxs: (by: BlockTxsByEnum, value: string, options?: RawAxiosRequestConfig) => Promise; /** * Get deposit history * @summary deposit_history * @param {number} accountIndex * @param {string} l1Address * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {string} [cursor] * @param {DepositHistoryFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ depositHistory: (accountIndex: number, l1Address: string, authorization?: string, auth?: string, cursor?: string, filter?: DepositHistoryFilterEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get next nonce for a specific account and api key * @summary nextNonce * @param {number} accountIndex * @param {number} apiKeyIndex * @param {*} [options] Override http request option. * @throws {RequiredError} */ nextNonce: (accountIndex: number, apiKeyIndex: number, options?: RawAxiosRequestConfig) => Promise; /** * You need to sign the transaction body before sending it to the server. More details can be found in the Get Started docs: [Get Started For Programmers](https://apidocs.lighter.xyz/docs/get-started-for-programmers) * @summary sendTx * @param {number} txType * @param {string} txInfo * @param {boolean} [priceProtection] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendTx: (txType: number, txInfo: string, priceProtection?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * You need to sign the transaction body before sending it to the server. More details can be found in the Get Started docs: [Get Started For Programmers](https://apidocs.lighter.xyz/docs/get-started-for-programmers) * @summary sendTxBatch * @param {string} txTypes * @param {string} txInfos * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendTxBatch: (txTypes: string, txInfos: string, options?: RawAxiosRequestConfig) => Promise; /** * Get transfer history * @summary transfer_history * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {string} [cursor] * @param {*} [options] Override http request option. * @throws {RequiredError} */ transferHistory: (accountIndex: number, authorization?: string, auth?: string, cursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get transaction by hash or sequence index * @summary tx * @param {TxByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ tx: (by: TxByEnum, value: string, options?: RawAxiosRequestConfig) => Promise; /** * Get L1 transaction by L1 transaction hash * @summary txFromL1TxHash * @param {string} hash * @param {*} [options] Override http request option. * @throws {RequiredError} */ txFromL1TxHash: (hash: string, options?: RawAxiosRequestConfig) => Promise; /** * Get transactions which are already packed into blocks * @summary txs * @param {number} limit * @param {number} [index] * @param {*} [options] Override http request option. * @throws {RequiredError} */ txs: (limit: number, index?: number, options?: RawAxiosRequestConfig) => Promise; /** * Get withdraw history * @summary withdraw_history * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {string} [cursor] * @param {WithdrawHistoryFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ withdrawHistory: (accountIndex: number, authorization?: string, auth?: string, cursor?: string, filter?: WithdrawHistoryFilterEnum, options?: RawAxiosRequestConfig) => Promise; }; /** * TransactionApi - functional programming interface */ export declare const TransactionApiFp: (configuration?: Configuration) => { /** * Get transactions of a specific account * @summary accountTxs * @param {number} limit * @param {AccountTxsByEnum} by * @param {string} value * @param {string} [authorization] * @param {number} [index] * @param {Array} [types] * @param {string} [auth] * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountTxs(limit: number, by: AccountTxsByEnum, value: string, authorization?: string, index?: number, types?: Array, auth?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get transactions in a block * @summary blockTxs * @param {BlockTxsByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ blockTxs(by: BlockTxsByEnum, value: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get deposit history * @summary deposit_history * @param {number} accountIndex * @param {string} l1Address * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {string} [cursor] * @param {DepositHistoryFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ depositHistory(accountIndex: number, l1Address: string, authorization?: string, auth?: string, cursor?: string, filter?: DepositHistoryFilterEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get next nonce for a specific account and api key * @summary nextNonce * @param {number} accountIndex * @param {number} apiKeyIndex * @param {*} [options] Override http request option. * @throws {RequiredError} */ nextNonce(accountIndex: number, apiKeyIndex: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * You need to sign the transaction body before sending it to the server. More details can be found in the Get Started docs: [Get Started For Programmers](https://apidocs.lighter.xyz/docs/get-started-for-programmers) * @summary sendTx * @param {number} txType * @param {string} txInfo * @param {boolean} [priceProtection] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendTx(txType: number, txInfo: string, priceProtection?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * You need to sign the transaction body before sending it to the server. More details can be found in the Get Started docs: [Get Started For Programmers](https://apidocs.lighter.xyz/docs/get-started-for-programmers) * @summary sendTxBatch * @param {string} txTypes * @param {string} txInfos * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendTxBatch(txTypes: string, txInfos: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get transfer history * @summary transfer_history * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {string} [cursor] * @param {*} [options] Override http request option. * @throws {RequiredError} */ transferHistory(accountIndex: number, authorization?: string, auth?: string, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get transaction by hash or sequence index * @summary tx * @param {TxByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ tx(by: TxByEnum, value: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get L1 transaction by L1 transaction hash * @summary txFromL1TxHash * @param {string} hash * @param {*} [options] Override http request option. * @throws {RequiredError} */ txFromL1TxHash(hash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get transactions which are already packed into blocks * @summary txs * @param {number} limit * @param {number} [index] * @param {*} [options] Override http request option. * @throws {RequiredError} */ txs(limit: number, index?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get withdraw history * @summary withdraw_history * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {string} [cursor] * @param {WithdrawHistoryFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ withdrawHistory(accountIndex: number, authorization?: string, auth?: string, cursor?: string, filter?: WithdrawHistoryFilterEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TransactionApi - factory interface */ export declare const TransactionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get transactions of a specific account * @summary accountTxs * @param {number} limit * @param {AccountTxsByEnum} by * @param {string} value * @param {string} [authorization] * @param {number} [index] * @param {Array} [types] * @param {string} [auth] * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountTxs(limit: number, by: AccountTxsByEnum, value: string, authorization?: string, index?: number, types?: Array, auth?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get transactions in a block * @summary blockTxs * @param {BlockTxsByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ blockTxs(by: BlockTxsByEnum, value: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get deposit history * @summary deposit_history * @param {number} accountIndex * @param {string} l1Address * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {string} [cursor] * @param {DepositHistoryFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ depositHistory(accountIndex: number, l1Address: string, authorization?: string, auth?: string, cursor?: string, filter?: DepositHistoryFilterEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get next nonce for a specific account and api key * @summary nextNonce * @param {number} accountIndex * @param {number} apiKeyIndex * @param {*} [options] Override http request option. * @throws {RequiredError} */ nextNonce(accountIndex: number, apiKeyIndex: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * You need to sign the transaction body before sending it to the server. More details can be found in the Get Started docs: [Get Started For Programmers](https://apidocs.lighter.xyz/docs/get-started-for-programmers) * @summary sendTx * @param {number} txType * @param {string} txInfo * @param {boolean} [priceProtection] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendTx(txType: number, txInfo: string, priceProtection?: boolean, options?: RawAxiosRequestConfig): AxiosPromise; /** * You need to sign the transaction body before sending it to the server. More details can be found in the Get Started docs: [Get Started For Programmers](https://apidocs.lighter.xyz/docs/get-started-for-programmers) * @summary sendTxBatch * @param {string} txTypes * @param {string} txInfos * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendTxBatch(txTypes: string, txInfos: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get transfer history * @summary transfer_history * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {string} [cursor] * @param {*} [options] Override http request option. * @throws {RequiredError} */ transferHistory(accountIndex: number, authorization?: string, auth?: string, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get transaction by hash or sequence index * @summary tx * @param {TxByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ tx(by: TxByEnum, value: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get L1 transaction by L1 transaction hash * @summary txFromL1TxHash * @param {string} hash * @param {*} [options] Override http request option. * @throws {RequiredError} */ txFromL1TxHash(hash: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get transactions which are already packed into blocks * @summary txs * @param {number} limit * @param {number} [index] * @param {*} [options] Override http request option. * @throws {RequiredError} */ txs(limit: number, index?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get withdraw history * @summary withdraw_history * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {string} [cursor] * @param {WithdrawHistoryFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ withdrawHistory(accountIndex: number, authorization?: string, auth?: string, cursor?: string, filter?: WithdrawHistoryFilterEnum, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * TransactionApi - object-oriented interface */ export declare class TransactionApi extends BaseAPI { /** * Get transactions of a specific account * @summary accountTxs * @param {number} limit * @param {AccountTxsByEnum} by * @param {string} value * @param {string} [authorization] * @param {number} [index] * @param {Array} [types] * @param {string} [auth] * @param {*} [options] Override http request option. * @throws {RequiredError} */ accountTxs(limit: number, by: AccountTxsByEnum, value: string, authorization?: string, index?: number, types?: Array, auth?: string, options?: RawAxiosRequestConfig): Promise>; /** * Get transactions in a block * @summary blockTxs * @param {BlockTxsByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ blockTxs(by: BlockTxsByEnum, value: string, options?: RawAxiosRequestConfig): Promise>; /** * Get deposit history * @summary deposit_history * @param {number} accountIndex * @param {string} l1Address * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {string} [cursor] * @param {DepositHistoryFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ depositHistory(accountIndex: number, l1Address: string, authorization?: string, auth?: string, cursor?: string, filter?: DepositHistoryFilterEnum, options?: RawAxiosRequestConfig): Promise>; /** * Get next nonce for a specific account and api key * @summary nextNonce * @param {number} accountIndex * @param {number} apiKeyIndex * @param {*} [options] Override http request option. * @throws {RequiredError} */ nextNonce(accountIndex: number, apiKeyIndex: number, options?: RawAxiosRequestConfig): Promise>; /** * You need to sign the transaction body before sending it to the server. More details can be found in the Get Started docs: [Get Started For Programmers](https://apidocs.lighter.xyz/docs/get-started-for-programmers) * @summary sendTx * @param {number} txType * @param {string} txInfo * @param {boolean} [priceProtection] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendTx(txType: number, txInfo: string, priceProtection?: boolean, options?: RawAxiosRequestConfig): Promise>; /** * You need to sign the transaction body before sending it to the server. More details can be found in the Get Started docs: [Get Started For Programmers](https://apidocs.lighter.xyz/docs/get-started-for-programmers) * @summary sendTxBatch * @param {string} txTypes * @param {string} txInfos * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendTxBatch(txTypes: string, txInfos: string, options?: RawAxiosRequestConfig): Promise>; /** * Get transfer history * @summary transfer_history * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {string} [cursor] * @param {*} [options] Override http request option. * @throws {RequiredError} */ transferHistory(accountIndex: number, authorization?: string, auth?: string, cursor?: string, options?: RawAxiosRequestConfig): Promise>; /** * Get transaction by hash or sequence index * @summary tx * @param {TxByEnum} by * @param {string} value * @param {*} [options] Override http request option. * @throws {RequiredError} */ tx(by: TxByEnum, value: string, options?: RawAxiosRequestConfig): Promise>; /** * Get L1 transaction by L1 transaction hash * @summary txFromL1TxHash * @param {string} hash * @param {*} [options] Override http request option. * @throws {RequiredError} */ txFromL1TxHash(hash: string, options?: RawAxiosRequestConfig): Promise>; /** * Get transactions which are already packed into blocks * @summary txs * @param {number} limit * @param {number} [index] * @param {*} [options] Override http request option. * @throws {RequiredError} */ txs(limit: number, index?: number, options?: RawAxiosRequestConfig): Promise>; /** * Get withdraw history * @summary withdraw_history * @param {number} accountIndex * @param {string} [authorization] make required after integ is done * @param {string} [auth] made optional to support header auth clients * @param {string} [cursor] * @param {WithdrawHistoryFilterEnum} [filter] * @param {*} [options] Override http request option. * @throws {RequiredError} */ withdrawHistory(accountIndex: number, authorization?: string, auth?: string, cursor?: string, filter?: WithdrawHistoryFilterEnum, options?: RawAxiosRequestConfig): Promise>; } export declare const AccountTxsByEnum: { readonly AccountIndex: "account_index"; }; export type AccountTxsByEnum = typeof AccountTxsByEnum[keyof typeof AccountTxsByEnum]; export declare const BlockTxsByEnum: { readonly BlockHeight: "block_height"; readonly BlockCommitment: "block_commitment"; }; export type BlockTxsByEnum = typeof BlockTxsByEnum[keyof typeof BlockTxsByEnum]; export declare const DepositHistoryFilterEnum: { readonly All: "all"; readonly Pending: "pending"; readonly Claimable: "claimable"; }; export type DepositHistoryFilterEnum = typeof DepositHistoryFilterEnum[keyof typeof DepositHistoryFilterEnum]; export declare const TxByEnum: { readonly Hash: "hash"; readonly SequenceIndex: "sequence_index"; }; export type TxByEnum = typeof TxByEnum[keyof typeof TxByEnum]; export declare const WithdrawHistoryFilterEnum: { readonly All: "all"; readonly Pending: "pending"; readonly Claimable: "claimable"; }; export type WithdrawHistoryFilterEnum = typeof WithdrawHistoryFilterEnum[keyof typeof WithdrawHistoryFilterEnum]; //# sourceMappingURL=api.d.ts.map