GeminiGemini
SandboxGet API key
  • Crypto Trading
  • Prediction Markets
Changelog
Gemini Crypto Exchange LogoGemini Crypto Exchange Logo

© 2026 Gemini Space Station, Inc.

Getting Started
Market Makers
    Maker Rebate ProgramLiquidity Rewards Program
WebSocket
    IntroductionAuthenticationMessage Format
    Streams
      Book TickerL2 Partial DepthL2 Differential DepthTrade StreamOrder EventsBalance UpdatesPosition UpdatesContract Status
    Playground
      OverviewconninfopingtimeSUBSCRIBEUNSUBSCRIBELIST_SUBSCRIPTIONSdepthorder.placeorder.cancelorder.cancel_allorder.cancel_session
REST APIs
    Combos
    Events
    Terms
    Order Management
    Positions
    Rewards
Combo Contracts
    Overview
Tickers
    OverviewCryptoSportsCommoditiesWeather
SchemasAuthenticationMessage Format
Streams
    OverviewBook TickerL2 Partial DepthL2 Differential DepthTrade StreamOrder EventsBalance Updates
Utility
    conninfopingtime
Subscriptions
    subscribelist_subscriptionsunsubscribe
L2 Data
    depth
Trading
    order.cancel_sessionorder.placeorder.cancel_allorder.cancel
The browser playground supports public WebSocket methods and streams. Authenticated account streams and trading methods require Gemini authentication headers on the WebSocket upgrade, which browser WebSocket connections cannot send.

Utility(3 methods)

conninfo
disconnected

Get the connection rate limits.

Request
Response
Response will appear here...
ping
disconnected

Ping the server to check connectivity.

Request
Response
Response will appear here...
time
disconnected

Get the current server time in milliseconds since Unix epoch.

Request
Response
Response will appear here...

Subscriptions(3 methods)

SUBSCRIBE
disconnected

Subscribe to public data streams such as {symbol}@bookTicker. Account streams such as orders@account, balances@account, and positions@account require an authenticated WebSocket handshake outside the browser playground.

Parameters

NameTypeRequiredDescription
paramsarrayrequiredArray of stream names to subscribe to
Request
Response
Response will appear here...
UNSUBSCRIBE
disconnected

Unsubscribe from data streams.

Parameters

NameTypeRequiredDescription
paramsarrayrequiredArray of stream names to unsubscribe from
Request
Response
Response will appear here...
LIST_SUBSCRIPTIONS
disconnected

Get a list of all active stream subscriptions for the current connection.

Request
Response
Response will appear here...

L2 Data(1 method)

depth
disconnected

Get a snapshot of the order book depth for a prediction market symbol. Use [price, quantity] levels to compute notional dollars locally.

Parameters

NameTypeRequiredDescription
symbolstringrequiredPrediction market symbol (e.g., GEMI-BTC05M2606011000-UP)
limitnumberoptionalNumber of price levels to return (max: 5000)(default: 100)
Request
Response
Response will appear here...

Trading(4 methods)

order.placeAuth Required
disconnected

Place a new prediction market order. Requires authentication outside the browser playground. For a first quote, use LIMIT with MOC so the order rests or cancels instead of taking liquidity.

Browser WebSocket connections cannot send Gemini authentication headers during the upgrade. Copy this request into a non-browser client or use a server-side proxy for authenticated streams and trading methods.

Parameters

NameTypeRequiredDescription
symbolstringrequiredPrediction market symbol (e.g., GEMI-BTC05M2606011000-UP)
sidestringrequiredOrder side: BUY or SELL
typestringrequiredOrder type: LIMIT or MARKET. Use LIMIT with MOC time in force for maker-only quotes.
timeInForcestringrequiredTime in force: GTC (Good Till Cancel), IOC (Immediate or Cancel), FOK (Fill or Kill), MOC (Maker or Cancel). MOC cancels instead of taking liquidity.
pricestringoptionalOrder price between 0.01 and 0.99 (required for LIMIT orders)
quantitystringrequiredNumber of contracts
eventOutcomestringrequiredYES (predicting the event happens) or NO (predicting it doesn't)
clientOrderIdstringoptionalClient-provided order ID for tracking
Request
Response
Response will appear here...
order.cancelAuth Required
disconnected

Cancel an existing order by order ID.

Browser WebSocket connections cannot send Gemini authentication headers during the upgrade. Copy this request into a non-browser client or use a server-side proxy for authenticated streams and trading methods.

Parameters

NameTypeRequiredDescription
orderIdstringrequiredOrder ID to cancel (from the i field in order events)
Request
Response
Response will appear here...
order.cancel_allAuth Required
disconnected

Cancel all existing orders.

Browser WebSocket connections cannot send Gemini authentication headers during the upgrade. Copy this request into a non-browser client or use a server-side proxy for authenticated streams and trading methods.

Request
Response
Response will appear here...
order.cancel_sessionAuth Required
disconnected

Cancel all existing orders for the current session.

Browser WebSocket connections cannot send Gemini authentication headers during the upgrade. Copy this request into a non-browser client or use a server-side proxy for authenticated streams and trading methods.

Request
Response
Response will appear here...