Introduction

The Cloud REST API enables developers to create custom trading applications (for Web or Mobile) that integrate with the ODIN Order Management System (OMS). With this REST-based API, you can build features like:

• User Authentication and Profile Management
• Order Management
• Portfolio Information Management
• Scrip Master Details

This step-by-step guide will walk you through the entire API implementation process, from authentication to handling request and response structures.

📡 Download Postman Collection

💻 Download NodeJS SDK

🐍 Download Python SDK

Getting Started

The Cloud REST API provides a set of REST endpoints to help developers build a complete trading platform. These APIs communicate with the ODIN API Gateway and cover key trading functionalities such as:

• User authentication (Login / Logout)
• Order management (Place, Modify, Cancel orders)
• Reports (Order Book, Trade Book, Positions, Holdings, Limits, etc.)

The APIs use JSON for requests and responses and support data compression for efficient communication.

🚀 Basic Implementation Flow

1. Login
   Call the Login API with user credentials to obtain an access token.

2. Use Access Token
   Include this token in all subsequent API calls.

3. Set Headers
   Example headers for requests:

   Content-Type: application/json
   Authorization: Bearer <access_token>

Response Structure

Request Parameters

• GET and DELETE requests: Parameters are sent as query strings.
• POST and PUT requests: Parameters are sent as JSON (application/json).
• Note: Non-alphanumeric characters in query/path parameters must be URL encoded.

✔️ Successful Response

• All responses are in JSON (application/json) unless stated otherwise.
• A 200 OK response contains:

HTTP/1.1 200 OK 
Content-Type: application/json 
{
  "status": "success",
  "code": "",
  "message": "",
  "data": "{}"
}

Field	Description
status	"success"
data	Contains the full response payload

❌ Failed Response

Failed responses use the corresponding 40x/50x HTTP codes.

{
  "status": "error",
  "code": "",
  "message": "",
  "errors": []
}

Field	Description
status	"error"
message	Description of the error
code	Unique error code
errors	Detailed field-level validation errors (for POST/PUT requests)

Data Types

• Values can be string, integer, number, or boolean.
• Timestamps use the format: yyyy-mm-dd HH:mm:ss (e.g., 2025-11-06 13:33:42)

📧 Contact

• Email - apisupport@synapsewave.com
• URL: https://synapsewave.com/