Macrosยง
- hex_id ๐
- Like
newtype_id!but addsIntoValidIdwith hex validation for&str/String, and a passthrough for the type itself. Keeps infallibleFromfor internal/serde use. - newtype_
id ๐
Structsยง
- Account
Response - Account response from GET /v1/accounts.
- Aggregated
Asset Info - Asset metadata from GET /v1/aggregated/assets.
- Aggregated
Orderbook - Aggregated orderbook from GET /v1/aggregated/orderbook.
- Aggregated
Ticker Data - Aggregated ticker value from GET /v1/aggregated/ticker.
- Aggregated
Trade - Trade from GET /v1/aggregated/trades.
- AssetId
- A hex asset ID.
- Balance
Entry - WebSocket balance entry.
- Balance
Response - Balance response from GET /v1/balance.
- Balance
Update - WebSocket balance update.
- Bar
- OHLCV bar/candle data.
- Cancel
Order Action - A CancelOrder action payload.
- Coingecko
Aggregated Orderbook - CoinGecko aggregated orderbook from GET /v1/aggregated/coingecko/orderbook.
- Contract
Id - A hex contract ID.
- Create
Account Response - Response from POST /v1/accounts (create account).
- Create
Order Action - A CreateOrder action payload.
- Depth
Level - A single depth level (price + quantity).
- Depth
Snapshot - Depth snapshot from GET /v1/depth or WebSocket subscribe_depth.
- Depth
Update - Depth update from WebSocket subscribe_depth_update.
- Faucet
Response - Response from faucet mint.
- Market
- A trading market.
- Market
Actions ๐ - A market-grouped set of actions.
- Market
Asset - Asset info within a market.
- Market
Id - A hex market ID.
- Market
Summary - Market summary from GET /v1/markets/summary.
- Market
Symbol - A market symbol pair like โFUEL/USDCโ.
- Market
Ticker - Market ticker from GET /v1/markets/ticker.
- Markets
Response - Top-level response from GET /v1/markets.
- Nonce
Update - WebSocket nonce update.
- Order
- An order from the API.
- Order
Book Balance - Order book balance entry.
- OrderId
- A hex order ID.
- Order
Update - WebSocket order update.
- Orders
Response - Response from GET /v1/orders.
- Pair
Summary - Pair summary from GET /v1/aggregated/summary.
- Pair
Ticker - Pair ticker from GET /v1/aggregated/coingecko/tickers.
- Price
- A market-bound human-readable order price.
- Quantity
- A market-bound human-readable order quantity.
- Referral
Info - Response from GET /analytics/v1/referral/code-info.
- Session
- Local session state tracked by the client.
- Session
Actions ๐Request - Request body for POST /v1/session/actions.
- Session
Actions Response - Response from POST /v1/session/actions.
- Session
Info - Session info within an account response.
- Session
Request - Request body for PUT /v1/session.
- Session
Response - Response from PUT /v1/session.
- Settle
Balance Action - A SettleBalance action payload.
- Trade
- A trade from the API.
- Trade
Account - Trading account info from GET /v1/accounts.
- Trade
Account Id - A hex trade account ID.
- TradeId
- A trade identifier.
- Trade
Update - WebSocket trade update.
- Trades
Response - Response from GET /v1/trades.
- TxId
- A hex transaction ID.
- TxResult
- Transaction result for simple operations (cancel, settle).
- Whitelist
Request - Request body for POST /analytics/v1/whitelist.
- Whitelist
Response - Response from POST /analytics/v1/whitelist.
- Withdraw
Request - Request body for POST /v1/accounts/withdraw.
- Withdraw
Response - Response from POST /v1/accounts/withdraw.
- WsMessage
- Generic WebSocket message for initial parsing.
Enumsยง
- Action
- High-level action for use with
batch_actions. - Action
Item - A single action in the actions request.
- Identity
- A Fuel Identity โ either an Address or a ContractId.
- Order
Price Input - Flexible input accepted by
O2Client::create_orderfor price values. - Order
Quantity Input - Flexible input accepted by
O2Client::create_orderfor quantity values. - Order
Type - High-level order type with associated data.
- Side
- Order side: Buy or Sell.
- Signature
- A signature wrapper.
- Trader
Side - The querying accountโs role in a trade.
Traitsยง
- Into
Market Symbol - Converts input into a validated, normalized
MarketSymbol. - Into
Valid Id - Trait for types that can be validated and converted into a hex ID newtype.
Implemented by
&str,String(with hex validation) and the ID type itself (passthrough).
Functionsยง
- deserialize_
optional_ ๐f64 - Deserialize an optional value that may be a JSON number or a string, storing as f64.
- deserialize_
optional_ ๐u64 - Deserialize an optional value that may be a JSON number or a string, storing as u64.
- deserialize_
string_ ๐or_ f64 - Deserialize a value that may be a JSON number or a string containing an f64.
- deserialize_
string_ ๐or_ u64 - Deserialize a value that may be a JSON number or a string containing a number.
- deserialize_
string_ ๐or_ u128 - Deserialize a value that may be a JSON number or a string containing a u128.
- normalize_
hex_ ๐prefixed - validate_
hex ๐
Type Aliasesยง
- Aggregated
Assets - Symbol-keyed assets map from GET /v1/aggregated/assets.
- Aggregated
Ticker - Pair-keyed map from GET /v1/aggregated/ticker.