Introduction
CubePlus Rest API is set of HTTP API that provides data required to build trading platform.The APIs are independent of programming languages which will help you to develop the application in any programming language. To get started with consuming APIs, please go through the process details below,
CubePlus Rest API: Process
- Login to the Developer Portal and create the app.
- Create an App to Obtain API Keys: After logging in, create a new application within the Developer Portal to generate the necessary API keys for your application.
- Retrieve API Keys and Set Up Authorization: Obtain your API keys, then follow the instructions in the auth section to configure your API requests properly.
- Access APIs: On the top right select your preferred programming language from the dropdown menu, download the SDK, and then refer to the README file within the SDK along with the provided sample code for the APIs.
- Access Websockets: On the top right choose select your preferred programming language from the dropdown menu, download the SDK using the "Download SDK" option and refer to the streaming folder for details on the WebSocket SDK.
CubePlus Rate Limits
- Order Limit: The Place Order API is rate-limited on a per-user basis. Each user can submit up to 10 order requests per second.
- Request Limit: All other APIs are also rate-limited on a per-user, per-API basis. Users can make up to 50 requests per second, excluding the Place Order API.
- Websockets (Real-time Data): A maximum of 5 WebSocket connections is allowed per user.
- Instruments: You can subscribe to up to 3,000 instruments per WebSocket connection and receive live quotes.
- User Sessions: A maximum of 10 active login sessions is allowed per user.
Visit our FAQ page for more information and solutions.
Webhook Events
To configure webhook events for your app, login to Developer Portal → Create Apps → Apps → User Based. On the configuration page, enter your webhook endpoint URL in the Webhook URL field and ensure it follows the guidelines provided below the input field.
Once configured, all relevant user order events will be sent to the webhook URL specified in your app settings.
- APIkey - In order to get the API key, please register at developer portal. Once you register with developer portal, an application should be created to generate the API key.
- accessToken - Access token can be received in the response of access-token or individual token service service .
- Bearer token is a unique cryptic string which identifies the user who is making a transaction in CubePlus platform.
- All CubePlus Rest APIs except authorization section requires the bearer token for authorization.
A simple authorization API workflow described below,
