API documentation

Accurassi Platform API

The Accurassi API is documented in OpenAPI 3.1. The schema and .well-known discovery metadata are available below. The API is in MVP at launch; the contract is stable within major versions.

Service discovery

GET /.well-known/accurassi-platform.json

Endpoints

POST/v1/compare

Submit a comparison request. Returns ranked plans and structural advisories.

Request

  • postcode
  • housing (tenure, housingType, connectionType, jurisdiction)
  • currentRetailer?
  • annualUsageKwh?
  • billUploadId?

Response includes

  • ranked[] (planId, retailer, planName, tariffType, projected[], savingsVsCurrent, rateBreakdown, referencePriceDelta)
  • structuralAdvisories[] (code, severity, title, summary, action, sources[])
GET/v1/plan/:planId

Full plan detail including rate schedule, contract terms, and NTC assignment.

Request

  • planId (path parameter)

Response includes

  • All RankedPlan fields
  • ntcAssignment (code, role, source, confidence)
  • fullRateSchedule
GET/v1/advisories

List all advisory codes with descriptions and applicable jurisdictions.

Request

  • jurisdiction? (query param)

Response includes

  • code
  • severity
  • title
  • applicableJurisdictions[]
  • sources[]

Advisory codes

All advisory codes are stable identifiers. New codes are additive; existing codes are never removed within a major API version.

high
DEFAULT_DEMAND_TARIFF_OPT_OUT_AVAILABLE

Customer is on a demand tariff assigned by default; opt-out right exists under IPART ruling.

high
RETAIL_STRUCTURE_PACKAGING_MISMATCH

Retailer is packaging a demand NTC as a "Time-of-Use" plan — customer is unaware of demand charges.

informational
INTRODUCTORY_RATE_ESCALATION_RISK

Plan has an introductory discount that expires; projected costs include post-discount rates.

informational
EXPERIMENTAL_TARIFF_OBLIGATIONS

Customer is on a voluntary experimental tariff with specific consent and obligation requirements.

high
EMBEDDED_NETWORK_DETECTED

Retailer name matches known embedded-network operators; standard market comparison not applicable.

informational
RENTER_STATE_STANDARDS_AWARENESS

Customer is a renter; state minimum energy performance standards apply and are summarised.

informational
VPP_CONTRACT_TERMS_DISCLOSURE

Plan includes VPP participation terms; customer should review dispatch obligations.

OpenAPI 3.1 schema

The full schema is published at the URL below. Import into Postman, Insomnia, or any OpenAPI-compatible client.

/api/openapi.json

Schema available from MVP launch (mid-to-late August 2026). Contact us for early access.