Skip to main content
GET
/
meter
/
company
/
{company_id}
Get Meters by Company
curl --request GET \
  --url https://external.nectarclimate.com/v2/meter/company/{company_id} \
  --header 'X-API-KEY: <api-key>'
{
  "totalMeters": 123,
  "perPage": 123,
  "totalPages": 123,
  "currentPage": 123,
  "hasNext": true,
  "hasPrevious": true,
  "meters": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "site": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identifiers": [
        {
          "rawName": "<string>",
          "value": "<string>",
          "name": "<string>"
        }
      ],
      "datasourceType": "ELECTRICITY",
      "account": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "address": "<string>",
      "timeOfUse": "PEAK",
      "netMeteringType": "EXPORT",
      "waterType": "POTABLE_WATER",
      "meterHighLow": "HIGH",
      "gasType": "NATURAL_GAS",
      "fuelType": "ANTHRACITE_COAL",
      "districtType": "HEATING",
      "districtMediumType": "HOT_WATER",
      "wasteDescription": "<string>",
      "wasteType": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "wasteStream": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "refrigerantType": "R11",
      "isTracked": true
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
company_id
string<uuid>
required

ID of the company for which to retrieve meters.

Query Parameters

​
datasourceType
enum<string>[]

('Optional. List of datasource types to filter by. If not provided, includes all types. Must be a sublist of "ELECTRICITY", "GAS", "WATER", "DISTRICT", "WASTE", "FUEL", "MISC", "REFRIGERANT", "SOLAR", "TELECOM"',)

  • ELECTRICITY - Electricity
  • GAS - Gas
  • WATER - Water
  • DISTRICT - District
  • WASTE - Waste
  • FUEL - Fuel
  • MISC - Misc
  • REFRIGERANT - Refrigerant
  • SOLAR - Solar
  • TELECOM - Telecom
Available options:
ELECTRICITY,
GAS,
WATER,
DISTRICT,
WASTE,
FUEL,
MISC,
REFRIGERANT,
SOLAR,
TELECOM
​
identifier
string
default:""

Filter meters by identifier value. Searches across all identifiers.

Minimum string length: 1
​
page
integer
default:1

Page number for paginated results. Default is 1.

Response

Serializer for meter site usage data response.

​
totalMeters
integer
required

Total number of meters.

​
perPage
integer
required

Number of entries per page.

​
totalPages
integer
required

Total number of pages.

​
currentPage
integer
required

Current page number.

​
hasNext
boolean
required

Indicates if there is a next page.

​
hasPrevious
boolean
required

Indicates if there is a previous page.

​
meters
object[]
required

List of meters.