Update to Room-In-A-Name API for Position Limits

As part of our continual improvement plan, we have made updates to our Position Limits service which will affect the output of the Room-In-A-Name (RIAN) API.

The RIAN API response object produces a list of results with a 'resultType' field. Currently, you can expect the following four values:

OK,
Warning,
Breach,
Unknown,

This change introduces three new values:

OK,
Warning,
Breach,
Unknown,
UpcomingBreach,
ReportingLevelCrossed,
AccountabilityLevelCrossed,

Whereas before these results would have triggered under a Breach result, these will now be split into three separate result types; an upcoming breach, a reporting level crossed, and an accountability level crossed. 

Users who have Room-In-A-Name set up for our Position Limits service should take these changes into account. The example below highlights the different outputs: 

Before:

{
"dataDate": "2023-06-17",
"contractData": [
   {
       ...
       "limitTypes": [
       {
           "name": "SpotMonth",
           "limitLevels": [
           {
               "name": "Accountability",
               "results": [
               {
                   "resultType": "Breach",
                   "limitInEffect": "2023-05-19",
                   "value": 9000.00000000,
                   ...
               }
               ]
           }]
       }]
   }
   ]
}

After:

{
"dataDate": "2023-06-17",
"contractData": [
   {
       ...
       "limitTypes": [
       {
           "name": "SpotMonth",
           "limitLevels": [
           {
               "name": "Accountability",
               "results": [
               {
                   "resultType": "AccountabilityLevelCrossed",
                   "limitInEffect": "2023-05-19",
                   "value": 9000.00000000,
                   ...
               }
               ]
           }]
       }]
   }
   ]
}

FAQ

Can I continue using the old version of Position Limits RIAN?

No, we stopped support for the old RIAN output in 2023.

Was this article helpful?
0 out of 0 found this helpful
Share article