{ "openapi": "3.0.3", "info": { "title": "Coinbase Developer Platform Advanced Trading Collection", "version": "1.0.0", "contact": {} }, "servers": [ { "url": "https://api.coinbase.com" } ], "paths": { "/api/v3/brokerage/accounts": { "get": { "tags": [ "Accounts" ], "summary": "List Accounts", "description": "List Accounts", "operationId": "ListAccounts", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/accounts/{UUID-HERE}": { "get": { "tags": [ "Accounts" ], "summary": "Get Account", "description": "Get Account", "operationId": "GetAccount", "parameters": [ { "name": "UUID-HERE", "in": "path", "required": true, "description": "The UUID of the ", "schema": { "type": "string" }, "example": "00000000-0000-0000-0000-000000000000" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/best_bid_ask": { "get": { "tags": [ "Products" ], "summary": "Get Best Bid/Ask", "description": "Get Best Bid/Ask", "operationId": "GetBestBid/Ask", "parameters": [ { "name": "product_ids", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/product_book": { "get": { "tags": [ "Products" ], "summary": "Get Product Book", "description": "Get Product Book", "operationId": "GetProductBook", "parameters": [ { "name": "product_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "aggregation_price_increment", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/products": { "get": { "tags": [ "Products" ], "summary": "List Products", "description": "List Products", "operationId": "ListProducts", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/products/{ProductID-HERE}": { "get": { "tags": [ "Products" ], "summary": "Get Product", "description": "Get Product", "operationId": "GetProduct", "parameters": [ { "name": "ProductID-HERE", "in": "path", "required": true, "description": "The ID of the Product", "schema": { "type": "string" }, "example": "example-id" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/products/{ProductID-HERE}/candles": { "get": { "tags": [ "Products" ], "summary": "Get Product Candles", "description": "Get Product Candles", "operationId": "GetProductCandles", "parameters": [ { "name": "start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ProductID-HERE", "in": "path", "required": true, "description": "The ID of the Product", "schema": { "type": "string" }, "example": "example-id" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/products/BTC-USD": { "get": { "tags": [ "Products" ], "summary": "Get Market Trades", "description": "Get Market Trades", "operationId": "GetMarketTrades", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/orders": { "post": { "tags": [ "Orders" ], "summary": "Create Order", "description": "Create Order", "operationId": "CreateOrder", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v3/brokerage/orders/batch_cancel": { "post": { "tags": [ "Orders" ], "summary": "Cancel Orders", "description": "Cancel Orders", "operationId": "CancelOrders", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v3/brokerage/orders/edit": { "post": { "tags": [ "Orders" ], "summary": "Edit Order", "description": "Edit Order", "operationId": "EditOrder", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v3/brokerage/orders/edit_preview": { "post": { "tags": [ "Orders" ], "summary": "Edit Order Preview", "description": "Edit Order Preview", "operationId": "EditOrderPreview", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v3/brokerage/orders/historical/batch": { "get": { "tags": [ "Orders" ], "summary": "List Orders", "description": "List Orders", "operationId": "ListOrders", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/orders/historical/fills": { "get": { "tags": [ "Orders" ], "summary": "List Fills", "description": "List Fills", "operationId": "ListFills", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/orders/historical/{order_id}": { "get": { "tags": [ "Orders" ], "summary": "Get Order", "description": "Get Order", "operationId": "GetOrder", "parameters": [ { "name": "order_id", "in": "path", "required": true, "description": "The ID of the order", "schema": { "type": "string" }, "example": "example-id" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/orders/preview": { "post": { "tags": [ "Orders" ], "summary": "Preview Order", "description": "Preview Order", "operationId": "PreviewOrder", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v3/brokerage/orders/close_position": { "post": { "tags": [ "Orders" ], "summary": "Close Position", "description": "Close Position", "operationId": "ClosePosition", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v3/brokerage/portfolios": { "get": { "tags": [ "Portfolio" ], "summary": "List Portfolios", "description": "List Portfolios", "operationId": "ListPortfolios", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Portfolio" ], "summary": "Create Portfolio", "description": "Create Portfolio", "operationId": "CreatePortfolio", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v3/brokerage/portfolios/move_funds": { "post": { "tags": [ "Portfolio" ], "summary": "Move Portfolio Funds", "description": "Move Portfolio Funds", "operationId": "MovePortfolioFunds", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v3/brokerage/portfolios/{portfolioID-HERE}": { "get": { "tags": [ "Portfolio" ], "summary": "Get Portfolio Breakdown", "description": "Get Portfolio Breakdown", "operationId": "GetPortfolioBreakdown", "parameters": [ { "name": "portfolioID-HERE", "in": "path", "required": true, "description": "The ID of the portfolio", "schema": { "type": "string" }, "example": "example-id" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/portfolios/{portfolio_uuid}": { "delete": { "tags": [ "Portfolio" ], "summary": "Delete Portfolio", "description": "Delete Portfolio", "operationId": "DeletePortfolio", "parameters": [ { "name": "portfolio_uuid", "in": "path", "required": true, "description": "The UUID of the portfolio", "schema": { "type": "string" }, "example": "00000000-0000-0000-0000-000000000000" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Portfolio" ], "summary": "Edit Portfolio", "description": "Edit Portfolio", "operationId": "EditPortfolio", "parameters": [ { "name": "portfolio_uuid", "in": "path", "required": true, "description": "The UUID of the portfolio", "schema": { "type": "string" }, "example": "00000000-0000-0000-0000-000000000000" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/cfm/balance_summary": { "get": { "tags": [ "Portfolio" ], "summary": "Get Futures Balance Summary", "description": "Get Futures Balance Summary", "operationId": "GetFuturesBalanceSummary", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/cfm/intraday/margin_setting": { "get": { "tags": [ "Portfolio" ], "summary": "Get Intraday Margin Setting", "description": "Get Intraday Margin Setting", "operationId": "GetIntradayMarginSetting", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Portfolio" ], "summary": "Set Intraday Margin Setting", "description": "Set Intraday Margin Setting", "operationId": "SetIntradayMarginSetting", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v3/brokerage/cfm/intraday/current_margin_window": { "get": { "tags": [ "Portfolio" ], "summary": "Get Current Margin Window", "description": "Get Current Margin Window", "operationId": "GetCurrentMarginWindow", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/cfm/positions": { "get": { "tags": [ "Portfolio" ], "summary": "List Futures Positions", "description": "List Futures Positions", "operationId": "ListFuturesPositions", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/cfm/positions/{product_id}": { "get": { "tags": [ "Portfolio" ], "summary": "Get Futures Position", "description": "Get Futures Position", "operationId": "GetFuturesPosition", "parameters": [ { "name": "product_id", "in": "path", "required": true, "description": "The ID of the product", "schema": { "type": "string" }, "example": "example-id" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/cfm/sweeps/schedule": { "post": { "tags": [ "Portfolio" ], "summary": "Schedule Futures Sweep", "description": "Schedule Futures Sweep", "operationId": "ScheduleFuturesSweep", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v3/brokerage/cfm/sweeps": { "get": { "tags": [ "Portfolio" ], "summary": "List Futures Sweeps", "description": "List Futures Sweeps", "operationId": "ListFuturesSweeps", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Portfolio" ], "summary": "Cancel Pending Futures Sweep", "description": "Cancel Pending Futures Sweep", "operationId": "CancelPendingFuturesSweep", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/intx/allocate": { "post": { "tags": [ "Portfolio" ], "summary": "Allocate Portfolio", "description": "Allocate Portfolio", "operationId": "AllocatePortfolio", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v3/brokerage/intx/portfolio/{portfolio_uuid}": { "get": { "tags": [ "Portfolio" ], "summary": "Get Perpetuals Portfolio Summary", "description": "Get Perpetuals Portfolio Summary", "operationId": "GetPerpetualsPortfolioSummary", "parameters": [ { "name": "portfolio_uuid", "in": "path", "required": true, "description": "The UUID of the portfolio", "schema": { "type": "string" }, "example": "00000000-0000-0000-0000-000000000000" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/intx/positions/{portfolio_uuid}": { "get": { "tags": [ "Portfolio" ], "summary": "List Perpetuals Positions", "description": "List Perpetuals Positions", "operationId": "ListPerpetualsPositions", "parameters": [ { "name": "portfolio_uuid", "in": "path", "required": true, "description": "The UUID of the portfolio", "schema": { "type": "string" }, "example": "00000000-0000-0000-0000-000000000000" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/intx/positions/{portfolio_uuid}/{symbol}": { "get": { "tags": [ "Portfolio" ], "summary": "Get Perpetuals Position", "description": "Get Perpetuals Position", "operationId": "GetPerpetualsPosition", "parameters": [ { "name": "portfolio_uuid", "in": "path", "required": true, "description": "The UUID of the portfolio", "schema": { "type": "string" }, "example": "00000000-0000-0000-0000-000000000000" }, { "name": "symbol", "in": "path", "required": true, "description": "Trading symbol", "schema": { "type": "string" }, "example": "BTC-USD" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/intx/balances/{portfolio_uuid}": { "get": { "tags": [ "Portfolio" ], "summary": "Get Portfolios Balances", "description": "Get Portfolios Balances", "operationId": "GetPortfoliosBalances", "parameters": [ { "name": "portfolio_uuid", "in": "path", "required": true, "description": "The UUID of the portfolio", "schema": { "type": "string" }, "example": "00000000-0000-0000-0000-000000000000" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/intx/multi_asset_collateral": { "post": { "tags": [ "Portfolio" ], "summary": "Opt In or Out of Multi Asset Collateral", "description": "Opt In or Out of Multi Asset Collateral", "operationId": "OptInorOutofMultiAssetCollateral", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v3/brokerage/transaction_summary": { "get": { "tags": [ "Fees" ], "summary": "Get Transactions Summary", "description": "Get Transactions Summary", "operationId": "GetTransactionsSummary", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/convert/quote": { "post": { "tags": [ "Converts" ], "summary": "New Request", "description": "New Request", "operationId": "NewRequest", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v3/brokerage/convert/trade/{trade_id}": { "get": { "tags": [ "Converts" ], "summary": "Get Convert Trade", "description": "Get Convert Trade", "operationId": "GetConvertTrade", "parameters": [ { "name": "trade_id", "in": "path", "required": true, "description": "The ID of the trade", "schema": { "type": "string" }, "example": "example-id" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Converts" ], "summary": "Commit Convert Trade", "description": "Commit Convert Trade", "operationId": "CommitConvertTrade", "parameters": [ { "name": "trade_id", "in": "path", "required": true, "description": "The ID of the trade", "schema": { "type": "string" }, "example": "example-id" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v3/brokerage/time": { "get": { "tags": [ "Public" ], "summary": "Get Server Time", "description": "Get Server Time", "operationId": "GetServerTime", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/market/product_book": { "get": { "tags": [ "Public" ], "summary": "Get Public Product Book", "description": "Get Public Product Book", "operationId": "GetPublicProductBook", "parameters": [ { "name": "product_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "aggregation_price_increment", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/market/products": { "get": { "tags": [ "Public" ], "summary": "List Public Products", "description": "List Public Products", "operationId": "ListPublicProducts", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "product_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "contract_expiry_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "expiring_contract_status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "get_all_products", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/market/products/": { "get": { "tags": [ "Public" ], "summary": "Get Public Product", "description": "Get Public Product", "operationId": "GetPublicProduct", "parameters": [ { "name": "product_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/market/products/{product_id}/candles": { "get": { "tags": [ "Public" ], "summary": "Get Public Product Candles", "description": "Get Public Product Candles", "operationId": "GetPublicProductCandles", "parameters": [ { "name": "start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "product_id", "in": "path", "required": true, "description": "The ID of the product", "schema": { "type": "string" }, "example": "example-id" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/market/products/{product_id}/ticker": { "get": { "tags": [ "Public" ], "summary": "Get Public Market Trades", "description": "Get Public Market Trades", "operationId": "GetPublicMarketTrades", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "product_id", "in": "path", "required": true, "description": "The ID of the product", "schema": { "type": "string" }, "example": "example-id" } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/payment_methods": { "get": { "tags": [ "Payment Methods" ], "summary": "List Payment Methods", "description": "List Payment Methods", "operationId": "ListPaymentMethods", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/payment_methods/": { "get": { "tags": [ "Payment Methods" ], "summary": "Get Payment Method", "description": "Get Payment Method", "operationId": "GetPaymentMethod", "parameters": [ { "name": "payment_method_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v3/brokerage/key_permissions": { "get": { "tags": [ "Data" ], "summary": "Get API Key Permissions", "description": "Get API Key Permissions", "operationId": "GetAPIKeyPermissions", "parameters": [], "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } } }