Cloud Rest 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": "{}"
}

Failed Request

A failed response is preceded by the corresponding 40x or 50x HTTP header. The status key in the response contains the value error. The message key contains a textual description of the error and code contains the unique error code. The errors key contains fields breakdown of validation errors for POST & Put requests.

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

Data types
Values in JSON responses are of types string, integer, number, or bool.
Timestamp (datetime) strings in the responses are represented in the default date format yyyy-mm-dd HH:mm:ss e.g., 2016-01-25 13:33:42.

The HTTP Status Codes used by the RESTful API.

HTTP Error Code	Description
400	Bad Request - Missing or bad request parameters or values. Error message will indicate which one and why.
401	Unauthorized - The access token provided is expired, revoked, malformed, or invalid. Client should refresh relogin and then try again.
404	Not Found - Request resource was not found.
405	Method Not Allowed - Request method (GET, POST etc.) is not allowed on the requested endpoint
500	Internal Server Error - API is not working as expected. The request is probably valid but needs to be requested again later.
503	Service Unavailable - The API endpoint is down.

Kindly use below scrip master API for ODIN Scrip master :
https://odinscripmaster.s3.ap-south-1.amazonaws.com/scripfiles/NSE_EQ.json
replace exchange name, like NSE_FO.json, etc...with the list below.

Exchange Segment	Code
NSE Equity	NSE_EQ
NSE FNO	NSE_FO
BSE Equity	BSE_EQ
BSE FNO	BSE_FO
MCX FNO	MCX_FO
NCDEX FNO	NCDEX_FO
MSE CURRENCY	MSE_CUR
NSE CURRENCY	NSE_CUR
BSE CURRENCY	BSE_CUR
BSE COMMODITY	BSE_COMM
NSE COMMODITY	NSE_COMM

This collection of API's would help in user authentication flow including password/MPIN validation, forget & reset etc.

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.

Params	Values	Description
exchange (segment id)	NSE_EQ (1), NSE_FO (2), BSE_EQ (8), BSE_FO (4), MCX_FO (16), NCDEX_FO (64), NSE_CUR (2048), NSE_COMM (32768), BSE_CUR (268435456), BSE_COMM (16384), MSE_CUR (1024), NSE_OTS (536870912)	Exchange segment
product_type	INTRADAY	It consists of one leg only. Open orders will be squared off automatically before market close.
	DELIVERY	Order position will be carried over to next day under holding.
	BTST	Buy today sell tomorrow. It will be squared off automatically before next day market close.
	COVER	It consists of two legs. MAIN_LEG which is market order and SL_LEG which will be square off stop loss order of MAIN_LEG. Open orders will be squared off automatically before market close.
	BRACKET	It consists of three leg order. MAIN_LEG which is placed as Market or Limit, SL_LEG which is square off stop loss order and PROFIT_LEG which is square off order. Open orders will be squared of automatically before market close.
	MTF	Margin Trading or Margin Trading Facility (MTF) is a facility provided by brokers to their clients in which the client does not have to pay full amount for carrying overnight positions.
order_type	RL	Regular limit order.
	RL-MKT	Regular market order.
	SL	Stoploss limit order.
	SL-MKT	Stoploss market order.
validity	DAY	Order valid for the same day.
	IOC	Order valid only for immediate execution else cancelled.
	GTD	Order valid for specified number of days.
	GTC	Order valid until user cancels the order.
	EOS	Order valid for the specific session.
order_status	PENDING	Order is pending or partially executed at exchange.
	EXECUTED	Order is fully executed at exchange.
	CANCELLED	Order is cancelled at exchange.
	OMS_XMITTED	Order is received by OMS but not submitted to exchange.
	OMS_REJECT	Order is rejected by OMS.
	ORDER_ERROR	Order is not valid, rejected by exchange.
	ADMIN_REJECT	Order is rejected by OMS Admin.
	EXCHANGE_XMITTED	Order is submitted to exchange, but confirmation is not received.
	AMO_SUBMITTED	AMO order is received by OMS.
	AMO_CANCELLED	AMO order is cancelled.