Skip to main content

Module models

Module models 

Source
Expand description

HTTP response model types for the Coinbase Advanced Trade REST API.

Structsยง

Account
Coinbase account.
AccountsResponse
Response wrapper for listing accounts.
Balance
Balance amount.
BestBidAsk
Best bid/ask for a single product.
BestBidAskResponse
Response wrapper for best bid/ask.
BookLevel
A single price level in the order book.
CancelOrdersResponse
Response for batch cancel.
CancelResult
Result for a single order cancellation.
Candle
OHLCV candle data.
CandlesResponse
Response wrapper for candles.
CfmAmount
Monetary value with an explicit currency code.
CfmBalanceSummary
Coinbase FCM (futures) balance summary.
CfmBalanceSummaryResponse
Response for GET /api/v3/brokerage/cfm/balance_summary.
CfmMarginWindowMeasure
Margin window breakdown inside an FCM balance summary.
CfmPosition
Position on the Coinbase FCM venue.
CfmPositionResponse
Response for GET /api/v3/brokerage/cfm/positions/{product_id}.
CfmPositionsResponse
Response for GET /api/v3/brokerage/cfm/positions.
CreateOrderResponse
Response for creating an order.
EditOrderError
A single edit error entry returned by /orders/edit.
EditOrderResponse
Response for editing an order via /orders/edit.
FcmTradingSessionDetails
FCM trading session details for futures products.
Fill
A single fill (trade execution).
FillsResponse
Response for listing fills.
FutureProductDetails
Future product details.
MaintenanceWindow
Maintenance window for FCM sessions.
Order
A historical or open order as returned by /orders/historical/*.
OrderErrorResponse
Order creation error details.
OrderResponse
Response wrapper for a single order lookup.
OrderSuccessResponse
Successful order creation details.
OrdersListResponse
Response wrapper for an orders list query.
PerpetualDetails
Perpetual contract details.
PriceBook
Order book price levels.
Product
Coinbase product (trading pair).
ProductBookResponse
Response wrapper for the product order book.
ProductsResponse
Response wrapper for listing products.
TickerResponse
Response wrapper for ticker/market trades.
Trade
A single trade execution.