public

Resolve the electric meter (ESIID) for a service address

Texas (ERCOT) electricity enrollment needs the meter’s ESIID, which a customer would otherwise have to read off a utility bill. Given a street line and ZIP, returns every meter the source matched plus resolved — the single meter the address unambiguously maps to (one match, or the one whose unit matches). A multi-unit building with no unit given returns the matches and a null resolved so the customer can pick. Never errors on an out-of-market address or an upstream failure: both come back empty, and checkout falls back to the manual field. Unauthenticated, lightly rate-limited per IP.

POST

public

shop

esiid-lookup

Resolve the electric meter (ESIID) for a service address

curl --request POST \
  --url https://api.offergrid.io/public/shop/esiid-lookup \
  --header 'Content-Type: application/json' \
  --data '
{
  "street": "123 Main St",
  "state": "TX",
  "zipCode": "78701",
  "unit": "Apt 4B",
  "city": "Austin"
}
'

import requests

url = "https://api.offergrid.io/public/shop/esiid-lookup"

payload = {
    "street": "123 Main St",
    "state": "TX",
    "zipCode": "78701",
    "unit": "Apt 4B",
    "city": "Austin"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    street: '123 Main St',
    state: 'TX',
    zipCode: '78701',
    unit: 'Apt 4B',
    city: 'Austin'
  })
};

fetch('https://api.offergrid.io/public/shop/esiid-lookup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.offergrid.io/public/shop/esiid-lookup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'street' => '123 Main St',
    'state' => 'TX',
    'zipCode' => '78701',
    'unit' => 'Apt 4B',
    'city' => 'Austin'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.offergrid.io/public/shop/esiid-lookup"

	payload := strings.NewReader("{\n  \"street\": \"123 Main St\",\n  \"state\": \"TX\",\n  \"zipCode\": \"78701\",\n  \"unit\": \"Apt 4B\",\n  \"city\": \"Austin\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.offergrid.io/public/shop/esiid-lookup")
  .header("Content-Type", "application/json")
  .body("{\n  \"street\": \"123 Main St\",\n  \"state\": \"TX\",\n  \"zipCode\": \"78701\",\n  \"unit\": \"Apt 4B\",\n  \"city\": \"Austin\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.offergrid.io/public/shop/esiid-lookup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"street\": \"123 Main St\",\n  \"state\": \"TX\",\n  \"zipCode\": \"78701\",\n  \"unit\": \"Apt 4B\",\n  \"city\": \"Austin\"\n}"

response = http.request(request)
puts response.read_body

{
  "statusCode": 404,
  "message": "Offer not found",
  "error": "Not Found"
}

{
  "statusCode": 404,
  "message": "Offer not found",
  "error": "Not Found"
}

Body

application/json

street

string

required

Example:

"123 Main St"

state

string

required

Example:

"TX"

zipCode

string

required

Example:

"78701"

unit

string

Unit, when known. The upstream matches on the street line, so the unit is what disambiguates a multi-unit building down to one meter.

Example:

"Apt 4B"

city

string

Example:

"Austin"

Response

Matching meters for the address

Resolve the electric meter (ESIID) for a service address

curl --request POST \
  --url https://api.offergrid.io/public/shop/esiid-lookup \
  --header 'Content-Type: application/json' \
  --data '
{
  "street": "123 Main St",
  "state": "TX",
  "zipCode": "78701",
  "unit": "Apt 4B",
  "city": "Austin"
}
'

import requests

url = "https://api.offergrid.io/public/shop/esiid-lookup"

payload = {
    "street": "123 Main St",
    "state": "TX",
    "zipCode": "78701",
    "unit": "Apt 4B",
    "city": "Austin"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    street: '123 Main St',
    state: 'TX',
    zipCode: '78701',
    unit: 'Apt 4B',
    city: 'Austin'
  })
};

fetch('https://api.offergrid.io/public/shop/esiid-lookup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.offergrid.io/public/shop/esiid-lookup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'street' => '123 Main St',
    'state' => 'TX',
    'zipCode' => '78701',
    'unit' => 'Apt 4B',
    'city' => 'Austin'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.offergrid.io/public/shop/esiid-lookup"

	payload := strings.NewReader("{\n  \"street\": \"123 Main St\",\n  \"state\": \"TX\",\n  \"zipCode\": \"78701\",\n  \"unit\": \"Apt 4B\",\n  \"city\": \"Austin\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.offergrid.io/public/shop/esiid-lookup")
  .header("Content-Type", "application/json")
  .body("{\n  \"street\": \"123 Main St\",\n  \"state\": \"TX\",\n  \"zipCode\": \"78701\",\n  \"unit\": \"Apt 4B\",\n  \"city\": \"Austin\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.offergrid.io/public/shop/esiid-lookup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"street\": \"123 Main St\",\n  \"state\": \"TX\",\n  \"zipCode\": \"78701\",\n  \"unit\": \"Apt 4B\",\n  \"city\": \"Austin\"\n}"

response = http.request(request)
puts response.read_body

{
  "statusCode": 404,
  "message": "Offer not found",
  "error": "Not Found"
}

{
  "statusCode": 404,
  "message": "Offer not found",
  "error": "Not Found"
}

Getting Started

Core Concepts

Provider API

Reseller API

Public API

Resolve the electric meter (ESIID) for a service address

Body

Response