API Documentation
76 endpoints across 9 product families.
Mpan Search Optional
MPAN lookup and search endpoints.
| Method | Path | Summary |
|---|---|---|
| GET | /v1/addresses-by-mpan | Get Addresses By MPAN |
| POST | /v1/agent-appointments-bulk | Find Agent Appointment Bulk |
| GET | /v1/dpc-forecast | DPC Get Forecast Endpoint |
| GET | /v1/mpan-search | Get Geospatial Addresses By Postcode |
| GET | /v1/report | Get MPAN report |
| GET | /v4/suppliermsn | V4SupplierMSN v4 API Endpoint |
QuoteBusiness Optional
Extended endpoints for QuoteBusiness subscribers.
| Method | Path | Summary |
|---|---|---|
| GET | /v1/agent-appointment | Find Agent Appointment |
| GET | /v1/find-by-address-serial | Find MPAN By Postcode and MSN |
| GET | /v1/hh-last-update | GetLastUpdate v1 API Endpoint |
| GET | /v1/mpan-communication-details | Get MPAN Comm Details |
| GET | /v1/usage | GetUsage v1 API Endpoint |
| GET | /v1/yearlyhhbyperiod | YearlyHHByPeriod v1 API Endpoint |
| GET | /v2/yearlyhhbyperiod | YearlyHHByPeriod v2 API Endpoint |
QuoteRight Optional
Additional endpoints available on QuoteRight plans.
| Method | Path | Summary |
|---|---|---|
| GET | /v1/dpc-by-attributes | DPC Get By Attributes Endpoint |
| GET | /v1/dpc-by-mpan | DPC Get By MPAN Endpoint |
| POST | /v1/eac-bulk | EAC innovation API Endpoint |
| POST | /v1/eacfulltpr-bulk | GetEacFullTpr Innovation API Endpoint |
| GET | /v1/encmpanadditionaldetails | EncMPANAdditionalDetails v1 API Endpoint |
| GET | /v1/encmpandetails | V1EncMpanDetails v1 API Endpoint |
| POST | /v1/metersmapping-bulk | MPAN Meter Mapping Innovation API Endpoint |
| POST | /v1/meterstechdetail-bulk | MPAN Meter Tech Detail Innovation API Endpoint |
| GET | /v1/mhhs-mpantoplinedetails | MHHS MPAN Top Line Details |
| GET | /v1/mpanadditionaldetails | MPANAdditionalDetails v1 API Endpoint |
| POST | /v1/mpanadditionaldetails-bulk | MPANAdditionalDetails v1 API Endpoint |
| POST | /v1/mpantoplinedetails-bulk | MpanTopLineDetails innovation API Endpoint |
| GET | /v1/substituteeacfulltpr | Substitute EAC FullTPR |
| GET | /v1/validate-mpan-postcode | Validate MPAN Postcode |
| POST | /v2/eac-bulk | EAC v2 API Endpoint |
| GET | /v2/eacfulltpr | GetEacFullTpr v2 API Endpoint |
| GET | /v2/encmpanpostcodesearch | EncMPANPostcodeSearch v2 API Endpoint |
| POST | /v2/mpanadditionaldetails-bulk | MPAN Additional Detail v2 API Endpoint |
| GET | /v3/encmpaneacfulltpr | GetEncFullTpr v3 API Endpoint |
| GET | /v3/encmpanpostcodesearch | V3EncMpanPostcodeSearch v3 API Endpoint |
| GET | /v3/suppliermsn | MPAN Supplier MSN v3 API Endpoint |
QuoteRight Mandatory
Core endpoints included in every QuoteRight subscription.
| Method | Path | Summary |
|---|---|---|
| GET | /v1/eac | EAC v1 API Endpoint |
| GET | /v1/eacfulltpr | EACFullTPR v1 API Endpoint |
| GET | /v1/encmpaneacfulltpr | EncMPANEACFullTPR v1 API Endpoint |
| GET | /v1/encmpanpostcodesearch | EncMPANPostcodeSearch v1 API Endpoint |
| GET | /v1/metersmapping | MPAN Meter Mapping v1 API Endpoint |
| GET | /v1/meterstechdetail | MPAN Meter Tech Detail v1 API Endpoint |
| GET | /v2/eac | EAC v2 API Endpoint |
| GET | /v2/mpanadditionaldetails | MPAN Additional Detail v2 API Endpoint |
Other
Miscellaneous endpoints including EDA, rota, smart street, and more.
| Method | Path | Summary |
|---|---|---|
| GET | /v1/eda | EDA Post Request Endpoint |
| POST | /v1/eda | EDA Post Request Endpoint |
| DELETE | /v1/eda | EDA Delete MPAN Endpoint |
| GET | /v1/eda/list | EDA List Endpoint |
| GET | /v1/eda/validate | EDA Check Response Endpoint |
| GET | /v1/filteredmpanhhbyperiodrestricted | DNOMultiParam v1 API Endpoint |
| GET | /v1/filteredmpanhhbyperiodrestrictedbympan | DNOMpan v1 API Endpoint |
| GET | /v1/filteredmpanhhbyperiodrestrictedenc | DNOMpanAlias v1 API Endpoint |
| POST | /v1/meter-read-register-bulk | Meter Reads Register Bulk |
| GET | /v1/mhhs-migration-status | MHHS Migration Status |
| GET | /v1/mpantoplinedetails | MpanTopLineDetails v1 API Endpoint |
| GET | /v1/pre-mhhs-mtds-snapshot | Pre MHHS MTDS Snapshot |
| GET | /v1/recco/address-update-list | Recco Address Update List v1 API Endpoint |
| GET | /v1/recco/address-update-report | Recco Address Update Report v1 API Endpoint |
| GET | /v1/rota-code | Find Rota Code |
| POST | /v1/rota-codes-bulk | Find Rota Codes Bulk |
| GET | /v1/smart-street/get-percentage | GetPercentage smart-street API Endpoint |
| GET | /v2/mpantoplinedetails | MpanTopLineDetails v2 API Endpoint |
QuoteBusiness Mandatory
Core endpoints for QuoteBusiness subscribers.
| Method | Path | Summary |
|---|---|---|
| GET | /v1/filteredmpanhhbyperiod | FilteredMPANHHByPeriod v1 API Endpoint |
| GET | /v1/filteredmpanhhcombined | FilteredMPANHHCombined v1 API Endpoint |
| GET | /v1/hhadditionaldetails | HHAdditionalDetails v1 API Endpoint |
| GET | /v1/mpanhhcombined | MPANHHCombined v1 API Endpoint |
| GET | /v1/mpanhhperperiod | MPANHHPerPeriod v1 API Endpoint |
Meter Reads Mandatory
Standard meter reading endpoints.
| Method | Path | Summary |
|---|---|---|
| GET | /v1/latest-meter-reads | Latest Meter Reads |
| GET | /v1/meter-read-date | Meter Reads Date |
| GET | /v1/meter-read-date-extended | Meter Reads Date Extended |
| GET | /v1/meter-read-register | Meter Reads Register |
| GET | /v1/meter-read-register-extended | Meter Reads Register Extended |
Meter Reads Optional
Bulk and extended meter reading endpoints.
| Method | Path | Summary |
|---|---|---|
| POST | /v1/latest-meter-reads | Latest Meter Reads Bulk |
| POST | /v1/meter-read-date-bulk | Meter Reads Date Bulk |
| POST | /v1/meter-read-date-extended-bulk | Meter Reads Date Extended Bulk |
| POST | /v1/meter-read-register-extended | Meter Reads Register Extended Bulk |
| GET | /v1/switched-user/opening-read | Find Switched User Opening Read |
Quote Business Plus Optional
Premium endpoints for Quote Business Plus.
| Method | Path | Summary |
|---|---|---|
| GET | /v2/mpanhhperperiod | GetPerPeriod v2 API Endpoint |