The changes made in the document along with the version no. and release dates.

ODIN API is a set of REST APIs that provide the platform along with required data to build a Trading Platform, the API specifications is used for communicating with ODIN API Gateway. API specifications are based on the REST protocol that covers the functionalities which are need to develop a trading application like Login / Logout, Order Management (Place Order, Modify Order, Cancel order), Reports like Order Book, Trade Book, Position, Holding & Limit, etc. The REST API supports JSON based request and responses along with data compression.

Basic Flow to Implement the APIs:

STEP 1:Make a Login API call using login credential to obtain the access token.
STEP 2: Use access token obtained from Login API in all the subsequent API calls.
STEP 3: Setting obtained access token and content-type is shown below.

Header:
Content-Type: application/json
Authorization: Bearer eyJ1c2VySUQiOiJSVVBFU0giLCJpYXQiOjE1NTIxMjIwOTEsImV4cCI6MTU1MjIwODQ5MX0

All GET and DELETE request parameters go as query parameters, and POST and PUT request parameters as json (application/json) parameters, responses from the API are always JSON. Any non-alphanumeric character should be URL encoded in query string and path parameters.

Successful Request

All responses from the API server are in JSON format with the content-type application/json unless explicitly stated otherwise. A successful 200 OK response always has a JSON response body with a status as success. The data key contains the full response payload.

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

HTTP/1.1 500 Server error 
Content-Type: application/json 
{
   "status": "error",
   "code": "",
   "message": "",
   "errors": "[]"
}

The HTTP Status Codes used by the RESTful API.

The User APIs allows to generate access token (sessionid) using the client’s Login credentials. Additionally, user API, has calls for knowing User profile and fund balance summary.

This section provided to information of API calls to do the order management i.e. place fresh order, modify or cancel already submitted valid orders. Retrieve the order and trade book.
Using Order API, various type of orders Intraday, Delivery, Bracket Order, Cover order, etc. can be placed. Order type here is used as Product Type in System. Kindly refer to the respective API call for more detail.

Global Constants
Here are some of the constants enum values used for placing order.

This section provided to information of API calls to fetch open position and holding detail of user as uploaded by member in System.

The Price Feed API allows to get price feed from broadcast server.

Basic Flow to Implement the APIs:

STEP 1: Make a Login API call using login credential to obtain the broadcast socket server endpoint and broadcast access token.
STEP 2: Use broadcast access token in login request to broadcast server.

Click here to know how to connect or download API documentation.

System provides real-time streaming data to receive order & trade responses. This feature is exposed via socket.io. You need to use the standard socket.io library (for more information, kindly refer https://socket.io/).

This streaming feature is only meant for receiving real-time “Order & Trade responses”. All other features (order placement, order modification, portfolio details, etc.) need to be implemented using their respective APIs covered in the previous sections.

To use this feature, a client needs to establish a socket connection with the streaming server and subscribe to the events. Establishing the connectivity requires a couple of fields that are received in the Login API response (refer the User -> Login section to know how to login):
    a. “others”:”messageSocket” – Streaming server’s endpoint that is used in the Connect section below.
    b. “access_token” – A unique token that is issued to you for the purpose of authentication and is used in the Login section below.

Given below are the detailed steps, with a sample NodeJS code, describing the various events and how to subscribe to these events:

1. Connect: This step comprises of establishing the socket connection with the streaming server.
    const io = require("socket.io-client"); // NPM package for socket.io
    let ioClient = io.connect(url, {transports:['websocket']}); // url will be received in the Login API response -> “others”:“messageSocket”

2. Login: Here, you need to get authenticated before subscribing to events from the streaming server.
    ioClient.on("connect", () => {
    let msgLogin = {“jToken”:"eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b2tlbiIsImlhdCI6MTU5MzQ5.j80QyIeFOCJzNQk "}; // jToken will be received in Login API response -> “access_token”
    ioClient.emit('loginAPI', msgLogin); // the socket will get disconnected if the authentication check is unsuccessful
})

3. Order/ Trade response: You need to subscribe to the MSG:DATA event to receive order & trade responses from the streaming server.
    ioClient.on("MSG:DATA", (response) => {
    console.log(' Received response : ' + JSON.stringify(response)) ;
    })

We have provided the order & trade response structures as well as sample responses after the Disconnect section below. It will help you understand the JSON response structure and the fields that are returned.

4. Disconnect: You need to disconnect the socket to close the connection with the streaming server. Moreover, you also need to subscribe to the “disconnect” event in case the server disconnects the connection.
    ioClient.on("disconnect", (err) => {
    console.log("Disconnected: Error: "+ err );
    })

Note: To differentiate order and trade response, kindly refer "MessageType" in the response. For order response, the value will be "ORD_NRML" and for trade response, it will be "TRD_MSG".


Order response structure: