APIs

  • EMI | Real-time dispatch

    The real-time dispatch (RTD) API provides three functions:

    • The GET action returns the latest set of real-time dispatches.
    • The POST action enables a subscriber to sign up to receive automatic pushes of real-time dispatch data as it is updated.
    • The DELETE action enables a subscriber to remove their URL from receiving the automatic pushes of real-time dispatch data.

    NOTE - in order to use the EMI real-time data you must subscribe to the EMI real-time data API product to receive your API key.

  • EMI | Real-time prices

    The real-time prices (RTP) API provides three functions:

    • The GET action returns the latest set of real-time or five minute prices.
    • The POST action enables a subscriber to sign up to receive automatic pushes of real-time price data as it is updated.
    • The DELETE action enables a subscriber to remove their URL from receiving the automatic pushes of real-time price data.

    NOTE - in order to use the EMI real-time data you must subscribe to the EMI real-time data API product to receive your API key.

  • ICP connection data

    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 20 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.