Skip to main content
Most list endpoints in the Nectar API accept query parameters to filter the results. This guide covers the most commonly used filters.

​
Usage data filters

The usage data endpoints (/usage/company/{id}, /usage/site/{id}, etc.) support the following filters:
ParameterTypeDescriptionExample
startDateDateFilter by start boundary (behavior depends on dateType)2025-01-01
endDateDateFilter by end boundary (behavior depends on dateType)2025-12-31
dateTypeStringWhich date field to filter on (default: BILL_DATE)USAGE_PERIOD
datasourceTypeStringFilter by utility type (accepts multiple values)ELECTRICITY, GAS
identifierStringSearch across all meter identifiers0137746423

​
Date type values

ValueDescription
BILL_DATEFilter by the invoice date on the document (default)
USAGE_PERIODFilter by the usage period start and end dates
CREATED_DATEFilter by when the record was created
UPDATED_DATEFilter by when the record was last updated
curl -X GET 'https://external.nectarclimate.com/v2.2/usage/company/{companyId}?startDate=2025-01-01&endDate=2025-12-31&datasourceType=ELECTRICITY' \
  -H 'X-API-Key: YOUR_SECRET_KEY'

​
Commodity types

Use these values for the datasourceType parameter:
ValueCommodity
ELECTRICITYElectricity
GASNatural gas
WATERWater
WASTEWaste
FUELFuel (diesel, propane, etc.)
SOLARSolar
SEWERSewer
STEAMSteam (district)
CHILLED_WATERChilled water (district)
HOT_WATERHot water (district)

​
Document filters

Document endpoints (/document/company/{id}, /document/site/{id}, etc.) support the same date, dateType, datasourceType, and identifier filters as usage data endpoints. Additionally:
ParameterTypeDescription
isDeletedBooleanInclude soft-deleted documents (default: false)

​
Connection filters

Connection endpoints (/connection/company/{id}) support owner, status, and site filters:
ParameterTypeDescription
connectionOwnerEmailString (email)Filter by exact connection owner email
sitesUUID (repeatable)Filter to connections linked to one or more sites
statusStringFilter by connection status (e.g., CONNECTED, PASSWORD_INCORRECT)
See Connection statuses for the full list of status values. 
# Filter by owner and site
curl -X GET 'https://external.nectarclimate.com/v2.2/connection/company/{companyId}[email protected]&sites={siteId}' \
  -H 'X-API-Key: YOUR_SECRET_KEY'

​
Combining filters with pagination

All filters work alongside pagination parameters. The total in the response reflects the filtered count, not the unfiltered total. 
# Get page 2 of electricity usage data for 2025
curl -X GET 'https://external.nectarclimate.com/v2.2/usage/company/{companyId}?startDate=2025-01-01&endDate=2025-12-31&datasourceType=ELECTRICITY&page=2' \
  -H 'X-API-Key: YOUR_SECRET_KEY'

​
Next steps

Pagination

Iterate through large result sets

API Reference

Full parameter documentation for every endpoint