Skip to content
Xpansiv Managed Solutions
/
/Utilities

Xpansiv Managed Solutions API (1.10)

Access data from your Xpansiv Managed Solutions account using API calls.

You can generate an API key for your user on Xpansiv Managed Solutions API Access page. The API key is linked to a user and an account, and has the same rights as the user on the account.

When calling Xpansiv Managed Solutions API use that API key to set the Bearer Token authentication header.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
E-mail
developers@xpansiv.com
Languages
Servers
https://www.ms.xpansiv.com/app/api/v1/

Facilities

Facilities

Operations

Internal

Internal

Operations

Transactions

Transactions

Operations

Facility import error handling

Facility import error handling

Operations

Meter Readings

Meter Readings

Operations

Clean Transportation

Clean Transportation

Operations

Market

Market

Operations

Qualified reporting entities

Qualified reporting entities

Operations

Building types

Building types

Operations

Remote data collectors

Remote data collectors

Operations

Utilities

Utilities

Operations

List utilities by county and state

Request

Returns utilities matching optional county and state parameters.

Security
BearerAuth
Query
countystring

County name filter (passed through to the data layer).

statestring

State filter; compared using an uppercase form of this value.

curl -i -X GET \
  'https://www.ms.xpansiv.com/app/api/v1/utilities?county=string&state=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success — standard API envelope; utilities in data.

Bodyapplication/json
urlstringrequired

Request URL including query string.

Example: "/app/api/v1/facilities"
datestringrequired

Response timestamp.

Example: "2024-09-17 04:26:39 EDT"
codeintegerrequired

HTTP status code, mirrored in the JSON body (same as the response status).

Example: 200
elementsintegerrequired

Number of items in data on HTTP 200; 0 for other status codes.

pagestring or integerrequired
One of:

Page label (1 of 1 when not paginated) or numeric page when listing with pagination.

string
dataArray of objects(UtilitiesListResponse)

Utility rows returned in the API envelope data field.

Response
application/json
{
  "url": "/app/api/v1/facilities",
  "date": "2024-09-17 04:26:39 EDT",
  "code": 200,
  "elements": 0,
  "page": "1 of 1",
  "data": [
    { … }
  ]
}