Skip to content

ReportsApi.md

Latest commit

 

History

History
128 lines (84 loc) · 3.49 KB

ReportsApi.md

File metadata and controls

128 lines (84 loc) · 3.49 KB

ks_api_client.ReportsApi

All URIs are relative to https://tradeapi.kotaksecurities.com/apim

Method Description
order_report Get order report
trade_report Get trade report

order_report

object order_report(order_id)

Get order report

Returns the full order report for a client in case order_id is not provided else returns the order report for a client of provided order_id.

Example

from ks_api_client import ks_api

client = ks_api.KSTradeApi(access_token = "access_token", userid = "userid", \
                 consumer_key = "consumer_key", ip = "IP", app_id = "app_id")

#First initialize session and generate session token
try:
    # Get full order report
    client.order_report()
	
    # Get order report by order id
    client.order_report(order_id = "2200922000576")

except Exception as e:
    print("Exception when calling ReportsApi->order_report: %s\n" % e)

Parameters

Name Type Description Notes
order_id str Order ID of the order [optional]

Return type

object

HTTP request headers

  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Order Report of a client -
400 Invalid or missing input parameters -
403 Invalid session, please re-login to continue -
429 Too many requests to the API -
500 Unexpected error -
502 Not able to communicate with OMS -
503 Trade API service is unavailable -
504 Gateway timeout, trade API is unreachable -

[Back to top] [Back to API list] [Back to README]

trade_report

object trade_report(order_id)

Get trade report

Returns the full trade report for a client in case order_id is not provided else returns the trade report for a client of provided order_id.

Example

from ks_api_client import ks_api

client = ks_api.KSTradeApi(access_token = "access_token", userid = "userid", \
                 consumer_key = "consumer_key", ip = "IP", app_id = "app_id")
				
#First initialize session and generate session token

try:
    # Get full trade report
    client.trade_report()
	
    # Get trade report by order id
    client.trade_report(order_id = "2200922000576")
	
except ApiException as e:
    print("Exception when calling ReportsApi->trade_report: %s\n" % e)

Parameters

Name Type Description Notes
order_id str Order ID of the order [optional]

Return type

object

HTTP request headers

  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Trade Report of a client -
400 Invalid or missing input parameters -
403 Invalid session, please re-login to continue -
429 Too many requests to the API -
500 Unexpected error -
502 Not able to communicate with OMS -
503 Trade API service is unavailable -
504 Gateway timeout, trade API is unreachable -

[Back to top] [Back to API list] [Back to README]