Add Nado documentation and examples, including new API endpoints, FAQs, and guides for using the TypeScript SDK. Update .env.example with additional configuration options.

This commit is contained in:
discountry
2025-12-19 01:38:09 +08:00
parent 624fecfa70
commit c69ea72860
148 changed files with 17031 additions and 27 deletions
@@ -0,0 +1,33 @@
# Subscriptions
## Overview
To interact with the subscription API, send websocket messages to <mark style="color:red;">`WEBSOCKET [SUBSCRIPTIONS_ENDPOINT]`</mark>.
Subscription connections must set the `Sec-WebSocket-Extensions` header to include `permessage-deflate`.
## Endpoints
### Testnet:
* <mark style="color:red;">`wss://gateway.test.nado.xyz/v1/subscribe`</mark>
{% hint style="info" %}
**Note**: You must send ping frames every 30 seconds to keep the websocket connection alive.
{% endhint %}
{% content-ref url="subscriptions/authentication" %}
[authentication](https://docs.nado.xyz/developer-resources/api/subscriptions/authentication)
{% endcontent-ref %}
{% content-ref url="subscriptions/streams" %}
[streams](https://docs.nado.xyz/developer-resources/api/subscriptions/streams)
{% endcontent-ref %}
{% content-ref url="subscriptions/events" %}
[events](https://docs.nado.xyz/developer-resources/api/subscriptions/events)
{% endcontent-ref %}
{% content-ref url="subscriptions/rate-limits" %}
[rate-limits](https://docs.nado.xyz/developer-resources/api/subscriptions/rate-limits)
{% endcontent-ref %}