ICP connection data

API change history

The ICP connection data API provides two functions to get data on Installation Control Points (ICP):

  • The GET action - a search function, allows searching by via address filters and returns matching results allowing the correct ICP to be identified.
  • The GET action - get by id, takes a single ICP and returns detailed information about it.
  • The GET action - get by id list, takes a single or comma separated list of ICPs and returns detailed information about them.

A management policy is set on this API restricting users to 250 calls per minute for ‘search’ and ‘get by id’ calls while calls for multiple ICPs ‘get by id list’ are restricted to 10 calls per minute and/or 60 MB of data per hour.

A glossary of terms used in the returned data format can be found here.

NOTE - in order to use the ICP connection data you must subscribe to the ICP connection data API product to receive your API key.

Get by id

Provide a single ICP to return its details. This will always return a list. Any lower case characters in the ICP will be converted to upper case.

Try it

Request

Request URL

Request parameters

  • string

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Success

Representations

{
  "Address": {
    "PhysicalAddressUnit": "string",
    "PhysicalAddressNumber": "string",
    "PhysicalAddressStreet": "string",
    "PhysicalAddressSuburb": "string",
    "PhysicalAddressTown": "string",
    "PhysicalAddressRegion": "string",
    "PhysicalAddressPostCode": 0,
    "GPS_Easting": 0,
    "GPS_Northing": 0
  },
  "Network": {
    "Network": "string",
    "POC": "string",
    "ReconciliationType": "string",
    "GenerationCapacity": 0,
    "FuelType": "string",
    "DirectBilledStatus": "string"
  },
  "Pricing": {
    "DistributorPriceCategoryCode": "string",
    "DistributorLossCategoryCode": "string",
    "ChargeableCapacity": 0,
    "DistributorInstallationDetails": "string"
  },
  "Trader": {
    "Trader": "string",
    "DailyUnmeteredkWh": "string",
    "UnmeteredLoadDetails": "string"
  },
  "Metering": {
    "MeteringEquipmentProvider": "string",
    "InstallationInformation": [
      {
        "MeteringInstallationCategory": 0,
        "MeteringInstallationType": "string",
        "ComponentInformation": [
          {
            "MeteringComponentSerialNumber": "string",
            "MeterType": "string",
            "AMIFlag": true,
            "CompensationFactor": 0,
            "ChannelInformation": [
              {
                "MeteringComponentSerialNumber": "string",
                "ChannelNumber": 0,
                "RegisterContentCode": "string",
                "PeriodOfAvailability": "string",
                "UnitOfMeasurement": "string",
                "EnergyFlowDirection": "string",
                "AccumulatorType": "string"
              }
            ]
          }
        ]
      }
    ]
  },
  "ICPIdentifier": "string",
  "ICPStatus": 0,
  "Messages": [
    "string"
  ]
}
{
  "type": "object",
  "properties": {
    "Address": {
      "type": "object",
      "properties": {
        "PhysicalAddressStreet": {
          "type": "string"
        },
        "PhysicalAddressSuburb": {
          "type": "string"
        },
        "PhysicalAddressTown": {
          "type": "string"
        },
        "PhysicalAddressRegion": {
          "type": "string"
        },
        "PhysicalAddressPostCode": {
          "format": "int32",
          "type": "integer"
        },
        "GPS_Easting": {
          "format": "double",
          "type": "number"
        },
        "GPS_Northing": {
          "format": "double",
          "type": "number"
        }
      }
    },
    "Network": {
      "type": "object",
      "properties": {
        "Network": {
          "type": "string"
        },
        "POC": {
          "type": "string"
        },
        "ReconciliationType": {
          "type": "string"
        },
        "GenerationCapacity": {
          "format": "double",
          "type": "number"
        },
        "FuelType": {
          "type": "string"
        },
        "DirectBilledStatus": {
          "type": "string"
        }
      }
    },
    "Pricing": {
      "type": "object",
      "properties": {
        "DistributorPriceCategoryCode": {
          "type": "string"
        },
        "DistributorLossCategoryCode": {
          "type": "string"
        },
        "ChargeableCapacity": {
          "format": "double",
          "type": "number"
        },
        "DistributorInstallationDetails": {
          "type": "string"
        }
      }
    },
    "Trader": {
      "type": "object",
      "properties": {
        "Trader": {
          "type": "string"
        },
        "DailyUnmeteredkWh": {
          "type": "string"
        },
        "UnmeteredLoadDetails": {
          "type": "string"
        }
      }
    },
    "Metering": {
      "type": "object",
      "properties": {
        "MeteringEquipmentProvider": {
          "type": "string"
        },
        "InstallationInformation": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "MeteringInstallationCategory": {
                "format": "int32",
                "type": "integer"
              },
              "MeteringInstallationType": {
                "type": "string"
              },
              "ComponentInformation": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "MeteringComponentSerialNumber": {
                      "type": "string"
                    },
                    "MeterType": {
                      "type": "string"
                    },
                    "AMIFlag": {
                      "type": "boolean"
                    },
                    "CompensationFactor": {
                      "format": "double",
                      "type": "number"
                    },
                    "ChannelInformation": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "MeteringComponentSerialNumber": {
                            "type": "string"
                          },
                          "ChannelNumber": {
                            "format": "int32",
                            "type": "integer"
                          },
                          "RegisterContentCode": {
                            "type": "string"
                          },
                          "PeriodOfAvailability": {
                            "type": "string"
                          },
                          "UnitOfMeasurement": {
                            "type": "string"
                          },
                          "EnergyFlowDirection": {
                            "type": "string"
                          },
                          "AccumulatorType": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "ICPIdentifier": {
      "type": "string"
    },
    "ICPStatus": {
      "format": "int32",
      "type": "integer"
    },
    "Messages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

503 Service Unavailable

Problems connecting to underlying service

403 Forbidden

Forbidden

429 Too many requests

The management policy has been exceeded on the API. See the website for policy details.

Code samples

@ECHO OFF

curl -v -X GET "https://emi.azure-api.net/ICPConnectionData/single/?id={ICP}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://emi.azure-api.net/ICPConnectionData/single/?id={ICP}&" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://emi.azure-api.net/ICPConnectionData/single/?id={ICP}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://emi.azure-api.net/ICPConnectionData/single/?id={ICP}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://emi.azure-api.net/ICPConnectionData/single/?id={ICP}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://emi.azure-api.net/ICPConnectionData/single/?id={ICP}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('emi.azure-api.net')
    conn.request("GET", "/ICPConnectionData/single/?id={ICP}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('emi.azure-api.net')
    conn.request("GET", "/ICPConnectionData/single/?id={ICP}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://emi.azure-api.net/ICPConnectionData/single/?id={ICP}')

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body