Getting Started
Modern Algos is a platform built with an idea of seamless integration through Exchange approved REST APIs. The APIs are robust which execute and modify orders realtime, allow creating strategies, and much more. The endpoints accept JSON or form-encoded requests and the response returned is also of the JSON format.
Signup
Create an account to get started.
SignUp
Register a new user account with required details.
curl --request POST \
--url https://localhost:44338/ap_registration \
--header 'Content-Type: application/json' \
--header 'Source: SourceName'
Request Structure
{"registrationtype":"RA","registrationtypeothers":"-","registrationno":"007","firstname":"Ram","lastname":"Nivas","website":"https://ayodhya.com","mobileno":"9999999999","emailid":"xxx@gmail.com","companyname":"Ayodhya","address":"Hyd","aum":"5Cr +","noofclients":"100+","experience":"10+ Yrs"}
Request Parameters
| Field |
Type |
Description |
| registrationtype |
string |
Type of registration of the individual or entity |
| registrationtypeothers |
string |
Additional information if the registration type is marked as 'Other' |
| registrationno |
string |
Official registration number assigned to the entity |
| firstname |
string |
First name of the registered individual |
| lastname |
string |
Last name of the registered individual |
| website |
string |
Official website URL of the registered entity or individual |
| mobileno |
string |
Contact mobile number |
| emailid |
string |
Email address for communication |
| companyname |
string |
Name of the company or organization |
| address |
string |
Physical address of the registered entity or individual |
| aum |
string |
Total assets under management |
| noofclients |
string |
Number of clients served |
| experience |
string |
Total years of experience in the industry |
Response Structure
{"status":"FAILURE","reason":"Mobile No already exists."}
Response Parameters
| Field |
Type |
Description |
| status |
string |
Represents the result of the request, indicating whether it was successful. |
| reason |
string |
Provides a descriptive message explaining the result of the operation. |
Login
A secure page where users enter credentials to access their account.
Login/Resend OTP
Authenticate the user with credentials to access the account.
curl --request POST \
--url https://localhost:44338/ap_sendotp \
--header 'Content-Type: application/json' \
--header 'Source: SourceName'
Request Structure
{"mobileno":"99XXXXXX99"}
Request Parameters
| Field |
Type |
Description |
| mobileno |
string |
User's mobile number |
Response Structure
{"status":"SUCCESS","reason":"OTP sent on registered mobile number"}
Response Parameters
| Field |
Type |
Description |
| status |
string |
Status of the service response |
| reason |
string |
Reason for the failure or success of the response |
Verify OTP
Authenticate the user with credentials to access the account.
curl --request POST \
--url https://localhost:44338/ap_login \
--header 'Content-Type: application/json' \
--header 'Source: SourceName'
Request Structure
{"mobileno":"99XXXXXX99","otp":"858822"}
Request Parameters
| Field |
Type |
Description |
| mobileno |
string |
User's mobile number |
| otp |
string |
The one-time password sent to the user's mobile for authentication. |
Response Structure
{"status":"Success","reason":"-","vendorname":"AanlystPortal","accesstoken":"2bQZ0UoBOd0a3Y%2bykjSWXzDM","profile_window":"hide","profileapproved":"yes","fistname":"Ram","lastname":"Ram","website":"https://ram.com","uidvalue":16,"mobileno":"99XXXXXXX99","emailid":"xxx@gmail.com","experience":"0","companyname":"ayodhya"}
Response Parameters
| Field |
Type |
Description |
| status |
string |
Indicates the response status of the service |
| reason |
string |
Provides the reason if the status is not successful |
| vendorname |
string |
Name of the vendor platform |
| accesstoken |
string |
Authentication token for session access |
| profile_window |
string |
Visibility status of the profile window |
| profileapproved |
string |
Status of the profile approval |
| fistname |
string |
User's first name |
| lastname |
string |
User's last name |
| website |
string |
Official website URL of the user or organization |
| uidvalue |
number |
Unique identification number for the user |
| mobileno |
string |
Registered mobile number |
| emailid |
string |
Registered email address |
| experience |
string |
Total years of professional experience |
| companyname |
string |
Name of the associated company |
Home
Welcome to the Analyst Home on Modern Algos Market Place. Manage your strategies, subscriptions, and track performance.
Strategies
Retrieve available trading strategies.
curl --request POST \
--url https://localhost:44338/ap_dashboard_main \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Response Structure
{"Summary":[{"subscribedusers":0,"aum":0,"plans":5}],"Strategies":[{"planname":"imgtesting","strategyname":"RAM14072025151427","onoff":"on","ip1":122,"pl":0.0}]}
Response Parameters
| Field |
Type |
Description |
| Summary.subscribedusers |
int |
Total number of users currently subscribed |
| Summary.aum |
double |
Total assets under management |
| Summary.plans |
int |
Total number of available plans |
| Strategies.planname |
string |
Name of the plan associated with the strategy |
| Strategies.strategyname |
string |
Unique name or identifier of the strategy |
| Strategies.onoff |
string |
Status of the strategy indicating whether it is active or not |
| Strategies.ip1 |
int |
Input parameter or identifier used within the strategy logic |
| Strategies.pl |
double |
Profit or loss value associated with the strategy |
Profile
Manage your Analyst Profile on Modern Algos Market Place.
Profile
Fetch user profile details.
curl --request POST \
--url https://localhost:44338/ap_profile \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Response Structure
[{"registrationno":"finaltesting007","firstname":"Ram","emailid":"ram@gmail.com","mobileno":"99XXXXXX99","companyname":"ayodhya","address":"Ayodhya","website":"https://ram.com","aum":0.00,"noofclients":0,"experience":"0","description":"profile description","termsconditions":"profile terms and condition ","disclosures":"profile disclosures ","support_contact":"99XXXXXX99","support_emailid":"ram@ayodhya.com","lastname":"Ram","gstno":"464656465645457","panno":"BBBPV1234F","bank_accno":"22222222222222222222","ifsccode":"22222222222","name_in_bank":"Ram Ram","registrationtype":"-","about_himself":"","image_url":"-","registrationothers":"-","companyentityname":"ramnivas","managerprofiledesc":"Analysts description ","analystphoto":"16Ramanalyst.png","experienceincapitalmarket":"5 - 10Yrs","profilephoto":"16Ramprofile.png"}]
Response Parameters
| Field |
Type |
Description |
| registrationno |
string |
Unique registration number of the profile |
| firstname |
string |
First name of the individual |
| emailid |
string |
Email address of the individual |
| mobileno |
string |
Mobile number of the individual |
| companyname |
string |
Name of the company |
| address |
string |
Complete address of the individual or company |
| website |
string |
Official website URL |
| aum |
int |
Assets under management |
| noofclients |
int |
Total number of clients |
| experience |
string |
Years of experience |
| description |
string |
Profile description |
| termsconditions |
string |
Terms and conditions of the profile |
| disclosures |
string |
Disclosures related to the profile |
| support_contact |
string |
Support contact number |
| support_emailid |
string |
Support email address |
| lastname |
string |
Last name of the individual |
| gstno |
string |
GST number of the company |
| panno |
string |
PAN number of the individual or company |
| bank_accno |
string |
Bank account number |
| ifsccode |
string |
IFSC code of the bank |
| name_in_bank |
string |
Name as per bank account |
| registrationtype |
string |
Type of registration |
| about_himself |
string |
Brief about the individual |
| image_url |
string |
URL of the profile image |
| registrationothers |
string |
Additional registration information |
| companyentityname |
string |
Registered company entity name |
| managerprofiledesc |
string |
Description of the manager's profile |
| analystphoto |
string |
Filename of the analyst photo |
| experienceincapitalmarket |
string |
Experience in the capital market |
| profilephoto |
string |
Filename of the profile photo |
Profile & Billing Details
Update user profile and billing information.
curl --request POST \
--url https://localhost:44338/ap_update_profile \
--header 'Content-Type: application/json' \
----header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Request Structure
{"firstname":"Y","lastname":"U","description":"desc ","website":"-","termsconditions":"desc ","disclosures":"desc ","support_contact":"6767676767","support_emailid":"y@gmail.com","gstno":"itortrtreueutur","panno":"ASNPV8214H","bank_accno":"77777777777777777777","ifsccode":"77XXXXXX77","name_in_bank":"me","companyentityname":"Yme","managerprofiledesc":"desc ","analystphoto":"","experienceincapitalmarket":"0 - 2Yrs","profilephoto":""}
Request Parameters
| Field |
Type |
Description |
| firstname |
string |
User's first name |
| lastname |
string |
User's last name |
| description |
string |
Short profile description |
| website |
string |
Personal or company website |
| termsconditions |
string |
Terms and conditions information |
| disclosures |
string |
Disclosure details |
| support_contact |
string |
Support contact number |
| support_emailid |
string |
Support email address |
| gstno |
string |
GST number |
| panno |
string |
PAN number |
| bank_accno |
string |
Bank account number |
| ifsccode |
string |
Bank IFSC code |
| name_in_bank |
string |
Name as per bank records |
| companyentityname |
string |
Company or entity name |
| managerprofiledesc |
string |
Manager's profile description |
| analystphoto |
string |
URL or path to analyst photo |
| experienceincapitalmarket |
string |
Capital market experience duration |
| profilephoto |
string |
URL or path to profile photo |
Response Structure
{"status":"SUCCESS","reason":"Updated Successfully."}
Response Parameters
| Field |
Type |
Description |
| status |
string |
Represents the result of the request, indicating whether it was successful. |
| reason |
string |
Provides a descriptive message explaining the result of the operation. |
Subscriber Details
Monitor your subscribers and track their subscriptions on Modern Algos Market Place. Stay updated on their engagement with your strategies.
Subscriber Details
Fetch details of subscribers or linked accounts.
curl --request POST \
--url https://localhost:44338/ap_dashboard_user \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Response Structure
{"Details":[{"clientname":"Taduru Rahul","clientmobile":"9290108389","clientemailid":"rahultaduru@rediffmail.com","clientcode":"HY765","vendorname":"BNRATHI","planname":"ALL","subscription_date":"0000-00-00","validity":"2026-07-01","pl":27696}]}
Response Parameters
| Field |
Type |
Description |
| Details.clientname |
string |
Name of the client |
| Details.clientmobile |
string |
Mobile number of the client |
| Details.clientemailid |
string |
Email address of the client |
| Details.clientcode |
string |
Unique code assigned to the client |
| Details.vendorname |
string |
Name of the associated vendor |
| Details.planname |
string |
Name of the subscription plan |
| Details.subscription_date |
string |
Date when the subscription started |
| Details.validity |
string |
Date until which the subscription is valid |
| Details.pl |
int |
Profit or loss amount |
Create Plan
Create a new plan on Modern Algos Market Place and offer your expert strategies to a global audience.
ADD
Add a new plan.
curl --request POST \
--url https://localhost:44338/ap_createplan \
--header 'Content-Type: application/json' \
----header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Request Structure
{"plan_name":"apiplan","plan_description":"api description ","plan_type":"All","plan_image":"","plan_fees":"500","plan_timeframe":"Intraday","plan_capital":"100000","plan_drawdown":"11","avgtradesperday":"66","monday":"true","tuesday":"false","wednesday":"true","thursday":"false","friday":"true","saturday":"false","sunday":"false","expirytype":"","ip1":"0","request":"ADD"}
Request Parameters
| Field |
Type |
Description |
| plan_name |
string |
Name of the plan |
| plan_description |
string |
Short description of the plan |
| plan_type |
string |
Category of the plan |
| plan_image |
string |
URL or path of the plan image |
| plan_fees |
string |
Cost of the plan |
| plan_timeframe |
string |
Trading timeframe of the plan |
| plan_capital |
string |
Initial capital required |
| plan_drawdown |
string |
Maximum expected drawdown |
| avgtradesperday |
string |
Average number of trades per day |
| monday |
string |
Active on Monday |
| tuesday |
string |
Active on Tuesday |
| wednesday |
string |
Active on Wednesday |
| thursday |
string |
Active on Thursday |
| friday |
string |
Active on Friday |
| saturday |
string |
Active on Saturday |
| sunday |
string |
Active on Sunday |
| expirytype |
string |
Type of expiry used |
| ip1 |
string |
Internal identifier or parameter |
| request |
string |
Type of operation to perform |
Response Structure
{"status":"SUCCESS","reason":"Plan Created Successfully."}
Response Parameters
| Field |
Type |
Description |
| status |
string |
Status of the service response |
| reason |
string |
Message indicating the result of the update operation |
View Added Data
Retrieve data of already added plans.
curl --request POST \
--url https://localhost:44338/ap_getplansdetails \
--header 'Content-Type: application/json' \
----header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Request Structure
{"ip1":"83"}
Request Parameters
| Field |
Type |
Description |
| ip1 |
string |
Internal identifier or parameter |
Response Structure
[{"plan_type":"All","plan_image":"","plan_name":"apiplan","plan_fees":500.0,"plan_capital":100000.0,"plan_drawdown":11.0,"plan_timeframe":"Intraday","plan_description":"api description ","a_analyst_name":"ayodhya","a_model_week":4,"a_model_ticket":1,"a_symbolonly":"NIFTY","avgtradesperday":66.0,"monday":"true","tuesday":"false","wednesday":"true","thursday":"false","friday":"true","saturday":"false","sunday":"false","plan_expirytype":""}]
Response Parameters
| Field |
Type |
Description |
| plan_type |
string |
Type of plan applicable |
| plan_image |
string |
Image URL or path for the plan |
| plan_name |
string |
Name of the plan |
| plan_fees |
double |
Subscription fee for the plan |
| plan_capital |
double |
Capital required to follow the plan |
| plan_drawdown |
double |
Maximum expected drawdown percentage |
| plan_timeframe |
string |
Trading timeframe of the plan |
| plan_description |
string |
Detailed description of the plan |
| a_analyst_name |
string |
Name of the analyst managing the plan |
| a_model_week |
int |
Number of weeks the model is active |
| a_model_ticket |
int |
Ticket or instance number of the model |
| a_symbolonly |
string |
Symbol or instrument used in the plan |
| avgtradesperday |
double |
Average number of trades per day |
| monday |
string |
Indicates if the plan runs on Monday |
| tuesday |
string |
Indicates if the plan runs on Tuesday |
| wednesday |
string |
Indicates if the plan runs on Wednesday |
| thursday |
string |
Indicates if the plan runs on Thursday |
| friday |
string |
Indicates if the plan runs on Friday |
| saturday |
string |
Indicates if the plan runs on Saturday |
| sunday |
string |
Indicates if the plan runs on Sunday |
| plan_expirytype |
string |
Type of expiry associated with the plan |
View Plans
Monitor the performance of your plans on Modern Algos Market Place. Keep track of how your subscribers are benefiting from your strategies
Plans
Create a list of plans.
curl --request POST \
--url https://localhost:44338/ap_dashboard_plan \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Response Structure
{"Plans":[{"planname":"apiplan","ip1":83,"live_pl":0.0,"booked_pl":0.0,"noofsubscription":0,"status":"Active"}]}
Response Parameters
| Field |
Type |
Description |
| Plans.planname |
string |
Name of the API plan |
| Plans.ip1 |
int |
Unique identifier or code for the plan |
| Plans.live_pl |
double |
Live profit or loss value |
| Plans.booked_pl |
double |
Booked profit or loss value |
| Plans.noofsubscription |
int |
Total number of active subscriptions |
| Plans.status |
string |
Current status of the plan |
Auto Start On/Off
Toggle auto-start functionality for strategies or plans.
curl --request POST \
--url https://localhost:44338/ap_plan_onoff \
--header 'Content-Type: application/json' \
----header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Request Structure
{"ip1":"50","onoff":"off","planname":"imgtesting"}
Request Parameters
| Field |
Type |
Description |
| ip1 |
string |
IP address or identifier value associated with the service |
| onoff |
string |
Status flag indicating whether the service is active or inactive |
| planname |
string |
Name of the subscribed service plan |
Response Structure
{"status":"SUCCESS","reason":"Deactived Successfully."}
Response Parameters
| Field |
Type |
Description |
| status |
string |
Represents the result of the request, indicating whether it was successful. |
| reason |
string |
Provides a descriptive message explaining the result of the operation. |
Create Strategy
Create and send your trade picks to subscribers on Modern Algos Market Place. Provide timely recommendations and boost your subscribers' success.
Add
Create a new trading strategy.
curl --request POST \
--url https://localhost:44338/ap_createstrategy_new \
--header 'Content-Type: application/json' \
----header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Request Structure
{"plannames":["apiplan"],"strategyname":"RAM27072025194427","request":"ADD","ordertype":"Intraday","FixedProfit":"1000","FixedLoss":"100","Criteria":"Lock & Trail Profit","CriteriaType":"Value","Xvalue":"500","Yvalue":"100","Avalue":"100","Bvalue":"100","tgt_param_sel_leg":"1","tgt_param_sel_strategy":"1","AT_EntryParameters":[{"symbolonly":"TCS","action":"BUY","instrument":"CE","expdate":"2025-07-31","strikeprice":"3140","entryprice":"23.4","targetprice":"1","stoplossprice":"1","qty":"175","ltp":"23.4","ip1":"0","TrailTGT":"1","TrailSL":"1","TrailType":"Pts"}]}
Request Parameters
| Field |
Type |
Description |
| plannames |
array[string] |
List of selected plan names |
| strategyname |
string |
Name of the strategy being added |
| request |
string |
Type of operation requested |
| ordertype |
string |
Type of order execution |
| FixedProfit |
string |
Fixed profit target value |
| FixedLoss |
string |
Fixed loss limit value |
| Criteria |
string |
Selected profit/loss strategy |
| CriteriaType |
string |
Type of criteria used |
| Xvalue |
string |
X-axis value for criteria |
| Yvalue |
string |
Y-axis value for criteria |
| Avalue |
string |
Additional parameter A |
| Bvalue |
string |
Additional parameter B |
| tgt_param_sel_leg |
string |
Target parameter for selected leg |
| tgt_param_sel_strategy |
string |
Target parameter for selected strategy |
| AT_EntryParameters.symbolonly |
string |
Symbol of the stock or instrument |
| AT_EntryParameters.action |
string |
Order action type |
| AT_EntryParameters.instrument |
string |
Instrument type |
| AT_EntryParameters.expdate |
string |
Expiry date of the contract |
| AT_EntryParameters.strikeprice |
string |
Strike price of the option |
| AT_EntryParameters.entryprice |
string |
Price at which to enter the trade |
| AT_EntryParameters.targetprice |
string |
Target price to exit the trade |
| AT_EntryParameters.stoplossprice |
string |
Stop-loss price to limit loss |
| AT_EntryParameters.qty |
string |
Quantity to trade |
| AT_EntryParameters.ltp |
string |
Last traded price of the instrument |
| AT_EntryParameters.ip1 |
string |
Intermediate parameter 1 |
| AT_EntryParameters.TrailTGT |
string |
Trailing target activation |
| AT_EntryParameters.TrailSL |
string |
Trailing stop-loss activation |
| AT_EntryParameters.TrailType |
string |
Type of trailing logic applied |
Response Structure
{"status":"SUCCESS","reason":"Added Successfully."}
Response Parameters
| Field |
Type |
Description |
| status |
string |
Represents the result of the request, indicating whether it was successful. |
| reason |
string |
Provides a descriptive message explaining the result of the operation. |
Plans
Get all plans.
curl --request POST \
--url https://localhost:44338/ap_getplans \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Response Structure
[{"planname":"apiplan"},{"planname":"imgtesting"}]
Response Parameters
| Field |
Type |
Description |
| planname |
string |
Name of the plan |
Update
Update the configuration of an existing strategy.
curl --request POST \
--url https://localhost:44338/ap_strategy_details_new \
--header 'Content-Type: application/json' \
----header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Request Structure
{"planname":"imgtesting","strategyname":"RAM14072025151427","ip2":"16_20250714151441"}
Request Parameters
| Field |
Type |
Description |
| planname |
string |
Name of the selected service plan |
| strategyname |
string |
Unique identifier assigned to the strategy |
| ip2 |
string |
Encoded or formatted timestamp identifier used for tracking or logging |
Response Structure
{"planname":"apiplan","strategyname":"RAM25072025171042","ordertype":"Intraday","FixedProfit":1000.0,"FixedLoss":100.0,"Criteria":"Lock & Trail Profit","CriteriaType":"Value","Xvalue":500.0,"Yvalue":200.0,"Avalue":200.0,"Bvalue":200.0,"tgt_param_sel_leg":1,"tgt_param_sel_strategy":1,"AT_EntryParameters":[{"symbolonly":"ACC","action":"SELL","instrument":"PE","expdate":"2025-07-31","strikeprice":"1820","entryprice":6.9,"targetprice":2.0,"stoplossprice":2.0,"qty":600,"ltp":6.9,"ip1":"144","entrystatus":"disable","exitstatus":"enable","TrailTGT":0.0,"TrailSL":0.0,"TrailType":"Pts"}]}
Response Parameters
| Field |
Type |
Description |
| planname |
string |
Name of the plan assigned to the strategy |
| strategyname |
string |
Unique identifier or name of the trading strategy |
| ordertype |
string |
Defines the type of order used for the trade |
| FixedProfit |
doulbe |
Targeted profit value at which the trade should be exited |
| FixedLoss |
doulbe |
Maximum allowable loss before trade exit |
| Criteria |
string |
Rule or logic used for managing profit/loss |
| CriteriaType |
string |
Specifies the type of value used in the criteria |
| Xvalue |
doulbe |
Custom parameter X used in strategy logic |
| Yvalue |
doulbe |
Custom parameter Y used in strategy logic |
| Avalue |
doulbe |
Custom parameter A used in strategy logic |
| Bvalue |
doulbe |
Custom parameter B used in strategy logic |
| tgt_param_sel_leg |
doulbe |
Indicates which leg is selected for the target parameter |
| tgt_param_sel_strategy |
doulbe |
Indicates which strategy is selected for target parameter |
| AT_EntryParameters.symbolonly |
string |
Trading symbol of the instrument |
| AT_EntryParameters.action |
string |
Type of order action such as buy or sell |
| AT_EntryParameters.instrument |
string |
Instrument type used in the trade |
| AT_EntryParameters.expdate |
string |
Expiry date of the instrument |
| AT_EntryParameters.strikeprice |
string |
Strike price associated with the option |
| AT_EntryParameters.entryprice |
doulbe |
Price at which the position is to be entered |
| AT_EntryParameters.targetprice |
doulbe |
Target price at which the position should exit |
| AT_EntryParameters.stoplossprice |
doulbe |
Price at which the stop loss should trigger |
| AT_EntryParameters.qty |
doulbe |
Quantity of contracts or shares to be traded |
| AT_EntryParameters.ltp |
doulbe |
Last traded price of the instrument |
| AT_EntryParameters.ip1 |
string |
Custom parameter value for internal logic |
| AT_EntryParameters.entrystatus |
string |
Status to control whether entry is allowed |
| AT_EntryParameters.exitstatus |
string |
Status to control whether exit is allowed |
| AT_EntryParameters.TrailTGT |
doulbe |
Trailing target value used for dynamic exits |
| AT_EntryParameters.TrailSL |
doulbe |
Trailing stop-loss value used for dynamic exits |
| AT_EntryParameters.TrailType |
string |
Type of trailing method applied in strategy |
View Strategies
Track the performance of your trading strategies on Modern Algos Market Place. Analyze results and optimize your plans for better outcomes.
Strategies
Retrieve details of a specific strategy.
curl --request POST \
--url https://localhost:44338/ap_dashboard_strategies \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Response Structure
{"Strategies":[{"planname":"apiplan","strategyname":"RAM24072025180348","ip1":"140","ip2":"16_20250724180516","icon1_display":"pause","live_pl":0.0,"booked_pl":0.0,"status":"Open"}]}
Response Parameters
| Field |
Type |
Description |
| Strategies.planname |
string |
Name of the subscribed API plan |
| Strategies.strategyname |
string |
Unique identifier for the strategy |
| Strategies.ip1 |
string |
Input parameter or setting associated with the strategy |
| Strategies.ip2 |
string |
Secondary input or configuration identifier for the strategy |
| Strategies.icon1_display |
string |
UI icon state used for controlling strategy (e.g., pause/resume) |
| Strategies.live_pl |
double |
Current live profit or loss of the strategy |
| Strategies.booked_pl |
double |
Total booked profit or loss already realized |
| Strategies.status |
string |
Current operational status of the strategy |
Actions
Perform delete, update, or resume actions on a strategy.
curl --request POST \
--url https://localhost:44338/ap_strategies_update \
--header 'Content-Type: application/json' \
----header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Request Structure
{"planname":"apiplan","strategyname":"RAM24072025180348","request":"delete"}
Request Parameters
| Field |
Type |
Description |
| planname |
string |
Name of the selected API plan |
| strategyname |
string |
Unique name or identifier for the strategy |
| request |
string |
Type of action to be performed {eg:- delete,pause,resume,squareoff} |
Response Structure
{"status":"SUCCESS","reason":"Strategy deleted successfully."}
Response Parameters
| Field |
Type |
Description |
| status |
string |
Represents the result of the request, indicating whether it was successful. |
| reason |
string |
Provides a descriptive message explaining the result of the operation. |
View History
Fetch historical activity or changes of a strategy.
curl --request POST \
--url https://localhost:44338/ap_strategy_history \
--header 'Content-Type: application/json' \
----header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Request Structure
{"planname":"imgtesting","strategyname":"RAM14072025151427"}
Request Parameters
| Field |
Type |
Description |
| planname |
string |
Name of the selected plan |
| strategyname |
string |
Unique name or identifier for the strategy |
Response Structure
{"History":[{"ordtime":"2025-07-21 09:15:39","content":"NIFTY25JULFUT SELL 225.00@25005.9000"}]}
Response Parameters
| Field |
Type |
Description |
| History.ordtime |
string |
Order timestamp in 'YYYY-MM-DD HH:MM:SS' format |
| History.content |
string |
Order description including symbol, action, quantity, and price |
Report
Get performance or execution reports for a strategy
curl --request POST \
--url https://localhost:44338/ap_strategies_download \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Response Structure
{"Strategies":[{"planname":"apiplan","strategyname":"RAM24072025180348","live_pl":0.0,"booked_pl":0.0}]}
Response Parameters
| Field |
Type |
Description |
| Strategies.planname |
string |
Name of the API plan under which the strategy is created |
| Strategies.strategyname |
string |
Unique identifier for the strategy |
| Strategies.live_pl |
double |
Current live profit or loss value |
| Strategies.booked_pl |
double |
Profit or loss already booked for the strategy |
OrderBook
View and manage your order book with Modern Algos. Track all your active orders, monitor execution status.
Analyst/Client
View order book entries for a user or strategy in the category of Analyst and Clients.
curl --request POST \
--url https://localhost:44338/ap_OrderBook \
--header 'Content-Type: application/json' \
----header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Request Structure
{"category":"analyst"}
Request Parameters
| Field |
Type |
Description |
| category |
string |
The category type assigned to the service. {eg:- analyst,clients} |
Response Structure
[{"Symbol":"NIFTY25JUL24850CE","BuySell":"BUY","ProductType":"INTRADAY","Qty":75.0,"Price":"121.40","LTP":"0.00","OrderTime":"2025-07-27 15:19:49","Status":"TRADED","OrderID":"202571925151949BBTYFY","Remarks":"-","ip1":89,"ip2":"16_apiplan_RAM25072025150129","StrategyName":"16_apiplan_RAM25072025150129","LotSize":75.0,"resendlabel":"False","clientcode":"16"}]
Response Parameters
| Field |
Type |
Description |
| Symbol |
string |
Trading symbol of the instrument |
| BuySell |
string |
Indicates whether the order is a Buy or Sell |
| ProductType |
string |
Specifies the product type for the order |
| Qty |
int |
Quantity of the order placed |
| Price |
string |
Price at which the order was placed |
| LTP |
string |
Last traded price at the time of order |
| OrderTime |
string |
Date and time when the order was placed |
| Status |
string |
Current status of the order |
| OrderID |
string |
Unique identifier for the order |
| Remarks |
string |
Any additional comments or notes about the order |
| ip1 |
int |
Internal parameter or custom input value 1 |
| ip2 |
string |
Internal parameter or custom input value 2 |
| StrategyName |
string |
Name of the strategy used for the order |
| LotSize |
int |
Lot size of the trading instrument |
| resendlabel |
string |
Indicates whether the order needs to be resent |
| clientcode |
string |
Client identification code |
Resend Order
Re-trigger/resend a specific order.
curl --request POST \
--url https://localhost:44338/push_reorder \
--header 'Content-Type: application/json' \
----header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Request Structure
{"ip1":"90","ip2":"16_apiplan_RAM25072025150129","category":"analyst","clientcode":"16"}
Request Parameters
| Field |
Type |
Description |
| ip1 |
string |
Unique identifier for the service instance |
| ip2 |
string |
Plan identifier associated with the API service |
| category |
string |
Identify the User's order category {eg:- analyst,clients} |
| clientcode |
string |
Client-specific code assigned to the user |
Response Structure
{"status":"SUCCESS","reason":"Order Sent Successful."}
Response Parameters
| Field |
Type |
Description |
| status |
string |
Represents the result of the request, indicating whether it was successful. |
| reason |
string |
Provides a descriptive message explaining the result of the operation. |
Common Services
A set of frequently used features or tools available across the platform.
Expiry Date
The date on which a contract or option becomes invalid.
curl --request POST \
--url https://localhost:44338/retrieve_expdate \
--header 'Content-Type: application/json' \
----header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Request Structure
{"symbol":"NIFTY","instrument":"CE"}
Request Parameters
| Field |
Type |
Description |
| symbol |
string |
The trading symbol of the instrument |
| instrument |
string |
The type of financial instrument |
Response Structure
[{"ExpDate":"2025-07-17"},{"ExpDate":"2025-07-24"}]
Response Parameters
| Field |
Type |
Description |
| ExpDate |
string |
Expiry date in YYYY-MM-DD format |
Strike Price
The fixed price at which an option can be exercised.
curl --request POST \
--url https://localhost:44338/retrieve_strikes \
--header 'Content-Type: application/json' \
----header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Request Structure
{"symbol":"NIFTY","instrument":"ce","expdate":"2025-07-17"}
Request Parameters
| Field |
Type |
Description |
| symbol |
string |
The trading symbol of the instrument |
| instrument |
string |
The type of financial instrument |
| expdate |
string |
The expiry date of the instrument in YYYY-MM-DD format |
Response Structure
[{"StrikePrice":"19450.00","StrikeType":"ATM-114"},{"StrikePrice":"19500.00","StrikeType":"ATM-113"}]
Response Parameters
| Field |
Type |
Description |
| StrikePrice |
string |
Strike price of the option. |
| StrikeType |
string |
Type and identifier of the strike price. |
Get LTP
Fetches the latest traded price of a security.
curl --request POST \
--url https://localhost:44338/getlatestprice \
--header 'Content-Type: application/json' \
----header 'Authorization: Bearer AccessToken' \
--header 'Source: SourceName'
Request Structure
{"symbol":"NIFTY","expdate":"2025-07-17","strikeprice":"25150","instrument":"CE","buysell":"buy"}
Request Parameters
| Field |
Type |
Description |
| symbol |
string |
Represents the name of the financial index or asset. |
| expdate |
string |
The expiry date of the option contract. |
| strikeprice |
string |
The strike price at which the option can be exercised. |
| instrument |
string |
Denotes the type of options contract. |
| buysell |
string |
Indicates the action of buying or selling the option. |
Response Structure
[{"Price":"135.1","Delta":"0.5361","Gamma":"0.0013","Theta":"-10.1108","Vega":"12.8245","IV":"9.46","OI":"2073300","OIChg":"2035200","FuturePrice":"25175.8","StrikeType":"ATM","LotSize":"75"}]
Response Parameters
| Field |
Type |
Description |
| Price |
string |
Current option price |
| Delta |
string |
Rate of change in option price relative to the underlying asset price |
| Gamma |
string |
Rate of change of delta with respect to the underlying asset price |
| Theta |
string |
Rate of time decay in the option's price |
| Vega |
string |
Rate of change in option price with respect to volatility |
| IV |
string |
Implied volatility percentage of the option |
| OI |
string |
Open interest indicating total outstanding contracts |
| OIChg |
string |
Change in open interest compared to the previous day |
| FuturePrice |
string |
Current price of the futures contract for the underlying asset |
| StrikeType |
string |
Indicates the relation of the strike to the current price |
| LotSize |
string |
Minimum quantity that can be traded in one lot |