CRP Info

This API retrieves the Client Risk Profile (CRP) information for the authenticated user, detailing margin configuration, trading permissions, MTM calculation settings, and auto square-off modes per product type and exchange.

Endpoint: GET /transactional/{tenantId}/v1/crp-info

🔑 Header Parameters

Header	Type	Description	Example
Content-Type	string	Specifies the media type of the request	application/json
Authorization	string	Bearer token for authenticated requests	{{access_token}}
x-api-key	string	API key used to authorize the request	{{x-api-key}}

🔗 Path Parameters

Parameter	Type	Required	Description	Example
tenantId	integer	Yes	Tenant identifier	797

🔍 Query Parameters

Parameter	Type	Required	Description	Example
product_type	string	Yes	Product type filter; use ALL to fetch all products	"ALL"
exchange	string	Yes	Exchange segment to filter the CRP data	"NSE_EQ"

🟢 Success Response - 200 OK

Content-Type: application/json

Field	Type	Description	Example
status	string	Status of API call	"success"
code	string	Response code to user request	"s-101"
message	string	Success message	"Success"
data	array	Array of CRP configuration objects	Refer below

📦 Data Object Fields

Each object in the data array represents the CRP configuration for a specific product type on a given exchange.

🔹 Identity Fields

Field	Type	Description	Example
User ID	string	User identifier for the profile	"AB8727"
Group ID	string	Group to which the user belongs	"DELHI1"
Exchange	string	Exchange segment this configuration applies to	"NSE_EQ"
Product Type	string	Product type this configuration applies to	"INTRADAY", "DELIVERY", "COVER", "MTF"
InstrumentType	string	Instrument type; empty for all instruments	""
Reserved	string	Reserved field; typically empty	""
PSBT Template Name	string	Associated PSBT template name	"INTRADAY", "DELIVERY", "MTF", ""

🔹 Margin Configuration Fields

Field	Type	Description	Example
Margin Indicator	integer	Indicates the margin calculation method (0 = percent-based)	0, 1
Prime Margin Indicator	integer	Indicates if prime margin rules apply	0
Buy Margin %	number	Margin percentage required for buy orders	100
Sell Margin %	number	Margin percentage required for sell orders	100
Top Up Margin %	number	Additional top-up margin percentage	0
Prefer PSBT	integer	Whether PSBT is preferred for margin calculation (1 = Yes)	1, 0
Allowed List	integer	Whether the scrip allowed-list check is enforced	1, 0
Limit Inclusion	string	Encoded bitmask specifying which limit types are included	"4222124650659843"

🔹 Margin Calculation Inclusion Flags

These flags (1 = Include, 0 = Exclude) control which P&L components are factored into margin calculations.

Field	Type	Description	Example
Include MTM Loss for Margin Calculation	integer	Include MTM loss when computing required margin	1
Include MTM Profit for Margin Calculation	integer	Include MTM profit when computing required margin	0
Include Booked Loss or Margin Calculation	integer	Include booked loss when computing required margin	1
Include Booked Profit for Margin Calculation	integer	Include booked profit when computing required margin	0
Include Exposure Margin for Margin Calculation	integer	Include exposure margin in margin calculation	0
Include Net Premium for Margin Calculation	integer	Include net option premium in margin calculation	0
Include Premium Benefit for Margin Calculation	integer	Include premium benefit in margin calculation	0
Include Brokerage for Margin Calculation	integer	Include brokerage charges in margin calculation	0

🔹 MTM Calculation Inclusion Flags

These flags control which P&L components are factored into MTM (Mark-to-Market) calculations.

Field	Type	Description	Example
Include MTM Loss for MTM Calculation	integer	Include MTM loss when computing net MTM	1
Include MTM Profit for MTM Calculation	integer	Include MTM profit when computing net MTM	1
Include Booked Loss or MTM Calculation	integer	Include booked loss when computing net MTM	1
Include Booked Profit for MTM Calculation	integer	Include booked profit when computing net MTM	1
Include Brokerage for MTM Calculation	integer	Include brokerage charges when computing net MTM	0

🔹 Manual Collateral Inclusion Flags

Field	Type	Description	Example
Include Booked Loss for Include Manual Collateral	integer	Include booked loss when applying manual collateral	0
Include Booked Profit for Include Manual Collateral	integer	Include booked profit when applying manual collateral	0

🔹 Trading Permission Flags

Field	Type	Description	Example
Fresh Buy Allowed	integer	Whether fresh buy orders are allowed (1 = Yes, 0 = No)	1
Fresh Sell Allowed	integer	Whether fresh sell orders are allowed (1 = Yes, 0 = No)	1, 0
Square off Intraday Buy Position Allowed	integer	Whether intraday buy position square-off is allowed	1
Square off Intraday Sell Position Allowed	integer	Whether intraday sell position square-off is allowed	1
Square off Expiry Buy Position Allowed	integer	Whether buy position square-off at expiry is allowed	1
Square off Expiry Sell Position Allowed	integer	Whether sell position square-off at expiry is allowed	0

🔹 Auto Square-Off & Surveillance Flags

Field	Type	Description	Example
Pre Auto Sq Off Mode	integer	Pre-auto square-off mode activation flag (1 = Active)	1, 0
Auto SQ Off Mode	integer	Auto square-off mode activation flag (1 = Active)	1, 0
Force SQ OFF Mode	integer	Force square-off mode activation flag (1 = Active)	0
Check Surveillance for AMO	integer	Whether surveillance check applies to After-Market Orders	0
Trade Modification Surv Mode	integer	Whether surveillance mode is applied on trade modification	1, 0
Max Track IT Order	integer	Maximum number of IT (Intraday) orders allowed to be tracked	9999, 0