Skip to main content
GET
WebSocket stream of live trades, activities and conversions

Authorizations

Authorization
string
header
required

Raw database-backed API key.

Query Parameters

wallet
string

Up to 100 comma-separated 0x-prefixed 20-byte addresses to seed the wallet filter. Usernames are not accepted. Use filter.add for larger sets.

market
string

Up to 100 comma-separated condition ids (0x + 64 hex) or decimal CLOB token ids. Market slugs and category: selectors are not supported. A condition id selects both outcomes; a token id selects one.

streams
string

Comma-separated subset of trades, activities, conversions. Defaults to all three. Fixed for the life of the connection.

mempool
boolean

Opt in to unconfirmed mempool trades in addition to confirmed ones. Requires the trades stream.

api_key
string

API key, for clients that cannot set request headers on a WebSocket handshake. The Authorization header takes precedence and should be preferred; this value is redacted from access logs and usage records.

Response

The handshake succeeded and the socket is open; the server sends welcome first. There is no HTTP response body — the schema below is the union of the JSON frames the server then pushes, discriminated by type.

One frame the transaction stream sends. These are WebSocket text frames on an open socket, not HTTP response bodies. type is the discriminator and the only field a client dispatches on.

type
enum<string>
required
Available options:
welcome
server_time
string<date-time>
required
streams
enum<string>[]
required

The streams this connection will receive, in a fixed order. Reflects ?streams=, which defaults to all three.

Available options:
trades,
activities,
conversions
mempool
boolean
required

Whether unconfirmed mempool trades are included.

filters
object
required

Sizes of a connection's filter sets. Counts rather than values: a client may hold tens of thousands of entries, and an acknowledgement should not echo them all back.

Example:
limits
object
required

The caps this connection works within, reported on welcome so a client can batch correctly instead of discovering them by rejection.

Example:
source
object
required

Upstream feed health, on welcome and heartbeat frames.

Example:
sequence
integer<int64>

The server-global ordinal at connect time. Absent when the server has not decoded any upstream message yet.