reference-examples-websocket-gemini-asyncapi.yml.json

{"asyncapi":"3.1.0","info":{"title":"Gemini Market Data Websocket API","version":"1.0.0","description":"Market data is a public API that streams all the market data on a given symbol.\n\nYou can quickly play with the API using [websocat](https://github.com/vi/websocat#installation) like this:\n```bash\nwebsocat wss://api.gemini.com/v1/marketdata/btcusd?heartbeat=true -S\n```\n","contact":{"name":"Gemini","url":"https://www.gemini.com/"},"externalDocs":{"url":"https://docs.sandbox.gemini.com/websocket-api/#market-data"}},"servers":{"public":{"host":"api.gemini.com","protocol":"wss"}},"channels":{"marketDataV1":{"address":"/v1/marketdata/{symbol}","messages":{"marketData":{"$ref":"#/components/messages/marketData"}},"parameters":{"symbol":{"enum":["btcusd","ethbtc","ethusd","zecusd","zecbtc","zeceth","zecbch","zecltc","bchusd","bchbtc","bcheth","ltcusd","ltcbtc","ltceth","ltcbch","batusd","daiusd","linkusd","oxtusd","batbtc","linkbtc","oxtbtc","bateth","linketh","oxteth","ampusd","compusd","paxgusd","mkrusd","zrxusd","kncusd","manausd","storjusd","snxusd","crvusd","balusd","uniusd","renusd","umausd","yfiusd","btcdai","ethdai","aaveusd","filusd","btceur","btcgbp","etheur","ethgbp","btcsgd","ethsgd","sklusd","grtusd","bntusd","1inchusd","enjusd","lrcusd","sandusd","cubeusd","lptusd","bondusd","maticusd","injusd","sushiusd"],"description":"Symbols are formatted as CCY1CCY2 where prices are in CCY2 and quantities are in CCY1. To read more click [here](https://docs.sandbox.gemini.com/websocket-api/#symbols-and-minimums).\n"}},"bindings":{"ws":{"bindingVersion":"0.1.0","query":{"description":"The semantics of entry type filtering is:\n\nIf any entry type is specified as true or false, all of them must be explicitly flagged true to show up in the response\nIf no entry types filtering parameters are included in the url, then all entry types will appear in the response\n\nNOTE: top_of_book has no meaning and initial book events are empty when only trades is specified\n","properties":{"auctions":{"default":true,"description":"Include auction events","type":"boolean"},"bids":{"default":true,"description":"Include bids in change events","type":"boolean"},"heartbeat":{"default":false,"description":"Optionally add this parameter and set to true to receive a heartbeat every 5 seconds","type":"boolean"},"offers":{"default":true,"description":"Include asks in change events","type":"boolean"},"top_of_book":{"default":false,"description":"If absent or false, receive full order book depth; if present and true, receive top of book only. Only applies to bids and offers.","type":"boolean"},"trades":{"default":true,"description":"Include trade events","type":"boolean"}},"type":"object"}}}}},"operations":{"sendMarketData":{"action":"send","channel":{"$ref":"#/channels/marketDataV1"},"summary":"Receive market updates on a given symbol","messages":[{"$ref":"#/channels/marketDataV1/messages/marketData"}]}},"components":{"schemas":{"default":{"type":"object","required":["type","socket_sequence"],"properties":{"socket_sequence":{"type":"integer","description":"zero-indexed monotonic increasing sequence number attached to each message sent - if there is a gap in this sequence, you have missed a message. If you choose to enable heartbeats, then heartbeat and update messages will share a single increasing sequence. See [Sequence Numbers](https://docs.sandbox.gemini.com/websocket-api/#sequence-numbers) for more information."}},"description":"This object is always part of the payload. In case of type=heartbeat, these are the only fields."},"events":{"type":"array","items":{"type":"object","properties":{"delta":{"type":"number","description":"The quantity changed. May be negative, if an order is filled or canceled. For initial messages, delta will equal remaining."},"price":{"type":"number","multipleOf":1.0e-2,"description":"The price of this order book entry."},"reason":{"type":"string","enum":["place","trade","cancel","initial"],"description":"Indicates why the change has occurred. initial is for the initial response message, which will show the entire existing state of the order book."},"remaining":{"type":"number","description":"The quantity remaining at that price level after this change occurred. May be zero if all orders at this price level have been filled or canceled."},"side":{"type":"string","enum":["bid","side"]},"type":{"type":"string","enum":["trade","change","auction, block_trade"]}},"additionalProperties":false},"description":"Either a change to the order book, or the indication that a trade has occurred."},"heartbeat":{"allOf":[{"required":["type"],"properties":{"type":{"type":"string","const":"heartbeat"}}},{"$ref":"#/components/schemas/default"}]},"market":{"type":"object","oneOf":[{"$ref":"#/components/schemas/heartbeat"},{"$ref":"#/components/schemas/update"}]},"update":{"allOf":[{"required":["type","eventId","events","timestamp","timestampms"],"properties":{"eventId":{"type":"integer","description":"A monotonically increasing sequence number indicating when this change occurred. These numbers are persistent and consistent between market data connections."},"events":{"$ref":"#/components/schemas/events"},"timestamp":{"type":"number","description":"The timestamp in seconds for this group of events (included for compatibility reasons). We recommend using the timestampms field instead."},"timestampms":{"type":"number","description":"The timestamp in milliseconds for this group of events."},"type":{"type":"string","const":"update"}}},{"$ref":"#/components/schemas/default"}]}},"messages":{"marketData":{"payload":{"$ref":"#/components/schemas/market"},"summary":"Message with marked data information.","description":"The initial response message will show the existing state of the order book. Subsequent messages will show all executed trades, as well as all other changes to the order book from orders placed or canceled.\n","examples":[{"payload":{"eventId":36902233362,"events":[{"delta":2.0e-3,"price":54350.4,"reason":"place","remaining":2.0e-3,"side":"bid","type":"change"}],"socket_sequence":661,"timestamp":1619769673,"timestampms":1619769673527,"type":"update"},"name":"updateMessage","summary":"Example of an update message that contains a change in price information."},{"payload":{"socket_sequence":1656,"type":"heartbeat"},"name":"heartbeatMessage","summary":"Example of additional heartbeat message when you enable them."}]}}}}