How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Gemini WebSocket API

The production Gemini WebSocket API at wss://ws.gemini.com: request/response methods, market data streams (book ticker, partial and differential depth, trades), authenticated account streams for orders, balances and positions, prediction-market contract lifecycle, and combo RFQ messages. Published as AsyncAPI 3.0.0 with 21 channels and 22 operations.

This event API exposes 0 operations across 21 channels, and defines 84 schemas. It is described by AsyncAPI 3.0.0, at version 0.10.7.

The API connects through 2 servers: ws.gemini.com (wss), ws.sandbox.gemini.com (wss).

0 operations 21 channels 84 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 3.0.0
API Version
0.10.7
Base URL
wss://ws.gemini.com
Contact
Gemini API Support

Messages & Schemas 84

The contract defines 84 schemas that model the data carried by its messages. The most detailed are OrderUpdate (20 properties), RfqPublicEvent (12 properties), RfqPrivateDelivery (11 properties), OrderPlaceParams (9 properties). Each schema is shown below with its type and property counts.

ConninfoRequest
message
PingRequest
message
TimeRequest
message
SubscribeRequest
message
UnsubscribeRequest
message
ListSubscriptionsRequest
message
DepthRequest
message
OrderPlaceRequest
message
OrderCancelRequest
message
OrderCancelAllRequest
message
OrderCancelSessionRequest
message
RfqSubmitQuoteRequest
message
RfqWithdrawQuoteRequest
message
RfqConfirmQuoteRequest
message
GenericSuccessResponse
message
ListSubscriptionsResponse
message
DepthResponse
message
OrderActionResponse
message
RfqSubmitQuoteResponse
message
RfqWithdrawQuoteResponse
message
RfqConfirmQuoteResponse
message
ErrorResponse
message
BookTicker
message
OrderBookSnapshot
message
DepthUpdate
message
Trade
message
OrderUpdate
message
BalanceUpdate
message
PositionReport
message
ContractStatus
message
RfqPublicEvent
message
RfqPrivateDelivery
message
CorrelationId
object
Client-chosen id, echoed on the matching response.
NanosecondTimestamp
integer
Unix timestamp in nanoseconds. Values exceed JavaScript's safe integer range; JavaScript clients that need exact values should parse losslessly.
MillisecondTimestamp
integer
Unix timestamp in milliseconds.
DecimalString
string
Decimal value encoded as a string.
PriceLevel
array
[price, quantity] tuple; both values are decimal strings. A quantity of zero removes that price level in differential depth updates.
RequestBase
object
2 properties 2 required
ConninfoRequest
object
PingRequest
object
TimeRequest
object
SubscribeRequest
object
UnsubscribeRequest
object
ListSubscriptionsRequest
object
DepthRequest
object
OrderPlaceRequest
object
OrderCancelRequest
object
OrderCancelAllRequest
object
OrderCancelSessionRequest
object
RfqSubmitQuoteRequest
object
RfqWithdrawQuoteRequest
object
RfqConfirmQuoteRequest
object
ResponseBase
object
2 properties 2 required
GenericSuccessResponse
object
ListSubscriptionsResponse
object
DepthResponse
object
OrderActionResponse
object
RfqSubmitQuoteResponse
object
RfqWithdrawQuoteResponse
object
RfqConfirmQuoteResponse
object
ErrorResponse
object
WsError
object
2 properties 2 required
OrderPlaceParams
object
9 properties 5 required
OrderCancelParams
object
1 property 1 required
OrderBookSnapshot
object
Snapshot payload used by partial depth streams and the depth method.
3 properties 3 required
BookTicker
object
9 properties 7 required
DepthUpdate
object
L2 depth frame. With the snapshot connection parameter set — -1 for the full book, a positive N for the top N levels — the FIRST frame after subscribing is the…
7 properties 7 required
Trade
object
6 properties 6 required
OrderUpdate
object
Authenticated order lifecycle event. Fields with empty or zero values may be omitted from the event.
20 properties 6 required
BalanceUpdate
object
4 properties 4 required
Balance
object
3 properties 3 required
PositionReport
object
5 properties 5 required
PositionRow
object
3 properties 3 required
NamedAmount
object
4 properties 2 required
ContractStatus
object
9 properties 8 required
RfqClientId
string
Optional client order ID for tracking the maker fill. It is emitted as the fill event's c field. It must contain only printable ASCII characters and be at most…
RfqSubmitQuoteParams
object
5 properties 3 required
RfqWithdrawQuoteParams
object
2 properties 2 required
RfqConfirmQuoteParams
object
3 properties 3 required
RfqLeg
object
3 properties 2 required
RfqLifecycleState
string
RfqQuoteStatus
string
RfqPublicEvent
object
12 properties 5 required
RfqPrivateDelivery
object
11 properties 6 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

gemini-trust-websocket-asyncapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Gemini WebSocket API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.