Crate maxt
Expand description
A common Rust API for Upbit, Bithumb, Binance, and Hyperliquid.
Client exposes operations with common semantics. Exchange-specific
operations remain on the concrete types in adapters, and unavailable
operations return Error::Unsupported.
§Quick start: Binance Spot
Pick an adapter, wrap it in a Client, and call the common API. This
credential-free example reads Binance Spot BTC/USDT; it does not submit
an order.
use maxt::{Client, Exchange, Market, adapters::BinanceAdapter};
let client = Client::new(BinanceAdapter::spot());
let market = Market::spot(Exchange::Binance, "BTC", "USDT");
let ticker = client.ticker(&market).await?;
let average = client.adapter().spot_average_price(&market).await?;
println!("last price: {}", ticker.last_price);
println!("{}-minute average: {}", average.minutes, average.price);Client::ticker is a common operation. [BinanceAdapter::spot_average_price]
is a provider-specific operation, so it remains on Client::adapter.
Public market data needs no credentials. Account and order operations do;
each adapter documents the credential form it accepts.
§Supported adapter boundaries
BinanceAdapter: Spot and USD-M perpetual futures.UpbitAdapter: Spot across its supported regions.BithumbAdapter: Spot and KRW account APIs.HyperliquidAdapter: Spot and perpetual futures.
Provider-only fields and endpoints remain on the concrete adapter. Check
Client::supports before an optional common operation when the configured
adapter or its credentials can vary at runtime.
§Main types
Client: common market-data, account, order, and derivatives operations.adapters: exchange constructors and exchange-specific operations.Feature: capabilities reported byClient::supports.Error: validation, capability, authentication, exchange, transport, and decoding failures.
Re-exports§
pub use adapters::BinanceAccountStream;pub use adapters::BinanceAccountStreamEvent;pub use adapters::BinanceAccountTrade;pub use adapters::BinanceAggregateTrade;pub use adapters::BinanceAggregateTradesRequest;pub use adapters::BinanceApiKeyPermissions;pub use adapters::BinanceBalanceStreamEvent;pub use adapters::BinanceC2cTrade;pub use adapters::BinanceC2cTradeHistoryPage;pub use adapters::BinanceC2cTradeHistoryRequest;pub use adapters::BinanceC2cTradeType;pub use adapters::BinanceCandleEvent;pub use adapters::BinanceCoinInformation;pub use adapters::BinanceCoinNetworkInformation;pub use adapters::BinanceDepositHistory;pub use adapters::BinanceDepositHistoryEntry;pub use adapters::BinanceDepositHistoryRequest;pub use adapters::BinanceExchangeInfo;pub use adapters::BinanceExchangeSymbol;pub use adapters::BinanceMarkPrice;pub use adapters::BinanceMarketEvent;pub use adapters::BinanceMarketStream;pub use adapters::BinanceOpenInterest;pub use adapters::BinanceOrderBookEvent;pub use adapters::BinanceOrderResponse;pub use adapters::BinanceOrderStreamEvent;pub use adapters::BinanceQuestionnaireRequirements;pub use adapters::BinanceRawAccountEvent;pub use adapters::BinanceSpotAccountBalance;pub use adapters::BinanceSpotAccountInformation;pub use adapters::BinanceSpotAveragePrice;pub use adapters::BinanceSpotCancelAllOpenOrders;pub use adapters::BinanceSpotCancelledOrder;pub use adapters::BinanceSpotCommissionRates;pub use adapters::BinanceTestOrder;pub use adapters::BinanceTestOrderRequest;pub use adapters::BinanceTickerEvent;pub use adapters::BinanceTradeEvent;pub use adapters::BinanceUsdMAccountAsset;pub use adapters::BinanceUsdMAccountInformation;pub use adapters::BinanceUsdMAccountPosition;pub use adapters::BinanceUsdMPositionInformation;pub use adapters::BinanceWithdrawHistory;pub use adapters::BinanceWithdrawHistoryEntry;pub use adapters::BinanceWithdrawHistoryRequest;pub use adapters::BinanceWithdrawalAddress;pub use adapters::BithumbAccountEvent;pub use adapters::BithumbAccountStream;pub use adapters::BithumbApiKey;pub use adapters::BithumbAssetEvent;pub use adapters::BithumbAssetFee;pub use adapters::BithumbBatchOrder;pub use adapters::BithumbBatchOrderFailure;pub use adapters::BithumbBatchOrderOutcome;pub use adapters::BithumbBatchOrdersRequest;pub use adapters::BithumbBatchOrdersResult;pub use adapters::BithumbCancelOrderResponse;pub use adapters::BithumbCancelOrdersResponse;pub use adapters::BithumbCancelWithdrawalResponse;pub use adapters::BithumbClosedOrder;pub use adapters::BithumbClosedOrderState;pub use adapters::BithumbClosedOrdersRequest;pub use adapters::BithumbDepositResponse;pub use adapters::BithumbKrwDeposit;pub use adapters::BithumbKrwDepositsRequest;pub use adapters::BithumbKrwTransferRequest;pub use adapters::BithumbKrwWithdrawal;pub use adapters::BithumbKrwWithdrawalsRequest;pub use adapters::BithumbMarketEvent;pub use adapters::BithumbMarketStream;pub use adapters::BithumbNetworkFee;pub use adapters::BithumbNotice;pub use adapters::BithumbOrderBookEvent;pub use adapters::BithumbOrderBookSnapshot;pub use adapters::BithumbOrderDetail;pub use adapters::BithumbOrderDetailRequest;pub use adapters::BithumbOrderDetailTrade;pub use adapters::BithumbOrderDirection;pub use adapters::BithumbOrderEvent;pub use adapters::BithumbOrderListItem;pub use adapters::BithumbOrderListRequest;pub use adapters::BithumbOrderListState;pub use adapters::BithumbOrderResponse;pub use adapters::BithumbOrdersResponse;pub use adapters::BithumbPendingOrderState;pub use adapters::BithumbPendingOrdersRequest;pub use adapters::BithumbTickerEvent;pub use adapters::BithumbTradeEvent;pub use adapters::BithumbTwapOrder;pub use adapters::BithumbTwapOrderDirection;pub use adapters::BithumbTwapOrderRequest;pub use adapters::BithumbTwapOrdersRequest;pub use adapters::BithumbTwapState;pub use adapters::BithumbWithdrawalAddress;pub use adapters::BithumbWithdrawalResponse;pub use adapters::HyperliquidAccountEvent;pub use adapters::HyperliquidAccountStream;pub use adapters::HyperliquidAllMids;pub use adapters::HyperliquidAssetContext;pub use adapters::HyperliquidAssetContextEvent;pub use adapters::HyperliquidBookLevel;pub use adapters::HyperliquidCandleEvent;pub use adapters::HyperliquidCandleSnapshot;pub use adapters::HyperliquidDailyVolume;pub use adapters::HyperliquidEvmContract;pub use adapters::HyperliquidFundingHistoryEntry;pub use adapters::HyperliquidL2Book;pub use adapters::HyperliquidMarketEvent;pub use adapters::HyperliquidMarketStream;pub use adapters::HyperliquidMidPrice;pub use adapters::HyperliquidOpenOrder;pub use adapters::HyperliquidOrderActionResponse;pub use adapters::HyperliquidOrderBookEvent;pub use adapters::HyperliquidOrderDetail;pub use adapters::HyperliquidOrderInfo;pub use adapters::HyperliquidOrderReference;pub use adapters::HyperliquidOrderStatusResponse;pub use adapters::HyperliquidOrderUpdate;pub use adapters::HyperliquidPortfolioPeriod;pub use adapters::HyperliquidPortfolioPoint;pub use adapters::HyperliquidProviderResponse;pub use adapters::HyperliquidRecentTrade;pub use adapters::HyperliquidReferral;pub use adapters::HyperliquidReferrer;pub use adapters::HyperliquidSpotAssetContext;pub use adapters::HyperliquidSpotBalance;pub use adapters::HyperliquidSpotClearinghouseState;pub use adapters::HyperliquidSpotMeta;pub use adapters::HyperliquidSpotMetaAndAssetContexts;pub use adapters::HyperliquidSpotPair;pub use adapters::HyperliquidSpotStateBalance;pub use adapters::HyperliquidSpotStateEvent;pub use adapters::HyperliquidSpotToken;pub use adapters::HyperliquidSubAccount;pub use adapters::HyperliquidTradeEvent;pub use adapters::HyperliquidUserFees;pub use adapters::HyperliquidUserFill;pub use adapters::HyperliquidUserFunding;pub use adapters::HyperliquidUserRateLimit;pub use adapters::HyperliquidUserRole;pub use adapters::HyperliquidVaultEquity;pub use adapters::UpbitAccountStream;pub use adapters::UpbitAccountStreamEvent;pub use adapters::UpbitApiKey;pub use adapters::UpbitAssetStreamEvent;pub use adapters::UpbitBatchCancelRequest;pub use adapters::UpbitBatchCancelScope;pub use adapters::UpbitCancelAndNewOrder;pub use adapters::UpbitCancelAndNewOrderDetailResult;pub use adapters::UpbitCancelAndNewOrderRequest;pub use adapters::UpbitCancelAndNewOrderResult;pub use adapters::UpbitCancelOrdersResponse;pub use adapters::UpbitCancelWithdrawalResponse;pub use adapters::UpbitCandleStreamEvent;pub use adapters::UpbitClosedOrder;pub use adapters::UpbitClosedOrderState;pub use adapters::UpbitClosedOrdersRequest;pub use adapters::UpbitDepositInfo;pub use adapters::UpbitDepositResponse;pub use adapters::UpbitKrwDeposit;pub use adapters::UpbitKrwTransferRequest;pub use adapters::UpbitKrwTwoFactorType;pub use adapters::UpbitKrwWithdrawal;pub use adapters::UpbitListedSubscription;pub use adapters::UpbitMarketEvent;pub use adapters::UpbitMarketStream;pub use adapters::UpbitMarketStreamEvent;pub use adapters::UpbitOrderBookInstrument;pub use adapters::UpbitOrderBookStreamEvent;pub use adapters::UpbitOrderDetail;pub use adapters::UpbitOrderDetailRequest;pub use adapters::UpbitOrderDetailTrade;pub use adapters::UpbitOrderDirection;pub use adapters::UpbitOrderReference;pub use adapters::UpbitOrderResponse;pub use adapters::UpbitOrderStreamEvent;pub use adapters::UpbitOrderVolume;pub use adapters::UpbitPocket;pub use adapters::UpbitPocketApiKey;pub use adapters::UpbitPocketApiKeyGroup;pub use adapters::UpbitPocketApiKeysRequest;pub use adapters::UpbitPocketBalance;pub use adapters::UpbitPocketTransfer;pub use adapters::UpbitPocketTransferDirection;pub use adapters::UpbitPocketTransferOrder;pub use adapters::UpbitPocketTransferQuery;pub use adapters::UpbitPocketTransferRequest;pub use adapters::UpbitPocketTransferState;pub use adapters::UpbitPocketUniversalTransferRequest;pub use adapters::UpbitSmpType;pub use adapters::UpbitSubscriptionList;pub use adapters::UpbitTickerStreamEvent;pub use adapters::UpbitTradeStreamEvent;pub use adapters::UpbitTravelRuleVasp;pub use adapters::UpbitTravelRuleVerification;pub use adapters::UpbitWithdrawalAddress;pub use adapters::UpbitWithdrawalResponse;pub use adapters::UpbitYearCandle;
Modules§
- adapters
- Exchange adapter implementations.
Structs§
- Account
Stream - A live private account subscription.
- Asset
Network - One asset’s transfer rules on one exchange network.
- Balance
- How much of one asset an account reports as available and locked.
- Cancel
Orders Request - Orders to cancel by one identifier namespace.
- Cancel
Orders Result - Per-order outcome of one non-atomic batch cancellation request.
- Cancelled
Order - One order an exchange accepted for cancellation in a batch request.
- Candle
- One open-high-low-close-volume (OHLCV) candle.
- Candle
Request - Which candles to read.
- Chain
Destination - A direct on-chain destination that was not issued by an exchange API.
- Chain
Transfer Request - Inputs for a checked transfer to an explicit on-chain destination.
- Client
- The common API over one exchange adapter.
- Cursor
- An opaque position in a paginated history.
- Decimal
- The exact decimal type used for every price, quantity, and amount.
- Deposit
- A deposit reported by the destination exchange.
- Deposit
Address - A deposit address issued by a centralized exchange.
- Deposit
Address Entry - One exchange-issued deposit address returned by an account-wide listing.
- Deposit
Address Request - Selects one deposit address for an asset and network.
- Exchange
Destination - An exchange-issued destination ready to receive a withdrawal.
- Exchange
Transfer Request - Inputs for a checked transfer between two exchange clients.
- Funding
Payment - One funding payment actually charged to or credited to an account.
- Funding
Rate - One funding rate observation for a perpetual market.
- History
Request - A window of history to read, one page at a time.
- Level
- One price level in an order book.
- Margin
Request - A change to how margin backs one market.
- Margin
Summary - Account-wide margin state.
- Market
- Identifies one tradable market on one exchange.
- Market
Info - One entry from
Client::markets. - Market
Stream - A live market data subscription.
- Order
- An order as the exchange currently reports it.
- Order
Account - Account values returned with dynamic order rules.
- Order
Book - An order book snapshot.
- Order
Cancel Failure - One order an exchange did not cancel in a batch request.
- Order
History Request - One newest-first page of completed or cancelled orders.
- Order
Lookup Request - Looks up up to 100 orders by one identifier namespace.
- Order
Option - One order type and time-in-force combination accepted by a market.
- Order
Request - An order to place.
- Order
Rules - Dynamic fees, limits, supported orders, and balances for one market.
- Page
- One page of a paginated history.
- Position
- An open derivatives position.
- Prepared
Transfer - A checked transfer plan tied to its source client.
- Stream
Config - How a live connection should behave when it degrades.
- Subscription
- What to subscribe to, across markets and feeds.
- Ticker
- A provider ticker summary for one market.
- Timestamp
- A point in time, as nanoseconds since the Unix epoch, UTC.
- Trade
- A single executed trade.
- Transfer
History Request - One page of deposit or withdrawal history.
- Transfer
Lookup Request - Identifies one deposit or withdrawal by the exchange UUID or transaction ID.
- Transfer
Plan - Data checked before a cross-exchange withdrawal is submitted.
- Wallet
- One asset on one exchange, optionally pinned to a network.
- Withdraw
Request - A withdrawal to an exchange-issued or direct on-chain destination.
- Withdrawal
- A withdrawal reported by the source exchange.
- Withdrawal
Quote - Live source-exchange checks performed before a withdrawal.
Enums§
- Account
Event - Something that arrived on a private account subscription.
- Deposit
Status - Current state of a deposit.
- Error
- Local request, adapter, authentication, exchange, transport, and decoding failures.
- Exchange
- An exchange
maxtcan talk to. - Exchange
Error Kind - How an exchange-side error classifies for retry purposes.
- Feature
- A capability an exchange may or may not offer.
- Feed
- A kind of live market data to subscribe to.
- Interval
- A candle interval.
- Margin
Mode - How margin backs a position.
- Market
Event - Something that arrived on a market data subscription.
- Market
Kind - What kind of instrument a market is.
- Market
Status - Common listing and trading status.
- Network
- A canonical blockchain network used to compare provider-specific names.
- Order
IdKind - Which identifier namespace to use for a multi-order lookup.
- Order
Status - Where an order stands.
- Order
Type - How an order is priced and matched.
- Overflow
- What a live connection does when its consumer falls behind.
- Side
- Which side of the book a trade or an order sits on.
- Size
- An order size expressed in either the base or quote asset.
- Time
InForce - How long an order stays live.
- Transfer
Destination - Where a withdrawal should arrive.
- Transfer
Error Kind - Why a transfer was rejected before a withdrawal was submitted.
- Travel
Rule Requirement - Whether a withdrawal needs a provider-specific Travel Rule step.
- Withdrawal
Fee - How an exchange calculates a withdrawal fee.
- Withdrawal
Status - Current state of a withdrawal request.
Traits§
Functions§
- execute_
transfer_ plan - Executes one checked transfer plan exactly once.
- parse_
decimal_ exact - Parses decimal text without rounding or truncating it.
- prepare_
chain_ transfer - Checks a source adapter and returns a plan for an explicit chain address.
- prepare_
exchange_ transfer - Checks both exchange adapters and returns a detached transfer plan.