Checks an Order against Position Limits rules

Accepts a JSON body representing the Order to be placed.

Sample Request Body :

{
    "Instruments": [
        {
            "Properties": {
                "InstrumentId": "FT_Future1",
                "InstrumentName": "FT_Future1",
                "AssetClass": "Future",
                "CommoditySymbol": "SI",
                "DeliveryMonth": "2024-08",
                "IsCashSettled": true,
                "Delta": 1,
                "OpenInterestSingleMonth": 5000,
                "Market": "XNYM"
            }
        }
    ],
    "Asset": {
        "Properties": {
            "Quantity": 2000,
            "AssetId": "Asset_FT_Future1",
            "AssetName": "Asset_FT_Future1",
            "InstrumentId": "FT_Future1"
        }
    },
    "PortfolioId": "11",
    "OrderType": "Buy",
    "Timestamp": "2025-04-01T00:00:00Z",
}
        

Sample Response:

{
    "orderId": "c825bbed-aeae-4dfb-b397-76ccd849dc5e",
    "failed": [
        {
            "ruleName": "Single Month",
            "ruleId": 7003,
            "ruleInstanceId": "530e69dd-c987-4210-b26a-3f59d634e722",
            "results": [
                {
                    "ruleName": "Spot Month Cash Settled",
                    "ruleId": 7006,
                    "ruleInstanceId": "cc448f82-dc42-4c2d-b0a5-961f7bbe56a8",
                    "results": [
                        {
                            "spotEffectiveDate": "2024-07-30",
                            "limits": [
                                {
                                    "effectiveDate": "2024-07-30",
                                    "value": 3000
                                }
                            ],
                            "alertType": "Breach",
                            "limitType": "SpotMonth",
                            "limitLevel": "Limit",
                            "nettingMethod": "Net Long / Short (Cash Settled)",
                            "portfolioId": "FAEC",
                            "exchange": "XNYM",
                            "assetClass": "Future",
                            "contractCode": "SI",
                            "contractMonth": "2024-08",
                            "convertedValue": 8000,
                            "limitValue": 3000,
                            "roomToLimit": -5000,
                            "percentageOfLimit": 266.67
                        }
                    ]
                },
                {
                    "ruleName": "All Month",
                    "ruleId": 7005,
                    "ruleInstanceId": "a5484360-cca3-4825-b6db-4cc212aa7dfd",
                    "results": [
                        {
                            "alertType": "AccountabilityLevelCrossed",
                            "limitType": "AllMonth",
                            "limitLevel": "Accountability",
                            "nettingMethod": "Net Long / Short",
                            "portfolioId": "FAEC",
                            "exchange": "XNYM",
                            "assetClass": "Future",
                            "contractCode": "SI",
                            "contractMonth": "2024-08",
                            "convertedValue": 8000,
                            "limitValue": 6000,
                            "roomToLimit": -2000,
                            "percentageOfLimit": 133.33
                        }
                    ]
                }
            ]
        }
    ],
    "upcoming": [],
    "passed": [],
    "unknown": [],
    "totalRulesChecked": [
        {
            "portfolioId": "FAEC",
            "totalRulesChecked": 17
        },
        {
            "portfolioId": "DEM",
            "totalRulesChecked": 12
        }
    ]
}