Introduction
Goodwill API which helps traders/investors to build, monitor and execute their trading requirement automatically.
API Endpoint
https://api.gwcindia.in/v1/
REST API URL
https://api.gwcindia.in/v1/{{api_name}}
HEADER STRUCTURE
Each rest call will have 2 compulsory header parameters
1. api_key
2. access_token
# Here is a curl example
curl --location --request GET 'https://api.gwcindia.in/v1/{{api_name}}' \
--header 'x-api-key: {{your_api_key}}' \
--header 'Authorization: Bearer {{your_access_token}}' \
# | Param | Value | Description |
---|---|---|---|
1 | x-api-key | api_key | user/partner api_key |
2 | Bearer Token | access_token | Bearer token authorization header |
api_key is a key allocated to the Goodwill User. If you don't have a api_key, signup here. Input will be in string format.
access_token is a token received as response from Login 2FA. Input will be in string format.
SUCCESSFUL RESPONSE
{
"status": "success",
"data": {}
}
Each successful response rest will have parameters
1. status
2. data
ERROR RESPONSE
{
"status": "error",
"error_msg": "Error Message",
"error_type": "GeneralException"
}
Each error response rest will have 3 parameters
1. status
2. error_msg
3. error_type
Login
Goodwill Login Flow
#Example
https://{{registered redirect URL}}?request_token={{request_token}}
# | REQUEST | RESPONSE |
---|---|---|
1 | https://api.gwcindia.in/v1/login?api_key=xxx | Redirects Goodwill Login page |
2 | After Successful Goodwill Login | request_token will be passed as query string parameter to the registered redirect URL. |
3 | https://api.gwcindia.in/v1/login-response with Signature | User Login Session Details |
Login Response
Rest Properties | Description |
---|---|
Name | Login Response |
Description | Gives the login session details with access token |
URL | https://api.gwcindia.in/v1/login-response |
Input | YES |
Input
{
"api_key": "xxxxx",
"request_token": "5ca9e0b42c4e94759030e850",
"signature": "f110112a934b7a867dfe611abb41b7274e"
}
# | Parameter | Description |
---|---|---|
1 | api_key | API Key |
2 | request_token | Received as Query String to the Redirect URL |
3 | signature | Hash value using request_token as key |
Success Response
{
{"status":"success",
"data":{
"clnt_id":"GQ1A0007",
"name":"MANOHARAN SARAVANABHAVAN",
"email":"SARAVANAKIRAN2012@GMAIL.COM",
"exarr":["BSE","NFO","NSE","MCX","ICEX"],
"prarr":["BO","CNC","CO","MIS","NRML"],
"orarr":["L","MKT","SL","SL-M"],
"exchDetail":{"EQUITY":[{"product":["BO","CNC","CO","MIS","NRML"],"exchseg":"bse_cm","exch":"BSE"},{"product":["BO","CNC","CO","MIS","NRML"],"exchseg":"nse_cm","exch":"NSE"}],"DERIVATIVE":[{"product":["BO","CO","MIS","NRML"],"exchseg":"nse_fo","exch":"NFO"}],"COMMODITY":[{"product":["BO","CO","MIS","NRML"],"exchseg":"mcx_fo","exch":"MCX"},{"product":["BO","CO","MIS","NRML"],"exchseg":"icx_fo","exch":"ICEX"}]},
"usersessionid":"3279379865",
"access_token":"8a5e32e1126025fefbcefc88eb6eb9a9"}
}
}
# | Parameter | Description |
---|---|---|
1 | client_id | Client Unique ID |
2 | name | Account name |
3 | Email id of user | |
4 | exarr | Enabled exchange in a JSON array |
5 | prarr | Enabled product type in a JSON array |
6 | orarr | Enabled order type in a JSON array |
7 | exchDetail | Exchange details JSON object |
8 | usersessionid | User session ID(Used in web sockets) |
9 | access_token | Access Token |
Error Response
{
"status": "error",
"error_msg": "Invalid Signature",
"error_type": "E"
}
# | Parameter | Description |
---|---|---|
1 | status | error |
2 | error_msg | Error Message |
3 | error_type | Error Type |
# | Error Messages | Description |
---|---|---|
1 | Invalid API key or API key expired | Input API Key is invalid or expired |
2 | Invalid Signature | Input Signature is invalid |
3 | Invalid Request Token | Input Session ID and Request Token is Invalid |
Signature
Example :
API Key="xxxxx"
request_token="5ca9e0b42c4e94759030e850"
API Secret="yyyyy"
checksum='xxxxx5ca9e0b42c4e94759030e850yyyyy'
signature=hash('sha256','xxxxx5ca9e0b42c4e94759030e850yyyyy')
To make the request secure, we have implemented parameter posting with signature (i.e. SHA-256 of checksum). Signature parameter is created by hashing the value of below mentioned parameters.
i. API Key
ii. request_token
iii. API Secret
checksum=API Key + request_token + API Secret
signature=SHA-256 of checksum
'signature' parameter is mandatory and needs to be added in login-response API
Profile
# Here is a curl example
curl --location --request GET 'https://api.gwcindia.in/v1/profile' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 05b8167eed78367034cb5ed4a8c15930'
To get characters you need to make a GET call to the following url :
https://api.gwcindia.in/v1/profile
RESPONSE ATTRIBUTES
{
"client_id": "TV0XXX",
"name": "VIKRAM",
"email": "vikram@gmail.com",
"exarr": [
"nse_slb",
"nse_fo",
"nse_com",
"nse_cm",
"cde_fo",
"mcx_sx",
"mcx_fo",
"icx_fo",
"bse_fo",
"bse_com",
"bse_cm",
"bcs_fo"
],
"prarr": [
"NRML",
"CNC",
"MIS",
"CO",
"BO"
]
}
Attribute | Datatype | Description |
---|---|---|
client_id | string | Client Id |
name | string | Name of the Client |
string | E-mail address of the user | |
exarr | array | Array of Exchanges |
prarr | array | Array of Products |
Balance
# Here is a curl example
curl --location --request GET 'https://api.gwcindia.in/v1/balance' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 05b8167eed78367034cb5ed4a8c15930'
To get characters you need to make a GET call to the following url :
https://api.gwcindia.in/v1/balance
{
"segment": "Derivative",
"bookedpnl": "0.00",
"unbookedpnl": "0.00",
"openingbalance": "0.00",
"credits": "0.00",
"payinamt": "0.00",
"utilizedamount": "0.00",
"payoutamt": "0.00",
"varmargin": "0.00",
"spanmargin": "0.00",
"realisedmtom": "0.00",
"unrealisedmtom": "0.00",
"debits": "0.00"
}
RESPONSE ATTRIBUTES
Attribute | Datatype | Description |
---|---|---|
segment | string | Segment type Equity/Derivative/Commodity/Currency |
bookedpnl | string | Booked profit and loss |
unbookedpnl | string | Unbooked profit and loss |
openingbalance | string | Opening balance or cash margin available |
credits | string | Credits |
payinamt | string | Pay in amount |
utilizedamount | string | Utilized amount |
payoutamt | string | Pay out amount |
varmargin | string | Var margin |
spanmargin | string | Span margin |
realisedmtom | string | Realised mtom |
unrealisedmtom | string | UnRealised mtom |
debits | string | debits |
Positions
# Here is a curl example
curl --location --request GET 'https://api.gwcindia.in/v1/positions' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 05b8167eed78367034cb5ed4a8c15930'
To get characters you need to make a GET call to the following url :
https://api.gwcindia.in/v1/positions
[
{
"exchange": "NSE",
"product": "CNC",
"tsym": "YESBANK-EQ",
"token": "11915",
"cfbuyqty": "0",
"cfbuyavgprc": "0.00",
"cfsellqty": "0",
"cfsellavgprc": null,
"bqty": "1",
"buyavgprc": "13.95",
"sqty": "0",
"sellavgprc": "0.00",
"netqty": "1",
"netbuyavgprc": "13.95",
"netsellavgprc": "0.00",
"netamt": "-13.95",
"ltp": "14.00",
"bep": "13.95",
"realisedprofitloss": "0.00",
"unrealisedprofitloss": "0.05"
}
]
RESPONSE ATTRIBUTES
Parameter | Description |
---|---|
exchange | Exchange name |
product | Product code |
tsym | Trading symbol |
token | Token of the scrip |
cfbuyqty | CF buy quantity |
cfbuyavgprc | CF net buy average price |
cfsellqty | CF sell quantity |
cfsellavgprc | CF net sell average price |
bqty | Buy quantity |
buyavgprc | Buy average price |
sqty | Sell quantity |
sellavgprc | Sell average price |
netqty | Net quantity |
netbuyavgprc | Net Buy Average price |
netsellavgprc | Net Sell Average price |
netamt | Net amount |
ltp | Last trade price of the scrip |
bep | Break-even price of the position |
realisedprofitloss | Realized profit loss |
unrealisedprofitloss | Unrealized profit loss |
exitposition
# Here is a curl example
curl --location --request POST 'https://api.gwcindia.in/v1/exitposition' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 05b8167eed78367034cb5ed4a8c15930' \
To get characters you need to make a POST call to the following url :
https://api.gwcindia.in/v1/exitposition
Request example :
{ "segment":"nse_cm",
"product":"CNC",
"netqty":"1",
"token": "11915",
"tsym": "YESBANK-EQ"
}
Response example :
{
"status": "success",
"data": {
"result": "ok"
}
}
QUERY PARAMETERS
Request Parameter | Description | Mandatory |
---|---|---|
segment | Exchange segment name | Yes |
product | Product Code | Yes |
netqty | Net Quantity | Yes |
token | Symbol token | Yes |
tsym | Trading Symbol | Yes |
Holdings
# Here is a curl example
curl --location --request GET 'https://api.gwcindia.in/v1/holdings' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 05b8167eed78367034cb5ed4a8c15930'
To get characters you need to make a GET call to the following url :
https://api.gwcindia.in/v1/holdings
[
{
"exchange": "NSE",
"token": "20825",
"tsym": "RELIANCE-EQ",
"isin": "INE002A01018",
"holdqty": "0",
"btst_qty": "0",
"sellable_qty": "0",
"average_price": "0.00",
"ltp": "0.00",
"pcode": "CNC",
"coll_qty": "0",
"coll_type": ""
}
]
RESPONSE ATTRIBUTES
Parameter | Description |
---|---|
exchange | Exchange name |
token | Token of the scrip |
tsym | Trading symbol |
isin | ISIN |
holdqty | Holding quantity |
btst_qty | BTST quantity |
sellable_qty | Sellable quantity |
average_price | Average price |
ltp | Last trade price of the scrip |
pcode | Product code |
coll_qty | Collateral quantity |
coll_type | Collateral type |
OrderBook
# Here is a curl example
curl --location --request GET 'https://api.gwcindia.in/v1/orderbook' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 05b8167eed78367034cb5ed4a8c15930'
To get characters you need to make a GET call to the following url :
https://api.gwcindia.in/v1/orderbook
[
{
"exchange": "NSE",
"token": "11915",
"tsym": "YESBANK-EQ",
"product": "CNC",
"pricetype": "MKT",
"validity": "DAY",
"price": "00.00",
"trgprc": "00.00",
"qty": 1,
"dscqty": 0,
"trantype": "B",
"avgprc": "13.95",
"fillshares": 1,
"remarks": "--",
"exchordid": "1300000016630228",
"syomorderid": "",
"nstordno": "220113000041330",
"orderentrytime": "Jan 13 2022 13:24:00",
"exchconfrmtime": "13-Jan-2022 13:24:00",
"status": "complete",
"ordvaldate": "NA",
"rejreason": "--"
}
]
RESPONSE ATTRIBUTES
Attributes | Datatype | Description |
---|---|---|
exchange | string | Exchange name |
token | string | Token of the scrip |
tsym | string | Trading symbol |
product | string | Product Code |
pricetype | string | Price type |
validity | string | validity |
price | string | Price |
trgprc | string | Trigger price |
qty | string | Quantity |
dscqty | string | Disclosed quantity |
trantype | string | Transaction type |
avgprc | string | Average price |
fillshares | string | Filled Quantity |
remarks | string | Remarks |
exchordid | string | Exchange order id |
syomorderid | string | Syom Order ID |
nstordno | string | Nest order number |
orderentrytime | string | Order entry time |
exchconfrmtime | string | Exchange confirmation time |
status | string | Status of the order |
ordvaldate | string | Order validity date |
rejreason | string | Rejection reason |
orderhistory
# Here is a curl example
curl --location --request POST 'https://api.gwcindia.in/v1/orderhistory' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 05b8167eed78367034cb5ed4a8c15930' \
To get characters you need to make a POST call to the following url :
https://api.gwcindia.in/v1/orderhistory
Request example :
{
"nstordno": "220104000034606"
}
Response example :
{
"status": "success",
"data": [
{
"exchange": "NSE",
"tsym": "YESBANK-EQ",
"product": "CNC",
"pricetype": "MKT",
"duration": "DAY",
"price": "00.00",
"trgprc": "0.0",
"qty": 1,
"disclosedqty": "0",
"trantype": "B",
"avgprc": "13.95",
"filledshares": 1,
"orderusermessage": "",
"exchordid": "1300000016630228",
"nstordno": "220113000041330",
"status": "complete",
"rejectionreason": "--",
"exchtimestamp": "13-Jan-2022 13:24:00",
"nestreqid": "1"
},
{
"exchange": "NSE",
"tsym": "YESBANK-EQ",
"product": "CNC",
"pricetype": "MKT",
"duration": "DAY",
"price": "00.00",
"trgprc": "0.0",
"qty": 1,
"disclosedqty": "0",
"trantype": "B",
"avgprc": "0.0",
"filledshares": 0,
"orderusermessage": "",
"exchordid": "1300000016630228",
"nstordno": "220113000041330",
"status": "open",
"rejectionreason": "--",
"exchtimestamp": "13-Jan-2022 13:24:00",
"nestreqid": "1"
},
{
"exchange": "NSE",
"tsym": "YESBANK-EQ",
"product": "CNC",
"pricetype": "MKT",
"duration": "DAY",
"price": "00.00",
"trgprc": "0.0",
"qty": 1,
"disclosedqty": "0",
"trantype": "B",
"avgprc": "0.0",
"filledshares": 0,
"orderusermessage": "",
"exchordid": null,
"nstordno": "220113000041330",
"status": "open pending",
"rejectionreason": "--",
"exchtimestamp": "--",
"nestreqid": "1"
},
{
"exchange": "NSE",
"tsym": "YESBANK-EQ",
"product": "CNC",
"pricetype": "MKT",
"duration": "DAY",
"price": "00.00",
"trgprc": "0.0",
"qty": 1,
"disclosedqty": "0",
"trantype": "B",
"avgprc": "0.0",
"filledshares": 0,
"orderusermessage": "",
"exchordid": null,
"nstordno": "220113000041330",
"status": "validation pending",
"rejectionreason": "--",
"exchtimestamp": "--",
"nestreqid": "1"
},
{
"exchange": "NSE",
"tsym": "YESBANK-EQ",
"product": "CNC",
"pricetype": "MKT",
"duration": "DAY",
"price": "00.00",
"trgprc": "0.0",
"qty": 1,
"disclosedqty": "0",
"trantype": "B",
"avgprc": "0.0",
"filledshares": 0,
"orderusermessage": "",
"exchordid": null,
"nstordno": "220113000041330",
"status": "put order req received",
"rejectionreason": "--",
"exchtimestamp": "--",
"nestreqid": "1"
}
]
}
REQUEST PARAMETERS
Request Parameter | Description | Mandatory |
---|---|---|
nstordno | Order Number | Yes |
RESPONSE ATTRIBUTES
# | Parameter | Description |
---|---|---|
1 | exchange | Exchange |
2 | tsym | Trading symbol |
3 | product | Product code |
4 | pricetype | Price type |
5 | duration | Order duration |
6 | price | Price |
7 | trgprc | Trigger Price |
8 | qty | Quantity |
9 | disclosedqty | Disclosed quantity |
10 | trantype | Transaction type |
11 | avgprc | Average price |
12 | filledshares | filledShares |
13 | orderusermessage | Order User Message |
14 | exchordid | Exchange Order id |
15 | nstordno | Nest Order number |
17 | status | Status of the order |
18 | rejectionreason | Rejection reason |
19 | exchtimestamp | Exchange time stamp |
20 | nestreqid | Nest Request id |
tradebook
# Here is a curl example
curl --location --request GET 'https://api.gwcindia.in/v1/tradebook' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 05b8167eed78367034cb5ed4a8c15930'
To get characters you need to make a GET call to the following url :
https://api.gwcindia.in/v1/tradebook
{
"status": "success",
"data": [
{
"exchange": "NSE",
"tsym": "YESBANK-EQ",
"product": "CNC",
"pricetype": "MKT",
"trantype": "B",
"qty": 1,
"exchordid": "1300000016630228",
"nstordno": "220113000041330",
"exchtime": "13-Jan-2022 13:24:00",
"price": "13.95"
}
]
}
RESPONSE ATTRIBUTES
Attributes | Datatype | Description |
---|---|---|
exchange | string | Exchange |
tsym | string | Trading Symbol |
product | string | Product code |
pricetype | string | Price type of the Trade |
trantype | string | Trasaction type(B/S) |
qty | string | Quantity |
exchordid | string | Exchange Order ID |
nstordno | string | Nest Order ID |
exchtime | string | Exchange time |
price | string | Price |
placeorder
# Here is a curl example
curl --location --request POST 'https://api.gwcindia.in/v1/placeorder' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 05b8167eed78367034cb5ed4a8c15930' \
To get characters you need to make a POST call to the following url :
https://api.gwcindia.in/v1/placeorder
Request example :
{
"tsym": "YESBANK-EQ",
"exchange":"NSE",
"trantype":"B",
"validity":"DAY",
"pricetype":"MKT",
"qty":"1",
"discqty":"0",
"price":"0",
"trgprc":"0",
"product":"CNC",
"amo":"NO"
}
Response example :
{
"status": "success",
"data": {
"nstordno": "220104000034606"
}
}
QUERY PARAMETERS
Request Parameter | Description | Mandatory |
---|---|---|
tsym | Trading Symbol | Yes |
exchange | Exchange name | Yes |
trantype | Transtaction Type | Yes |
validity | Validity - It can be one of the following DAY IOC |
Yes |
pricetype | It can be one of the following MKT - Market Order L - Limit Order SL-L - Stop Loss Limit Order SL-M - Stop Loss Market Order |
Yes |
qty | Quantity | Yes |
discqty | Disclosed Quantity | Yes |
price | Price | Yes |
trgprc | Trigger Price | Yes |
product | Product Code | Yes |
amo | AMO - It can be one of the following YES NO |
Yes |
placeboorder
# Here is a curl example
curl --location --request POST 'https://api.gwcindia.in/v1/placeboorder' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 05b8167eed78367034cb5ed4a8c15930' \
To get characters you need to make a POST call to the following url :
https://api.gwcindia.in/v1/placeboorder
Request example :
{
"exchange":"NSE",
"tsym": "YESBANK-EQ",
"trantype":"B",
"qty":"1",
"validity":"DAY",
"discqty":"0",
"price":"14",
"squareoff":"15",
"stoploss":"13",
"trailing_ticks":"0",
"pricetype":"L",
"trgprc":"0"
}
Response example :
{
"status": "success",
"data": {
"nstordno": "220104000034606"
}
}
QUERY PARAMETERS
Request Parameter | Description | Mandatory |
---|---|---|
exchange | Exchange name | Yes |
tsym | Trading Symbol | Yes |
trantype | Transtaction Type | Yes |
qty | Quantity | Yes |
validity | Validity - It can be one of the following DAY IOC |
Yes |
discqty | Disclosed Quantity | Yes |
price | Price | Yes |
squareoff | Square Off | Yes |
stoploss | Stop Loss | Yes |
trailing_ticks | Trailing Ticks | Yes |
pricetype | It can be one of the following MKT - Market Order L - Limit Order SL-L - Stop Loss Limit Order SL-M - Stop Loss Market Order |
Yes |
trgprc | Trigger Price | Yes |
modifyorder
# Here is a curl example
curl --location --request POST 'https://api.gwcindia.in/v1/modifyorder' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 3e81bfb2a1ef11d3bd3e9a8966d4d51e' \
To get characters you need to make a POST call to the following url :
https://api.gwcindia.in/v1/modifyorder
Request example :
{ "exchange":"NSE",
"tsym": "YESBANK-EQ",
"nstordno":"220113000064084",
"trantype":"B",
"pricetype":"MKT",
"price":"0",
"qty":"1",
"discqty":"0",
"trgprc":"0",
"validity":"DAY",
"filledqty":"1",
"product":"CNC"
}
Response example :
{
"status": "success",
"data": {
"result": " NEST Order Number :220105000048291"
}
}
QUERY PARAMETERS
Request Parameter | Description | Mandatory |
---|---|---|
exchange | Exchange name | Yes |
tsym | Trading Symbol | Yes |
nstordno | Order ID | Yes |
trantype | Transaction type(B/S) | Yes |
pricetype | Type of order. It can be one of the following MKT - Market Order L - Limit Order SL-L - Stop Loss Limit Order SL-M - Stop Loss Market Order |
Yes |
price | Price at which the order was placed | Yes |
qty | Quantity with which the order was placed | Yes |
discqty | Disclosed Quantity | Yes |
trgprc | Trigger Price | Yes |
validity | Validity | Yes |
filledqty | Filledqty | Yes |
product | Product Code | Yes |
CancelOrder
# Here is a curl example
curl --location --request POST 'https://api.gwcindia.in/v1/cancelorder' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 3e81bfb2a1ef11d3bd3e9a8966d4d51e' \
To get characters you need to make a POST call to the following url :
https://api.gwcindia.in/v1/cancelorder
Request example :
{
"nstordno":"220106000024964"
}
Response example :
{
"status": "success",
"data": {
"result": " NEST Order Number :220106000024964"
}
}
QUERY PARAMETERS
Request Parameter | Description | Mandatory |
---|---|---|
nstordno | Nest Order Number | Yes |
GetQuote
# Here is a curl example
curl --location --request POST 'https://api.gwcindia.in/v1/getquote' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 6cb7ac3a5a73831ec88ee8915bee3f2a' \
To get characters you need to make a POST call to the following url :
https://api.gwcindia.in/v1/getquote
Request example :
{
"exchange":"NSE",
"token":"11915"
}
Response example :
{
"status": "success",
"data": {
"symbol_name": "YESBANK",
"trading_symbl": "YESBANK-EQ",
"company_name": "YES BANK LIMITED",
"last_trade_time": "06/01/2022 15:59:58",
"last_price": "14.25",
"change": "00.00",
"change_per": "00.00",
"last_quantity": "4",
"buy_quantity": "4",
"sell_quantity": 303792,
"volume": "125481711",
"average_price": "14.26",
"open": "14.25",
"high": "14.45",
"low": "14.10",
"close": "14.25",
"tick_size": "5",
"multiplier": 1,
"lot_size": 1,
"decimalprecision": 2,
"yearly_low_price": "10.50",
"yearly_high_price": "18.60"
}
}
QUERY PARAMETERS
Request Parameter | Description | Mandatory |
---|---|---|
exchange | Exchange | Yes |
token | Token | Yes |
RESPONSE ATTRIBUTES
Attributes | Datatype | Description |
---|---|---|
symbol_name | string | Symbol Name |
trading_symbl | string | Trading Symbol |
company_name | string | Company Name |
last_trade_time | string | Last Traded Time |
last_price | string | Last Traded Price |
change | string | Change Price |
change_per | string | Change Percentage |
last_quantity | string | Last Traded Quantity |
buy_quantity | string | Buy Quantity |
sell_quantity | string | Sell Quantity |
volume | string | Volume |
average_price | string | Average Price |
open | string | Open |
high | string | High |
low | string | Low |
close | string | Close |
tick_size | string | Tick Size |
multiplier | string | Multiplier |
lot_size | string | Lot Size |
decimalprecision | string | Decimal Precision |
yearly_low_price | string | Yearly low price |
yearly_high_price | string | Yearly high price |
Fetch Symbol
# Here is a curl example
curl --location --request POST 'https://api.gwcindia.in/v1/fetchsymbol' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 6cb7ac3a5a73831ec88ee8915bee3f2a' \
To get characters you need to make a POST call to the following url :
https://api.gwcindia.in/v1/fetchsymbol
Request example :
{
"s":"RELIANCE"
}
Response example :
{
"status": "success",
"data": {
"exchange": "NSE",
"token": "10940",
"symbol": "DIVISLAB",
"trading_symbol": "DIVISLAB-EQ",
"company_name": "DIVIS LABORATORIES LTD",
"expiry_date": "",
"expiry_date_desc": "",
"strike_price": "",
"lot_size": "1"
}
}
QUERY PARAMETERS
Request Parameter | Description | Mandatory |
---|---|---|
s | Search Symbol | Yes |
RESPONSE ATTRIBUTES
Attributes | Datatype | Description |
---|---|---|
exchange | string | Exchange |
token | string | Symbol Token |
symbol | string | Symbol |
trading_symbol | string | Trading Symbol |
company_name | string | Company Name |
expiry_date | string | Expiry Date |
expiry_date_desc | string | Expiry Date Description |
strike_price | string | Strike Price |
lot_size | string | Lot size |
Logout
# Here is a curl example
curl --location --request GET 'https://api.gwcindia.in/v1/logout' \
--header 'x-api-key: 2e4c1f0ac084dd6b30fd808e016be3f0' \
--header 'Authorization: Bearer 6cb7ac3a5a73831ec88ee8915bee3f2a'
To get characters you need to make a GET call to the following url :
https://api.gwcindia.in/v1/logout
Result Example:
{
"status": "success",
"data": {
"check": "OK"
}
}
RESPONSE ATTRIBUTES
Attribute | Datatype | Description |
---|---|---|
check | string | OK / NOT_OK |
Appendix
Postman Collection
Download and import the postman collection from here
Exchange List
NSE - EQUITY
BSE - EQUITY
MCX - COMMODITY
NFO - DERIVATIVE
CDS - CURRENCY
Exchange Segment
nse_cm - NSE EQUITY
bse_cm - BSE EQUITY
nse_fo - NFO DERIVATIVE
mcx_fo - MCX COMMODITY
Product Codes
NRML - NORMAL
CNC - Cash and Carry
MIS - Intraday
CO - Cover order
BO - Bracket order
Order Types
L - LIMIT
MKT - Market
SL-L - Stop Loss Limit
SL-M - Stop Loss Market
Transaction Types
B - Buy
S - Sell