GET INTEROP CONFIGURATION
This API retrieves the Interoperability (Interop) configuration configured for a user, including preferred exchanges and combined segment mappings.
🔍 Query Parameters
| Parameter | Type | Required | Description | Example |
|---|
| userId | string | Yes | User ID (UCC) | "{{user_id}}" |
| Header | Type | Description | Example |
|---|
| Content-Type | string | Request payload format | application/json |
| Authorization | string | Access token for authenticated requests | {{access_token}} |
| x-api-key | string | API key used to authorize request | {{x-api-key}} |
🟢 Success Response - 200 OK
Content-Type: application/json
| Field | Type | Description | Example |
|---|
| status | string | Status of API call | "success" |
| code | string | Response code | "s-101" |
| message | string | Success message | "Interop configuration fetched successfully" |
| data | array | List of interop configurations | Refer Data Object Fields |
📦 Data Object Fields
| Field | Type | Description | Example / Enum |
|---|
| sSegment | string | Exchange segment | "NSE_EQ" |
| nCombinedSegmentId | integer | Combined segment ID | 1 |
| nInteropPreferredCCL | integer | Preferred interoperability clearing corporation | 1 |
| nPreferredExchangeforBroadcast | integer | Preferred exchange for market data broadcast | 1 |
| nPreferredExchangeforSquareOff | integer | Preferred exchange for square-off operations | 1 |
| nOMSSequenceNo | string | OMS sequence number | "1001" |
📝 Notes
- This API provides the user's Interop (Interoperability) configuration settings.
- Used to determine:
- Preferred exchange mappings
- Broadcast exchange preferences
- Square-off exchange preferences
- Combined segment configurations
- Helpful for:
- Multi-exchange trading setups
- Position aggregation
- Interoperability-based order and position management