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

# Overview

Welcome to the API documentation. We provide complete RESTful API and WebSocket API to meet your trading needs.

* It is recommended to set up an IP whitelisting along with API Key for security purpose.
* Never tell your API Key/ Secret to anyone.
* Feel free to join our Official Group if there is any question: <https://t.me/pionexapi>.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-square-terminal">:square-terminal:</i></h3></td><td><strong>Trade API</strong></td><td><a href="/pages/BV3rhLj78rMcVZof703y">/pages/BV3rhLj78rMcVZof703y</a></td></tr><tr><td><h3><i class="fa-square-terminal">:square-terminal:</i></h3></td><td><strong>Trade Websocket</strong></td><td><a href="/pages/jHOpASo5DrqVnKitXpkc">/pages/jHOpASo5DrqVnKitXpkc</a></td></tr><tr><td><h3><i class="fa-square-terminal">:square-terminal:</i></h3></td><td><strong>Wallet API</strong></td><td><a href="/pages/2YSLYqpvwxBfIeBc7uKO">/pages/2YSLYqpvwxBfIeBc7uKO</a></td></tr><tr><td><h3><i class="fa-square-terminal">:square-terminal:</i></h3></td><td><strong>Futures API (Invite only)</strong></td><td><a href="/pages/z2Cx7EeQHtZs5zWrgt6j">/pages/z2Cx7EeQHtZs5zWrgt6j</a></td></tr><tr><td><h3><i class="fa-square-terminal">:square-terminal:</i></h3></td><td><strong>Futures Websocket (Invite only)</strong></td><td><a href="/pages/PpwW4jbMe0QeD3Y5Y0Xp">/pages/PpwW4jbMe0QeD3Y5Y0Xp</a></td></tr><tr><td><h3><i class="fa-square-terminal">:square-terminal:</i></h3></td><td><strong>Bot API</strong></td><td><a href="/pages/XDFxTqRD5gBteGXoPeoJ">/pages/XDFxTqRD5gBteGXoPeoJ</a></td></tr><tr><td><h3><i class="fa-square-terminal">:square-terminal:</i></h3></td><td><strong>Earn API (Beta)</strong></td><td><a href="/pages/GF5eMBx4IeeyRaSxHrG0">/pages/GF5eMBx4IeeyRaSxHrG0</a></td></tr><tr><td><h3><i class="fa-square-terminal">:square-terminal:</i></h3></td><td><strong>Earn Dual API (Beta)</strong></td><td><a href="/pages/OMMFVnabyB7qWJFQeLgS">/pages/OMMFVnabyB7qWJFQeLgS</a></td></tr><tr><td><h3><i class="fa-square-terminal">:square-terminal:</i></h3></td><td><strong>InstFund API (Invite only)</strong></td><td><a href="/pages/ZX010uxxn7kc2q10VQio">/pages/ZX010uxxn7kc2q10VQio</a></td></tr><tr><td><h3><i class="fa-square-terminal">:square-terminal:</i></h3></td><td><strong>Partner API (Invite only)</strong></td><td><a href="/pages/1772LnInHPwcNiFXbzIU">/pages/1772LnInHPwcNiFXbzIU</a></td></tr></tbody></table>

## References

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-key">:key:</i></h3></td><td><strong>API Key Guide</strong> <i class="fa-arrow-right">:arrow-right:</i></td><td><a href="https://www.pionex.com/docs/api-docs/references/api-key-guide">https://www.pionex.com/docs/api-docs/references/api-key-guide</a></td></tr><tr><td><h3><i class="fa-shield">:shield:</i></h3></td><td><strong>API Key Permissions</strong> <i class="fa-arrow-right">:arrow-right:</i></td><td><a href="https://www.pionex.com/docs/api-docs/references/api-key-permissions">https://www.pionex.com/docs/api-docs/references/api-key-permissions</a></td></tr><tr><td><h3><i class="fa-github">:github:</i></h3></td><td><strong>GitHub</strong> <i class="fa-arrow-right">:arrow-right:</i></td><td><a href="https://github.com/pionex-official/pionex-open-api">https://github.com/pionex-official/pionex-open-api</a></td></tr><tr><td><h3><i class="fa-telegram">:telegram:</i></h3></td><td><strong>Support</strong> <i class="fa-arrow-right">:arrow-right:</i></td><td><a href="https://t.me/pionexapi">https://t.me/pionexapi</a></td></tr></tbody></table>