> For the complete documentation index, see [llms.txt](https://docs.gyro.win/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gyro.win/product/gyrowin-api.md).

# Gyrowin API

Gyrowin API offers real-time draw data updates. Private-data messages can be subscribed on a specified authenticated endpoint.

Gyrowin API Link: <https://developer.gyro.win>

#### General Considerations

* All messages received via WebSockets are encoded in JSON format
* Timestamps should not be considered unique and not be considered as aliases for transaction IDs. Also, the granularity of timestamps is not representative of transaction rates.
* Websocket api connection has timeout of 20 minutes, where I/O is idle.
* Google cloud run service uses max 1 day timeout for maintenance and loadbalancer has the timeout of 3600 seconds, so please add a retry mechanism when the connection closes or for any unforseen circumstances.
* Recommended reconnection behaviour is to (1) attempt reconnection instantly up to a handful of times if the websocket is dropped randomly during normal operation but (2) after maintenance or extended downtime, attempt to reconnect no more quickly than once every 5 seconds. There is no advantage to reconnecting more rapidly after maintenance during cancel\_only mode.

### Resource Types

URIs are relative to wss\://api.gyro.win/v1/ws, unless otherwise noted.

{% hint style="info" %}
[Gyrowin APIs Terms of Service](/terms-and-policy/gyrowin-apis-terms-of-service.md)
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.gyro.win/product/gyrowin-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.