openapi: 3.2.0
info:
  title: Asset List Assetlist API
  description: Get Asset List Report
  version: v1
servers:
- url: https://apimgw.aeso.ca/public/assetlist-api
- url: https://gateway-apim.aeso.ca/public/assetlist-api
security:
- {}
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: Assetlist
paths:
  /assetlist:
    get:
      operationId: getAssetListData
      summary: Fetch the latest list of assets connected to AIES.
      description: ' The asset_ID and pool_participant_ID parameters are comma separated lists. At most, one of the two parameters can be passed in an API call.


        Note: The Operating Status, Pool Participant Name and ID for an asset can change overtime.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetListVO'
              examples:
                default:
                  value:
                    asset_name: string
                    asset_ID: string
                    asset_type: string
                    operating_status: string
                    pool_participant_name: string
                    pool_participant_ID: string
                    net_to_grid_asset_flag: string
                    asset_incl_storage_flag: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Invalid method
        '500':
          description: Internal server error
        '503':
          description: Service unavailable
      parameters:
      - name: asset_ID
        in: query
        required: false
        description: This parameter can contain up to 20 comma-separated Asset IDs.
        schema:
          $ref: '#/components/schemas/AssetlistGetRequest'
      - name: pool_participant_ID
        in: query
        required: false
        description: This parameter can contain up to 20 comma-separated Pool Participant IDs.
        schema:
          $ref: '#/components/schemas/AssetlistGetRequest-1'
      - name: operating_status
        in: query
        required: false
        description: The allowed values are ACTIVE, RETIRED, SUSPENDED, INACTIVE
        schema:
          $ref: '#/components/schemas/AssetlistGetRequest-2'
      - name: asset_type
        in: query
        required: false
        description: The allowed values are SOURCE, SINK
        schema:
          $ref: '#/components/schemas/AssetlistGetRequest-3'
      tags:
      - Assetlist
components:
  schemas:
    AssetListVO:
      type: object
      properties:
        asset_name:
          type: string
          description: The name of the asset.
        asset_ID:
          type: string
          description: Asset's unique short name defined by 3 or 4-digit alphanumeric code. A pool asset is registered to a pool participant.
        asset_type:
          type: string
          description: Type of the asset - Sink or Source.
        operating_status:
          type: string
          description: Operating status of the asset - Active, Retired, Inactive or Suspended.
        pool_participant_name:
          type: string
          description: Pool Participant_name is the name of the pool participant provided by the pool participant. A pool participant is a market participant who is registered to transact electric energy.
        pool_participant_ID:
          type: string
          description: 'Pool Participant''s unique short name defined by 3 or 4-digit alphanumeric code. A pool participant is a market participant who is registered to transact electric energy. '
        net_to_grid_asset_flag:
          type: string
          description: "Boolean value 'Y' or blank \nY = This asset is a Net-to-grid (NTG) asset\nBlank = This asset is  Gross-to-grid (GTG) asset"
        asset_incl_storage_flag:
          type: string
          description: "Boolean value 'Y' or blank \nY = This asset includes energy storage\nBlank = This asset does not include energy storage"
    AssetlistGetRequest-1:
      type: string
      x-apim-inline: true
    AssetlistGetRequest-3:
      type: string
      default: ALL
      x-apim-inline: true
    AssetlistGetRequest:
      type: string
      x-apim-inline: true
    AssetlistGetRequest-2:
      type: string
      default: ALL
      x-apim-inline: true
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: API-KEY
      in: header
    apiKeyQuery:
      type: apiKey
      name: subscription-key
      in: query
x-provenance:
  harvestedBy: API Evangelist
  harvestedOn: '2026-07-27'
  sourcePortal: https://developer-apim.aeso.ca/
  method: Assembled verbatim from the AESO Azure API Management developer-portal data API, which is served anonymously. AESO's own OpenAPI export (?export=true&format=openapi) returns a valid document with an EMPTY paths object, so paths, parameters, responses, examples and component schemas were read from the portal's operations/ and schemas/ endpoints and reassembled without alteration. Nothing was invented.
  sources:
  - url: https://developer-apim.aeso.ca/developer/apis/assetlist-api-v1?api-version=2022-04-01-preview
    status: 200
    note: API metadata
  - url: https://developer-apim.aeso.ca/developer/apis/assetlist-api-v1?export=true&format=openapi%2Bjson&api-version=2022-04-01-preview
    status: 200
    note: AESO OpenAPI export (empty paths) - basis for info/servers/security
  - url: https://developer-apim.aeso.ca/developer/apis/assetlist-api-v1/operations?api-version=2022-04-01-preview
    status: 200
    note: operation list
  - url: https://developer-apim.aeso.ca/developer/apis/assetlist-api-v1/schemas?api-version=2022-04-01-preview
    status: 200
    note: schema list
  - url: https://developer-apim.aeso.ca/developer/apis/assetlist-api-v1/operations/getAssetListData?api-version=2022-04-01-preview
    status: 200
    note: operation detail
  - url: https://developer-apim.aeso.ca/developer/apis/assetlist-api-v1/schemas/675b1ae7445a960634ec1e9a?api-version=2022-04-01-preview
    status: 200
    note: schema document