How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xpansiv Meter Readings API

Meter Readings

Xpansiv Meter Readings API is one of 43 APIs that Xpansiv publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Meter Readings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, a quickstart, and an API reference.

This API exposes 6 operations across 6 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 1.10.

Requests are made against a single base URL, https://www.ms.xpansiv.com/app/api/v1.

6 operations 6 paths 27 schemas 2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.10
Base URL
https://connect.xpansiv.com/app/api/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Xpansiv Meter Readings API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Meter Readings 6

Meter Readings

GET
/facilities/{facility_id}/generation/meters/{meter_id}/readings/eligibility
Check user can submit meter reading
userCanSubmitMeterReading 2 params → 200400401500
POST
/facilities/{facility_id}/generation/meters/{meter_id}/readings
Submit Meter Reading (Cumulative Meters Only)
submitMeterReading 2 params body → 200400401403404410500
POST
/facilities/{facility_id}/generation/meters/{meter_id}/image-readings
Process Meter Reading Image
processMeterReadingImage 2 params body → 200400401429500
POST
/facilities/{facility_id}/generation/meters/{meter_id}/readings/{meter_readings_id}/verification
Submit Verification for a Held Meter Reading
submitReadingVerification 3 params body → 201400401403404409422500
GET
/facilities/{facility_id}/generation/meters/{meter_id}/image-readings/{processing_id}
Get Meter Reading Image Processing Status
getMeterReadingImageProcessingStatus 3 params → 200400401404500
PATCH
/facilities/{facility_id}/generation/meters/{meter_id}/readings/{reading_id}
Update an Existing Meter Reading
updateMeterReading 3 params body → 200400401403500

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are ApiResponseDTO (6 properties), MeterReadingImageExtractedData (6 properties), MeterReadingEligibilityResult (5 properties), ResponseEnvelope (5 properties). Each schema is shown below with its type and property counts.

Error
object
Generic error payload when no more specific error schema applies. Implements JsonSerializable so it can be passed directly to APIController::response(). Implem…
2 properties 2 required
ProcessMeterReadingImageMaxAttemptsError
object
POST .../image-readings when the photo OCR retry limit is reached (HTTP 429).
5 properties 5 required
MeterReadingImageExtractedData
object
OCR extracted data from the meter reading image
6 properties 6 required
SubmitReadingVerificationSuccess
object
Verification submission accepted — reading moved to pendingreview.
3 properties 3 required
MeterReadingImageProcessingStatusServerError
object
GET .../image-readings/{processingid} internal server error (manual contract).
3 required
MeterReadingOperationError
object
Shared {success, error, message} shape for meter-reading image/status API errors. Endpoint-specific schemas extend this class and set a distinct schema name fo…
3 properties 3 required
ApiFieldError
object
API field error
2 properties
AuthError
object
2 required
ProcessMeterReadingImageSuccess
object
Image accepted for OCR processing.
4 properties 4 required
MeterReadingImageProcessingStatus
object
OCR processing status and extracted data
5 properties 5 required
ApiResponseDTO
object
API response data
6 properties
MeterReadingLastSubmission
object
4 properties 3 required
ProcessMeterReadingImageServerError
object
POST .../image-readings server failures after the image is accepted.
3 required
MeterReadingEligibilityResult
object
Whether the facility/meter can submit manual readings at this time
5 properties 3 required
ProcessMeterReadingImageBadRequestError
object
POST .../image-readings client errors (missing/invalid image per manual spec).
3 required
ManualMeterReadingRequest
object
Manual meter reading submission body for submitMeterReading.
2 properties 2 required
MeterReadingSubmissionWindow
object
2 properties
ProcessMeterReadingImageRequest
object
Multipart body for POST /facilities/{facilityid}/generation/meters/{meterid}/image-readings.
3 properties 1 required
MeterReadingEligibilityBadRequestError
object
GET .../readings/eligibility when facility or meter path IDs are invalid (manual contract).
2 required
MeterReadingImageProcessingStatusBadRequestError
object
GET .../image-readings/{processingid} when facility access or path validation fails (manual documents as 400).
3 required
ResponseEnvelope
object
Standard API response envelope. Every response wraps its payload in this structure; the data field contains the operation-specific payload.
5 properties 5 required
MeterReadingErrorResponse
object
Error response payload (inside the data envelope). The error and errors fields are optional and may not be present in all error responses.
4 properties 2 required
MeterReadingSuccessResponse
object
Success response payload (inside the data envelope)
4 properties 3 required
AutomatedMeterReadingRequest
object
Automated meter reading submission body for submitMeterReading (OCR processingid).
1 property 1 required
MeterReadingImageProcessingStatusNotFoundError
object
GET .../image-readings/{processingid} when the processing record is missing or not owned by the facility.
3 required
MeterReadingEligibilityServerError
object
GET .../readings/eligibility when an unexpected error occurs (manual contract).
3 properties 3 required
MeterReadingSubmissionPeriod
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xpansiv-meter-readings-api-openapi.yml Raw ↑

Other APIs Xpansiv publishes across the network.

Xpansiv Data API
Xpansiv Marketplace FIX API
Xpansiv Account API
Xpansiv Building types API
Xpansiv Clean Transportation API
Xpansiv Corporate Entity API
Xpansiv Exchange API
Xpansiv Facilities API
Xpansiv Facility import error handling API
Xpansiv File Type V1 API
Xpansiv /file Registry API
Xpansiv Forward Deals API
Where this information came from

This is an independent, third-party profile of Xpansiv Meter Readings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.