Integration
Where can I find the trading platform API documentation?
Our API documentation lives inside the support widget on our site, built with Chatref. The knowledge base is trained on every endpoint, code sample, and integration walkthrough. Ask the AI agent directly for the authentication flow or a REST endpoint, and it will surface the relevant guide in seconds.
Finding API Documentation Through the Knowledge Base
The trading platform API documentation is fully indexed in the knowledge base that powers our support experience. When you open the widget and type a question like “create order payload” or “WebSocket feed authentication,” the Chatref AI agent retrieves the exact developer resource from our own docs, no web search or guesswork.
This means you never need to navigate a separate portal or dig through PDFs. The knowledge base covers:
- REST and WebSocket API references
- Authentication and rate limiting
- Sample code in Python, Node.js, and cURL
- Sandbox environment setup
The retrieval is grounded solely in our official material, so you get the same precision every support engineer would have.
Getting Real-Time Help from the AI Agent
Instead of browsing a static documentation page, you can ask the AI agent to walk you through a task. For example, request a step-by-step guide to placing a bracket order, and the agent will produce a tailored answer with the exact endpoint, parameters, and a code snippet pulled from the knowledge base.
This agent understands the API inside out because it’s trained on our entire developer hub. It can clarify parameter constraints, explain error codes, and suggest the right integration path without hallucinating a single detail.
Common requests the agent handles:
- “Which endpoint do I use for historical market data?”
- “Show me a working example of a limit order submission.”
- “How do I handle connection loss with the WebSocket stream?”
All responses stay strictly within the boundaries of our own documentation, so you can trust every answer.
Developer Resources and Integration Guides
Beyond the real-time assistant, the knowledge base also houses a complete set of integration guides. These walk you through connecting your trading system, backtesting engine, or mobile app to our platform. They are available both through the widget and as indexed articles that the AI agent can surface on demand.
Guides include:
- Getting started with API access (key generation and permission scopes)
- Connecting to live and demo environments
- WebSocket market data integration
- Order management and risk checks
Because everything is in one knowledge base, you never need to switch between a wiki, PDFs, and a separate forum. The Chatref agent pulls the latest version of any guide each time you ask.
FAQ
How do I get API access?
API access starts by generating credentials in your account’s API settings. Once you have a key, the AI agent can guide you through authenticating your first request—just ask “How do I authenticate?” The knowledge base includes a full walkthrough on key generation, scopes, and rate limits.
Are there integration guides available?
Yes, a full library of integration guides lives in our support knowledge base. You can ask the agent for guides by topic—for example, “WebSocket integration guide” or “Python order placement.” Each guide is grounded in our own documentation and includes code samples, environment setup, and error handling.
Can I automate trades using the API?
Absolutely. The API supports fully automated trading strategies. The AI agent can surface the exact resource you need: order placement endpoints, real-time market data streams, and risk management parameters. For a complete walkthrough, ask “show me how to place an automated limit order”—the answer will come straight from our developer docs, not from internet speculation.
Put this into practice
Chatref answers your customers from your own content, day and night. Add it to your site and go live in minutes – free to start.