Arcadia Providers API

Utility providers supported by the platform.

GitHub OpenAPI

Operations 2

GET /plug/providers List Providers #
GET /plug/providers/{providerId} Retrieve Provider #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/arcadia-power:arcadia-power-providers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

arcadia-power-providers-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: Plug API
  title: Plug Providers API
  version: 2.0.0
servers:
- url: https://api.arcadia.com
security:
- OAuth2: []
tags:
- name: Providers
paths:
  /plug/providers:
    get:
      description: 'Get a list of all Providers available in the Arcadia system. This endpoint is pageable.


        This endpoint supports Sandbox Mode.'
      operationId: list-providers
      parameters:
      - description: 'A search query string. See [this page](ref:searching) for more information.


          The searchable fields for this endpoint are:

          - `country`

          - `id`

          - `intervals.isHistorySupported`

          - `intervals.isSupported`

          - `intervals.isInstantIntervalsSupported`

          - `intervals.serviceTypes`

          - `isHistorySupported`

          - `isMultiFactorAuthenticationSupported`

          - `isPaymentDataAvailable`

          - `isRealTimeCredentialValidationSupported`

          - `isThirdPartyPortalSupported`

          - `isIntervalsThirdPartyPortalSupported`

          - `isInstantIntervalsSupported`

          - `multiFactorAuthentication.isOptOutSupported`

          - `multiFactorAuthentication.isSupported`

          - `multiFactorAuthentication.requestType`

          - `multiFactorAuthentication.type`

          - `multiFactorAuthentication.isGuestAccessSupported`

          - `name`

          - `region`

          - `statements.isHistorySupported`

          - `statements.isSupported`

          - `statements.isWebNavigationSupported`

          - `statements.serviceTypes`

          - `website`'
        in: query
        name: search
        required: false
        schema:
          type: string
      - in: query
        name: globalSearch
        required: false
        schema:
          type: string
      - description: Zero-based page index (0..N)
        in: query
        name: page
        schema:
          type: integer
          default: 0
      - description: The size of the page to be returned
        in: query
        name: size
        schema:
          type: integer
          default: 20
      - description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.'
        in: query
        name: sort
        schema:
          type: array
          items:
            type: string
      - $ref: '#/components/parameters/arcVersionInHeaderParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlugPagedProviderResource'
          description: OK
      summary: List Providers
      tags:
      - Providers
      servers:
      - url: https://api.arcadia.com
      - url: https://sandbox.api.arcadia.com
  /plug/providers/{providerId}:
    get:
      description: 'Retrieve a single Provider.


        This endpoint supports Sandbox Mode.'
      operationId: retrieve-provider
      parameters:
      - in: path
        name: providerId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/arcVersionInHeaderParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPlugProviderResource'
          description: OK
      summary: Retrieve Provider
      tags:
      - Providers
      servers:
      - url: https://api.arcadia.com
      - url: https://sandbox.api.arcadia.com
components:
  schemas:
    PlugPagedProviderResource:
      required:
      - page
      - providers
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageMetadata'
        providers:
          type: array
          description: An array of unique identifiers of the utility service provider
          items:
            $ref: '#/components/schemas/PublicPlugProviderResource'
    PlugMultiFactorAuthenticationSupportResource:
      required:
      - isGuestAccessSupported
      - isOptOutSupported
      - isSupported
      - request
      - type
      type: object
      properties:
        isGuestAccessSupported:
          type: boolean
          description: Indicates whether the provider supports guest access configuration. This field is currently in beta.
        isOptOutSupported:
          type: boolean
          description: Indicates whether Arcadia is able to support opting out of MFA for the provider. This field is currently in beta.
        isSupported:
          type: boolean
          description: This field indicates whether Arcadia is able to support MFA for the provider. It does not indicate whether the provider requires MFA.
        request:
          type:
          - string
          - 'null'
          description: The type of MFA request this provider supports.
          enum:
          - ONE_TIME
          - RECURRING
        type:
          type:
          - string
          - 'null'
          description: The type of MFA this provider supports.
          enum:
          - MANDATORY
          - OPTIONAL
      description: Detailed information about the provider's MFA support.
    PlugStatementProviderSupportResource:
      required:
      - isHistorySupported
      - isSupported
      - isWebNavigationSupported
      - serviceTypes
      type: object
      properties:
        isHistorySupported:
          type: boolean
          description: Indicates whether the provider supports historical statement data extraction.
        isSupported:
          type: boolean
          description: Indicates whether the provider supports statement data extraction.
        isWebNavigationSupported:
          type: boolean
          description: Indicates whether the provider supports web navigation.
        serviceTypes:
          uniqueItems: true
          type: array
          description: An array of service types from the Provider that are supported.
          items:
            type: string
            description: An array of service types from the Provider that are supported.
      description: Detailed information about the provider's statements support.
    PublicPlugProviderResource:
      required:
      - country
      - id
      - intervals
      - isHistorySupported
      - isInstantIntervalsSupported
      - isIntervalsThirdPartyPortalSupported
      - isMultiFactorAuthenticationSupported
      - isRealTimeCredentialValidationSupported
      - isThirdPartyPortalSupported
      - multiFactorAuthentication
      - name
      - region
      - requiredFieldMetadata
      - requiredFields
      - serviceTypes
      - statements
      - website
      type: object
      properties:
        country:
          type: string
          description: The country associated with the billing address.
          enum:
          - AFG
          - ALA
          - ALB
          - DZA
          - ASM
          - AND
          - AGO
          - AIA
          - ATA
          - ATG
          - ARG
          - ARM
          - ABW
          - AUS
          - AUT
          - AZE
          - BHS
          - BHR
          - BGD
          - BRB
          - BLR
          - BEL
          - BLZ
          - BEN
          - BMU
          - BTN
          - BOL
          - BES
          - BIH
          - BWA
          - BVT
          - BRA
          - IOT
          - VGB
          - BRN
          - BGR
          - BFA
          - BDI
          - CPV
          - KHM
          - CMR
          - CAN
          - CYM
          - CAF
          - TCD
          - CHL
          - CHN
          - CXR
          - CCK
          - COL
          - COM
          - COG
          - COD
          - COK
          - CRI
          - CIV
          - HRV
          - CUB
          - CUW
          - CYP
          - CZE
          - DNK
          - DJI
          - DMA
          - DOM
          - ECU
          - EGY
          - SLV
          - GNQ
          - ERI
          - EST
          - ETH
          - FLK
          - FRO
          - FSM
          - FJI
          - FIN
          - FRA
          - GUF
          - PYF
          - ATF
          - GAB
          - GMB
          - GEO
          - DEU
          - GHA
          - GIB
          - GRC
          - GRL
          - GRD
          - GLP
          - GUM
          - GTM
          - GGY
          - GIN
          - GNB
          - GUY
          - HTI
          - HMD
          - VAT
          - HND
          - HKG
          - HUN
          - ISL
          - IND
          - IDN
          - IRN
          - IRQ
          - IRL
          - IMN
          - ISR
          - ITA
          - JAM
          - JPN
          - JEY
          - JOR
          - KAZ
          - KEN
          - KIR
          - KWT
          - KGZ
          - LAO
          - LVA
          - LBN
          - LSO
          - LBR
          - LBY
          - LIE
          - LTU
          - LUX
          - MAC
          - MKD
          - MDG
          - MWI
          - MYS
          - MDV
          - MLI
          - MLT
          - MHL
          - MTQ
          - MRT
          - MUS
          - MYT
          - MEX
          - MDA
          - MCO
          - MNG
          - MNE
          - MSR
          - MAR
          - MOZ
          - MMR
          - NAM
          - NRU
          - NPL
          - NLD
          - NCL
          - NZL
          - NIC
          - NER
          - NGA
          - NIU
          - NFK
          - PRK
          - MNP
          - NOR
          - OMN
          - PAK
          - PLW
          - PSE
          - PAN
          - PNG
          - PRY
          - PER
          - PHL
          - PCN
          - POL
          - PRT
          - PRI
          - QAT
          - REU
          - ROU
          - RUS
          - RWA
          - BLM
          - SHN
          - KNA
          - LCA
          - MAF
          - SPM
          - VCT
          - WSM
          - SMR
          - STP
          - SAU
          - SEN
          - SRB
          - SYC
          - SLE
          - SGP
          - SXM
          - SVK
          - SVN
          - SLB
          - SOM
          - ZAF
          - SGS
          - KOR
          - SSD
          - ESP
          - LKA
          - SDN
          - SUR
          - SJM
          - SWZ
          - SWE
          - CHE
          - SYR
          - TWN
          - TJK
          - TZA
          - THA
          - TLS
          - TGO
          - TKL
          - TON
          - TTO
          - TUN
          - TUR
          - TKM
          - TCA
          - TUV
          - VIR
          - UGA
          - UKR
          - ARE
          - GBR
          - UMI
          - USA
          - URY
          - UZB
          - VUT
          - VEN
          - VNM
          - WLF
          - ESH
          - YEM
          - ZMB
          - ZWE
        id:
          type: string
          description: A unique identifier for the entity.
        intervals:
          $ref: '#/components/schemas/PlugIntervalProviderSupportResource'
        isHistorySupported:
          type: boolean
          description: Indicates whether the provider supports historical data at the account level.
        isInstantIntervalsSupported:
          type: boolean
          description: Indicates whether the provider supports Instant Intervals.
        isIntervalsThirdPartyPortalSupported:
          type: boolean
          description: Indicates whether the provider supports integration with third-party portals or platforms for interval data.
        isMultiFactorAuthenticationSupported:
          type: boolean
          description: This field indicates whether Arcadia is able to support MFA for the provider. It does not indicate whether the provider requires MFA. This field is deprecated in favor of multiFactorAuthentication.isSupported.
          deprecated: true
        isRealTimeCredentialValidationSupported:
          type: boolean
          description: Indicates whether the provider supports Real-Time Credential Validation.
        isThirdPartyPortalSupported:
          type: boolean
          description: Indicates whether the provider supports integration with third-party portals or platforms.
        multiFactorAuthentication:
          $ref: '#/components/schemas/PlugMultiFactorAuthenticationSupportResource'
        name:
          type: string
          description: The name of the utility service provider.
        region:
          type: string
          description: The region associated with the provider.
          enum:
          - AFRICA
          - ASIA
          - EUROPE
          - CARIBBEAN
          - CENTRAL_AMERICA
          - NORTH_AMERICA
          - OCEANIA
          - SOUTH_AMERICA
        requiredFieldMetadata:
          uniqueItems: true
          type: array
          description: Detailed information about the required input fields for this provider.
          items:
            $ref: '#/components/schemas/PlugTemplateInputMetadata'
        requiredFields:
          uniqueItems: true
          type: array
          description: The inputs needed to submit a request for this provider.
          items:
            type: string
            description: The inputs needed to submit a request for this provider.
        serviceTypes:
          uniqueItems: true
          type: array
          description: An array of all type of service supported, such as electricity, water, or gas.
          items:
            type: string
            description: An array of all type of service supported, such as electricity, water, or gas.
        statements:
          $ref: '#/components/schemas/PlugStatementProviderSupportResource'
        website:
          type: string
          description: The website for the provider.
      description: An array of unique identifiers of the utility service provider
    PageMetadata:
      required:
      - number
      - size
      - totalElements
      - totalPages
      type: object
      properties:
        number:
          type: integer
          format: int64
        size:
          type: integer
          format: int64
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int64
      description: Specifies which page of results to return; this is 0-indexed
    PlugIntervalProviderSupportResource:
      required:
      - isHistorySupported
      - isInstantIntervalsSupported
      - isSupported
      - serviceTypes
      type: object
      properties:
        isHistorySupported:
          type: boolean
          description: Indicates whether the provider supports historical interval data extraction.
        isInstantIntervalsSupported:
          type: boolean
          description: Indicates whether the provider supports instant interval extraction.
        isSupported:
          type: boolean
          description: Indicates whether the provider supports interval data extraction.
        serviceTypes:
          uniqueItems: true
          type: array
          description: An array of service types from the provider that are supported.
          items:
            type: string
            description: An array of service types from the provider that are supported.
      description: Detailed information about the provider's interval support.
    PlugTemplateInputMetadata:
      type: object
      properties:
        fieldLabel:
          type: string
          description: 'This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is the label you should use for the input field. '
        fieldLength:
          type: integer
          description: 'This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is the length of the input field. You can use this to build input validations. '
          format: int32
        fieldName:
          type: string
          description: This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is the name that corresponds to the field you would use when submitting a credential to the API (e.g. username, username2, etc.).
        fieldNumber:
          type: integer
          description: This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is for indicating the order that login inputs appear on the page.
          format: int32
        fieldPart:
          type: integer
          description: This field is only relevant to you if you are building your own Connect component. It will help your UX mimic that of the utility login page so you can provide a more realistic sign-in experience to your end users. This is for handling input fields when they are are split by dashes or other symbols, indicating with part this input corresponds to.
          format: int32
      description: Detailed information about the required input fields for this provider.
  parameters:
    arcVersionInHeaderParam:
      name: Arcadia-Version
      in: header
      example: '2024-02-21'
      description: The Arcadia-Version for the request
      required: true
      schema:
        type: string
        default: '2024-02-21'
  securitySchemes:
    OAuth2:
      type: oauth2
      description: This API uses OAuth2 with the client credentials flow using the ['Create an Access Token'](ref:create-access-token) endpoint. API keys can be retrieved from the [Dashboard](https://dashboard.arcadia.com/).
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: /oauth2/token
x-provenance:
  method: harvested
  publisher: Arcadia
  source: https://docs.arcadia.com/openapi/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)