Skip to main content

GET INTEROP CONFIGURATION

This API retrieves the Interoperability (Interop) configuration configured for a user, including preferred exchanges and combined segment mappings.

🔍 Query Parameters

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringSuccess message"Interop configuration fetched successfully"
dataarrayList of interop configurationsRefer Data Object Fields

📦 Data Object Fields

FieldTypeDescriptionExample / Enum
sSegmentstringExchange segment"NSE_EQ"
nCombinedSegmentIdintegerCombined segment ID1
nInteropPreferredCCLintegerPreferred interoperability clearing corporation1
nPreferredExchangeforBroadcastintegerPreferred exchange for market data broadcast1
nPreferredExchangeforSquareOffintegerPreferred exchange for square-off operations1
nOMSSequenceNostringOMS 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