mirror of
https://github.com/discountry/ritmex-bot.git
synced 2026-09-10 00:38:07 +00:00
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:
@@ -0,0 +1,31 @@
|
||||
# API
|
||||
|
||||
## Overview
|
||||
|
||||
Nado's API is divided into the following categories:
|
||||
|
||||
1. A **websocket/REST** API (**gateway**) that supports writes (executes) and polling (queries).
|
||||
2. A **subscriptions** API that allows to subscribe to live data feeds.
|
||||
3. An **indexer** API (**archive**) that allows you to query historical data.
|
||||
4. A **trigger** API that allows to execute orders only under specified price conditions.
|
||||
|
||||
{% hint style="info" %} <mark style="color:purple;">**NOTE**</mark>: To contact the Nado team with any questions or inquiries about Private Gateway connections, such as increased limits, please reach out on the Telegram channel below:
|
||||
|
||||
* **Telegram Group =** TBD
|
||||
{% endhint %}
|
||||
|
||||
{% content-ref url="api/gateway" %}
|
||||
[gateway](https://docs.nado.xyz/developer-resources/api/gateway)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="api/subscriptions" %}
|
||||
[subscriptions](https://docs.nado.xyz/developer-resources/api/subscriptions)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="api/archive-indexer" %}
|
||||
[archive-indexer](https://docs.nado.xyz/developer-resources/api/archive-indexer)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="api/trigger" %}
|
||||
[trigger](https://docs.nado.xyz/developer-resources/api/trigger)
|
||||
{% endcontent-ref %}
|
||||
Reference in New Issue
Block a user