Access facilities, transactions, meter readings, clean transportation, market, qualified reporting entity, building type, remote data collector and utility data from an Xpansiv Managed Solutions account using a bearer API key generated on the account API Access page.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/xpansiv-managed-solutions"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.0.0
info:
title: Xpansiv Managed Solutions API
description: >-
Access data from your Xpansiv Managed Solutions account using API calls.
You can generate an API key for your user on Xpansiv Managed Solutions <a
href="https://www.ms.xpansiv.com/app/api_access/manage">API Access page</a>.
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.
contact:
email: developers@xpansiv.com
version: '1.10'
servers:
- url: https://www.ms.xpansiv.com/app/api/v1
paths:
/facilities/{facility_id}:
get:
tags:
- Facilities
summary: Facility
description: >-
Retrieve detailed information about a facility by its ID, including
owner, installer, and certification data.
operationId: getFacilityById
parameters:
- name: facility_id
in: path
description: ID of the facility to retrieve
required: true
schema:
type: integer
responses:
'200':
description: Facility data retrieved successfully
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 200
type: object
- properties:
data:
$ref: '#/components/schemas/FacilityResponse'
type: object
'400':
description: Invalid facility ID provided or facility not found
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 400
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/FacilityGetMissingIdError'
type: object
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 401
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/AuthError'
type: object
'404':
description: Facility not found
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 404
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/FacilityGetError'
type: object
'500':
description: Internal error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 500
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/ServerError'
type: object
patch:
tags:
- Facilities
summary: Update facility
description: >-
Partially updates an existing facility via `PATCH
/api/v1/facilities/{facility_id}`. Send only the fields to change.
The request body accepts: `facilityCreateOrUpdate`,
`facilityDggCreateOrUpdate`, `facilityAbpCreateOrUpdate`, or the legacy
flat formats `facilityFlatCreateOrUpdate`,
`facilityDggFlatCreateOrUpdate`, and `facilityAbpFlatCreateOrUpdate`.
- **Partial mode:** send query parameter `partial=true` to relax
required-field validation. In partial mode, required-field validation is
relaxed while format/type validation still applies.
operationId: updateFacility
parameters:
- name: facility_id
in: path
description: ID of the facility to update
required: true
schema:
type: integer
- name: partial
in: query
description: Enable update with partial data. Accepts `true`, `1`, or `yes`.
required: false
schema:
type: boolean
default: false
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/facilityCreateOrUpdate'
- $ref: '#/components/schemas/facilityDggCreateOrUpdate'
- $ref: '#/components/schemas/facilityAbpCreateOrUpdate'
- $ref: '#/components/schemas/facilityFlatCreateOrUpdate'
- $ref: '#/components/schemas/facilityDggFlatCreateOrUpdate'
- $ref: '#/components/schemas/facilityAbpFlatCreateOrUpdate'
responses:
'200':
description: Facility updated successfully
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 200
type: object
- properties:
data:
$ref: >-
#/components/schemas/facilityFlatCreateOrUpdateResponse200
type: object
'400':
description: >-
Bad request — validation errors, invalid facility ID, or update
failure
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 400
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/ValidationError'
type: object
'401':
description: Unauthorized — missing API key or invalid token
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 401
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/AuthError'
type: object
'403':
description: Facility not visible to the authenticated account
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 403
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/AccessForbiddenError'
type: object
'500':
description: Internal error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 500
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/ServerError'
type: object
/facilities:
get:
tags:
- Facilities
summary: Facilities
description: >-
Retrieve the list of facilities in your Xpansiv Managed Solutions
account with pagination.
operationId: getFacilityListForAccount
parameters:
- name: account_id
in: query
description: >-
Account whose facilities to list. Defaults to the authenticated
user's active account. **Admin only** when targeting another
account; non-admins receive 403 if set to a different account.
required: false
schema:
type: integer
example: 4242
minimum: 1
- name: per_page
in: query
description: >-
Number of facilities to display per page. If a value greater than
1000 is provided, it will be coerced to 1000.
required: false
schema:
type: integer
default: 50
maximum: 1000
minimum: 1
- name: page
in: query
description: The current page number
required: false
schema:
type: integer
default: 1
minimum: 1
- name: program
in: query
description: Narrows the list to facilities in a program.
required: false
schema:
type: string
example: dgg
enum:
- dgg
- name: search
in: query
description: Search term matched against facility name
required: false
schema:
type: string
example: solar
- name: utility_ids
in: query
description: Comma-separated utility IDs to filter by
required: false
schema:
type: string
example: 12,34
- name: auto_reporter_ids
in: query
description: >-
Comma-separated auto-reporter (remote data collector) IDs to filter
by
required: false
schema:
type: string
example: 5,6
- name: commencement_date_from
in: query
description: >-
Filter by facility commencement date on or after this day
(YYYY-MM-DD)
required: false
schema:
type: string
format: date
example: '2024-01-01'
- name: commencement_date_to
in: query
description: >-
Filter by facility commencement date on or before this day
(YYYY-MM-DD)
required: false
schema:
type: string
format: date
example: '2025-12-31'
- name: exclude_managed_facility_group_members
in: query
description: >-
When true, omit facilities that belong to a managed facility group
owned by the listed account.
required: false
schema:
type: boolean
example: true
- name: ticket_owner_ids
in: query
description: Comma-separated ticket owner user IDs to filter by
required: false
schema:
type: string
example: 125,126
responses:
'200':
description: Successfully retrieved facilities
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/PaginatedResponseEnvelope'
- properties:
code:
type: integer
example: 200
type: object
- $ref: '#/components/schemas/FacilitiesListForAccountList'
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 401
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/AuthError'
type: object
'403':
description: Forbidden — non-admin requested another account's facilities
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 403
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/Error'
type: object
post:
tags:
- Facilities
summary: Create facility
description: >-
Creates a new facility for your account via `POST /api/v1/facilities`.
The JSON body must be one of:
`facilityCreateOrUpdate` for **Standard Facility** : grouped payload using `address`, `owner`, `installer`, and `meter` objects. Optional `panels` and `inverters` arrays.
`facilityDggCreateOrUpdate` for **California Distributed Generation Program** (DGG).
- Send `dgg: true` and `state: 'CA'`.
- **Metering vs QRE:** `can_provide_solar_production_data_access` is required—when **true**, send `meter_remote_data_collector` and `online_monitoring_api_id`; when **false**, send `qualified_reporting_entity` and `qualified_reporting_entity_id_value`.
- Program access: the DGG program is not open to all users; to join, contact our support team.
`facilityAbpCreateOrUpdate` for **Illinois Adjustable Block Program** (ABP).
- Send `address.state: 'IL'`. Your account must be ABP-enabled.
- Include ABP-specific fields (see schema), `panels[].bifacial`, `inverters[].efficiency`, and `installer_demographics`.
- After create, call `GET /facilities/{id}/state_eligibilities` for required document slugs before `POST /facilities/{id}/documents`.
- Program access: Illinois ABP via API is limited to authorized accounts; contact our support team to enroll.
**Partial mode:** send query parameter `partial=true` to create a facility with partial data. In partial mode, required-field validation is relaxed while format/type validation still applies.
Legacy flat formats `facilityFlatCreateOrUpdate`, `facilityDggFlatCreateOrUpdate`, and `facilityAbpFlatCreateOrUpdate` remain supported for backwards compatibility and will be deprecated in a future release.
This API endpoint only support Solar Photovoltaic facilities.
operationId: createFacility
parameters:
- name: partial
in: query
description: >-
Enable creation of facility with partial data. Accepts `true`, `1`,
or `yes`.
required: false
schema:
type: boolean
default: false
requestBody:
required: false
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/facilityCreateOrUpdate'
- $ref: '#/components/schemas/facilityDggCreateOrUpdate'
- $ref: '#/components/schemas/facilityAbpCreateOrUpdate'
- $ref: '#/components/schemas/facilityFlatCreateOrUpdate'
- $ref: '#/components/schemas/facilityDggFlatCreateOrUpdate'
- $ref: '#/components/schemas/facilityAbpFlatCreateOrUpdate'
responses:
'200':
description: Facility created successfully
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 200
type: object
- properties:
data:
$ref: >-
#/components/schemas/facilityFlatCreateOrUpdateResponse200
type: object
'400':
description: Bad request - authorization or validation errors
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 400
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/ValidationError'
type: object
'401':
description: >-
Unauthorized — missing API key, invalid token, or user lacks
facility edit permission
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 401
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/AuthError'
type: object
'403':
description: Access denied for creating a DGG facility
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 403
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/AccessForbiddenError'
type: object
'500':
description: Internal error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 500
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/ServerError'
type: object
/facilities/{facility_id}/transactions:
get:
tags:
- Transactions
summary: Get Transaction Summary/History
description: Returns transaction summary/history for a facility.
operationId: getTransactionsHistory
parameters:
- name: facility_id
in: path
description: ID of the facility to retrieve transactions for
required: true
schema:
type: integer
- name: per_page
in: query
description: Number of transactions to display per page. Maximum 1000.
required: false
schema:
type: integer
default: 50
maximum: 1000
minimum: 1
- name: page
in: query
description: The current page number
required: false
schema:
type: integer
default: 1
minimum: 1
responses:
'200':
description: Transaction summary/history retrieved successfully
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/PaginatedResponseEnvelope'
- properties:
code:
type: integer
example: 200
type: object
- $ref: '#/components/schemas/FacilityTransactionsPaginatedResponse'
'400':
description: Bad request - invalid facility ID format
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 400
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: >-
#/components/schemas/TransactionsInvalidFacilityIdError
type: object
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 401
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/AuthError'
type: object
'403':
description: Access denied or facility closed/lost
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 403
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/TransactionsForbiddenError'
type: object
'404':
description: Facility not found
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 404
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/TransactionsNotFoundError'
type: object
/facilities/{facility_id}/state_eligibilities:
get:
tags:
- Facilities
summary: State Eligibilities
description: >-
Retrieve state eligibility and required documents for a facility. For
Illinois ABP, use the returned `documents[].upload_field_name` values as
`document_name` when calling `POST /facilities/{id}/documents`. Required
documents depend on facility attributes (e.g. `net_metering_approved`);
always use this endpoint rather than a static slug list.
operationId: getFacilityStateEligibilities
parameters:
- name: facility_id
in: path
description: The ID of the facility to fetch eligibility details for.
required: true
schema:
type: integer
example: 130240
responses:
'200':
description: Successful response with state eligibility details.
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 200
type: object
- properties:
data:
$ref: '#/components/schemas/FacilityStateEligibilitiesList'
type: object
'400':
description: Bad Request - The request was invalid or cannot be otherwise served.
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 400
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/FacilityGetMissingIdError'
type: object
'404':
description: Not Found - The requested facility was not found.
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 404
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/FacilityGetError'
type: object
/facilities/{facility_id}/state_applications:
post:
tags:
- Facilities
summary: State Application
description: Apply to a new state to be certified to generate RECs.
operationId: createFacilityStateApplication
parameters:
- name: facility_id
in: path
description: The ID of the facility linked to the new application.
required: true
schema:
type: integer
example: 130240
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFacilityStateApplicationRequest'
responses:
'200':
description: State application created successfully for the given state
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 200
type: object
- properties:
data:
$ref: '#/components/schemas/StateApplicationCreateData'
type: object
'400':
description: Bad request - authorization or validation errors
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 400
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/ValidationError'
type: object
'500':
description: Internal error
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 500
elements:
type: integer
example: 0
type: object
- properties:
data:
$ref: '#/components/schemas/ServerError'
type: object
/facilities/{facility_id}/documents:
post:
tags:
- Facilities
summary: Facilities Documents
description: >-
Upload documents or photos for a facility (multipart form). Call `GET
/facilities/{facility_id}/state_eligibilities` first to obtain each
document's `upload_field_name` slug. For Illinois ABP, common slugs
include `proof_of_irrevocable_transfer`, `proof_of_residential`, and
`proof_of_site_control`; the eligibility response is authoritative.
operationId: uploadFacilityDocuments
parameters:
- name: facility_id
in: path
description: The ID of the facility
required: true
schema:
type: string
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/UploadFacilityDocumentsRequest'
responses:
'200':
description: Documents uploaded successfully
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ResponseEnvelope'
- properties:
code:
type: integer
example: 200
type: object
- properties:
data:
$ref: '#/components/s
# --- truncated at 32 KB (314 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/xpansiv/refs/heads/main/openapi/xpansiv-managed-solutions-openapi.yml