Incentives

Resolve an incentive id (or id prefix)

Changed on

Resolves a constructible incentive id — the id field on /incentives records — to the record it identifies, regardless of status (an expired program stays resolvable, so a stored quote can show it as expired).

The id is wb1:{state}:{authority_type}:{authority_ref}:{tech}:{subtype}:{program_type}:{variant}[:{slug}], so any colon-delimited prefix is also valid and returns the matching set: an exact match wins (count: 1); otherwise matches holds every record under the prefix and disambiguate_on names the next segment with its distinct values. count: 0 with moved_to means the id was re-minted (data correction) — refetch with the new id. matches is capped at 200 (truncated: true).

get/incentives/id/{uid}

Request

  • Base URL
    https://apis.wattbuy.com/v3
  • Auth
    API key in header x-api-key

Path parameters

uidstring required

Incentive id or colon-delimited prefix (URL-encoded colons accepted).

Response

Lookup result

statusstring
uidstring

The id/prefix as resolved.

countinteger

Total matching records (may exceed matches.length when truncated).

moved_tostring

Present with count 0 when the id was re-minted; refetch with this id.

truncatedboolean

Present (true) when matches was capped at 200.

Example response

{
  "status": "ok",
  "disambiguate_on": {
    "segment": 6,
    "name": "subtype",
    "values": [
      "ductless_mini_split",
      "hp_air_source"
    ]
  }
}

Changes