# Arcadia Documentation ## Guides - [Building Meter Level Usage Data CSVs](https://docs.arcadia.com/docs/building-meter-level-usage-data-csvs.md): How to build a CSV file that contains the meter level usage you are interested in. - [Add a Correlation ID to Connect](https://docs.arcadia.com/docs/add-a-correlation-id-to-connect.md): Learn to use a Correlation ID to identify your customers within the Plug Dashboard. - [Customize Connect](https://docs.arcadia.com/docs/customize-connect.md): Customizing the appearance of Connect to meet your needs - [Integrate Connect](https://docs.arcadia.com/docs/integrate-connect.md): Developer guidance on how to embed Connect into a website or email using HTML - [Provider Data Migrations](https://docs.arcadia.com/docs/provider-data-migrations.md) - [Group & Sort Aggregated Meter Usage Data by Site ID & Service Type](https://docs.arcadia.com/docs/group-and-sort-aggregated-meter-usage-data-by-site-id-and-service-type.md) - [Group & Sort Aggregated Meter Usage Data by Site ID & Unit of Measure](https://docs.arcadia.com/docs/group-and-sort-aggregated-meter-usage-data-by-site-id-and-unit-of-measure.md) - [Advanced Search and Triage](https://docs.arcadia.com/docs/advanced-search-and-triage.md): A walkthrough of the search and filter functionalities on Dashboard. - [Arcadia Impersonation Feature](https://docs.arcadia.com/docs/arcadia-impersonation-feature.md): Understanding Arcadia Dashboard impersonation. - [Bulk Account Update](https://docs.arcadia.com/docs/bulk-account-update.md): A walkthrough of the bulk account update functionalities on the Dashboard. - [Bulk Credential Upload](https://docs.arcadia.com/docs/bulk-credential-upload.md): A walkthrough of the bulk credential upload functionalities on Dashboard. - [Bulk Site Upload](https://docs.arcadia.com/docs/bulk-site-upload.md): A walkthrough of the bulk site upload functionalities on Dashboard. - [Custom Data](https://docs.arcadia.com/docs/custom-data.md): A detailed walk through of custom data. - [Discovered and Expected Accounts](https://docs.arcadia.com/docs/discovered-and-expected-accounts.md) - [Discovered and Published Statements](https://docs.arcadia.com/docs/discovered-and-published-statements.md): Early access to source documents that have not yet passed data quality checks. - [Bulk Meter Mapping Upload](https://docs.arcadia.com/docs/bulk-meter-mapping-upload.md): A walkthrough of the bulk meter mapping upload functionalities on Dashboard. - [Guided Site Onboarding](https://docs.arcadia.com/docs/guided-site-onboarding.md): A detailed walk through of site-to-meter mapping functionality. - [Health Overview](https://docs.arcadia.com/docs/health-overview-page.md): A detailed guide for the metrics on the Overview page. - [Identifying Statement Gaps](https://docs.arcadia.com/docs/identifying-statement-gaps.md): A detailed walkthrough of the statement gap identification feature. - [Dashboard User Guide](https://docs.arcadia.com/docs/dashboard-user-guide.md): An overview of the new Dashboard, released January 4, 2024. - [Provider Coverage](https://docs.arcadia.com/docs/provider-coverage.md): Real time data showing what providers are supported on Plug Statements and Plug Intervals. - [Statement Versioning and Repair](https://docs.arcadia.com/docs/statement-versioning-and-repair.md): System of record and process to improve data quality. - [Automated Guest Access](https://docs.arcadia.com/docs/automated-guest-access.md) - [Automated MFA Login - Arcadia Managed Email ](https://docs.arcadia.com/docs/automated-mfa-login-arcadia-managed-email.md) - [Automated MFA Opt-Out Guide](https://docs.arcadia.com/docs/automated-mfa-opt-out-guide.md): Guide to using the Automated MFA Opt-Out solution to disable MFA for a credential. - [Multi-factor Authentication (MFA)](https://docs.arcadia.com/docs/mfa.md) - [Token Storage](https://docs.arcadia.com/docs/token-storage.md): Guide to Onboarding and Re-Authenticating Utility Credentials Using the Plug Dashboard - [Organization Configurations](https://docs.arcadia.com/docs/organization-configurations.md) - [Discovered Meters and Active Meter Data Recency](https://docs.arcadia.com/docs/discovered-meters-and-active-meter-data-recency.md): A walkthrough of discovered meter data. - [Plug Intervals](https://docs.arcadia.com/docs/plug-intervals.md) - [Meter Management](https://docs.arcadia.com/docs/meter-management.md) - [Plug Intervals FAQ](https://docs.arcadia.com/docs/plug-intervals-faq.md) - [Plug Intervals : Provider Coverage](https://docs.arcadia.com/docs/plug-intervals-provider-coverage.md) - [Plug Intervals: Smart Meter Texas](https://docs.arcadia.com/docs/plug-intervals-smart-meter-texas.md) - [Residential Utility Accounts with Multiple Meters](https://docs.arcadia.com/docs/residential-utility-accounts-with-multiple-meters.md) - [Proration and Inference](https://docs.arcadia.com/docs/proration-and-inference.md): We can now prorate usages and charges to the meter level and infer usages at the meter level when they are not present. - [Uploaded Bills Processing](https://docs.arcadia.com/docs/uploaded-bills-processing.md): An overview of how Arcadia accesses utility data from uploaded bills and invoices along with the coverage we support. - [Plug - Email PDF Support BETA](https://docs.arcadia.com/docs/plug-email-beta.md) - [Correlation IDs](https://docs.arcadia.com/docs/correlationids.md) - [Data Access Options](https://docs.arcadia.com/docs/data-access-options.md) - [DataHub Tables](https://docs.arcadia.com/docs/datahub-tables.md) - [DataHub Overview](https://docs.arcadia.com/docs/datahub-overview.md) - [Plug API Field Descriptions](https://docs.arcadia.com/docs/plug-api-field-descriptions.md): Field descriptions for Plug API resources. - [Plug Statements Product FAQs](https://docs.arcadia.com/docs/product-faqs.md) - [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing.md): Learn and test the Arcadia Platform without real provider credentials with the Plug Sandbox. - [Single Sign On (SSO)](https://docs.arcadia.com/docs/single-sign-on.md) - [Status and Status Detail Descriptions](https://docs.arcadia.com/docs/status-and-status-detail-definitions.md): Definitions for possible statuses and status details in the Plug API. - [MCP Setup](https://docs.arcadia.com/docs/mcp.md) - [UDS and Plug API Differences](https://docs.arcadia.com/docs/api-authentication.md): Read this page prior to starting an API integration with Plug to understand how key API mechanics are different in Plug compared to UDS. - [Legacy UDS API to Plug API](https://docs.arcadia.com/docs/legacy-uds-api-to-plug-api.md) - [UDS to Plug Status Mapping](https://docs.arcadia.com/docs/uds-to-plug-status-mapping.md): Migrating from UDS to Plug involves a shift from a multi-field status model to a unified, action-oriented model. - [Legacy UDS Platform to Plug Platform](https://docs.arcadia.com/docs/legacy-uds-platform-to-plug-platform.md) - [Plug to UDS Bridge for MFA (Phase 1)](https://docs.arcadia.com/docs/plug-uds-bridge-for-mfa-phase-1.md) - [Plug SQL 1.4 File Delivery Migration Guide](https://docs.arcadia.com/docs/plug-sql-14-file-delivery-migration-guide.md): A quickstart guide for customers transitioning from UDS SQL 1.3 to Plug SQL 1.4 file delivery (SFTP). - [Differences between Console and Dashboard](https://docs.arcadia.com/docs/changes-between-console-and-dashboard.md): Learn more about the primary differences between legacy Console and the Dashboard, released January 4, 2024 - [Legacy Utility Cloud API to Plug API](https://docs.arcadia.com/docs/uc-plug-detailed-migration-guide.md): Detailed Migration Guide - [Links to Legacy Guides](https://docs.arcadia.com/docs/links-to-legacy-guides.md) - [API Quick Start](https://docs.arcadia.com/docs/api-quick-start-guide.md): Step by step guide to using the API - [Account and Meter Identification](https://docs.arcadia.com/docs/account-and-meter-identification.md) - [Indeterminate Services](https://docs.arcadia.com/docs/indeterminate-services.md) - [Indirect Sources and Statement Chains](https://docs.arcadia.com/docs/indirect-sources-and-billing.md) - [Consolidated & Summary Billing](https://docs.arcadia.com/docs/provider-invoice-data-modeling-consolidated-billing.md) - [Adjustments & Provider Statement Versioning](https://docs.arcadia.com/docs/provider-statement-versioning-adjustments.md) - [Sewer Meter and Charges](https://docs.arcadia.com/docs/sewer-meter-and-charges.md) - [Time Normalization](https://docs.arcadia.com/docs/time-normalization.md) - [Usage Attribution & Redundancy](https://docs.arcadia.com/docs/usage-attribution-redundancy.md) - [Handling Common Data Scenarios and Edge Cases](https://docs.arcadia.com/docs/handling-common-data-scenarios-and-edge-cases.md) - [How P&I Impacts the Data Structure](https://docs.arcadia.com/docs/how-pi-impacts-the-data-structure.md) - [Arcadia Data Model](https://docs.arcadia.com/docs/arcadia-data-model.md) - [Key Concepts](https://docs.arcadia.com/docs/key-concepts.md): Learn how data is structure, how to find the data you need, and handle edge cases. - [Locating the Data You Need](https://docs.arcadia.com/docs/locating-the-data-you-need.md) - [Possible Data Model Scenarios](https://docs.arcadia.com/docs/possible-data-model-scenarios.md) - [The Value of a Site](https://docs.arcadia.com/docs/the-value-of-a-site.md): An overview of what sites are and how sites provide value. - [Dashboard Quick Start](https://docs.arcadia.com/docs/dashboard-quick-start-guide.md): How to quickly connect, view, and download data from the Dashboard - [Supported Service Types](https://docs.arcadia.com/docs/supported-service-types.md): Details on the variety of supported provider service types (eg. electricity, water, etc.) ## API Reference - [Get Organization Events](https://docs.arcadia.com/reference/get-organization-events.md): This endpoint allows you to view the history of changes made to your organization's custom data fields. This endpoint is pageable. - [Retrieve Organization](https://docs.arcadia.com/reference/retrieve-organization.md): This endpoint returns your Arcadia organization name and also returns your account and meter level custom data field names. - [Set Organization Custom Data](https://docs.arcadia.com/reference/set-organization-custom-data.md): In order to use account or meter level custom data fields, you need to define the field names. You can update these custom data field names through this endpoint. You can have up to 25 custom data fields at the account level and up to 10 at the meter level. This is a PUT method, which requires all fields be provided to ensure a complete update of the existing resource. - [Update Organization Custom Data](https://docs.arcadia.com/reference/update-organization-custom-data.md): In order to use account or meter level custom data fields, you need to define the field names. You can update these custom data field names through this endpoint. You can have up to 25 custom data fields at the account level and up to 10 at the meter level. - [Create Account Through Third Party Portal](https://docs.arcadia.com/reference/create-account-through-third-party-portal.md): Create a new account in the Arcadia system. This is used for providers that support third party portals for indirect account access. Rather than submitting utility login credentials, you would submit account numbers. The end user will receive an email and have to approve access before Arcadia can read information from the provider. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Download Account Statements](https://docs.arcadia.com/reference/download-account-statements.md): Downloading a CSV file with high-level summary information for account, statements, and associated metadata is a 2 step process. The first step (this one) prepares the download and provides a URL in the response body that can be used for downloading the CSV file. [The next step](ref:stream-download) is to download the file using a GET request with the response body URL. The format of the generated CSV is separate from and will not exactly match the JSON you receive from the API endpoint. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Account's Events](https://docs.arcadia.com/reference/list-accounts-events.md): This endpoint allows you to view the event history for an account. For example, you can query this endpoint to find out when an account was created and who it was created by. This endpoint is pageable. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Account's Payments](https://docs.arcadia.com/reference/list-accounts-payments.md): A payment is a transaction made by the account holder to decrease the balance of the account. An account may return one or many payments for each account. This endpoint is pageable. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Accounts](https://docs.arcadia.com/reference/list-accounts.md): Get a list of accounts in the Arcadia system. This endpoint is pageable. If your organization does not have the Intervals product enabled and if the account is not activated, you will see limited detailed data returned. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Detailed Accounts](https://docs.arcadia.com/reference/list-detailed-accounts.md): Get a list of Detailed Accounts in the Arcadia system. This endpoint is pageable. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Retrieve Account](https://docs.arcadia.com/reference/retrieve-account.md): If you have the accountId, you can use this endpoint to retrieve the details for that specific account. If your organization does not have the Intervals product enabled and if the associated account is not activated, you will see limited detailed data returned. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Retrieve Detailed Account](https://docs.arcadia.com/reference/retrieve-detailed-account.md): Retrieve a single Detailed Account record. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Set Account](https://docs.arcadia.com/reference/set-account.md): Each account can have up to 25 custom data fields associated. Custom data fields are not required. Custom data allows you to organize accounts and tie them back to records in your own system. To update a custom data field, the field must already have a defined label. To define a Custom Data label, you must use the [Update Organization Custom Data](ref:update-organization-custom-data) endpoint.This is a PUT method, which requires all fields be provided to ensure a complete update of the existing resource. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Update Account](https://docs.arcadia.com/reference/update-account.md): To make updates to a specific account, you can make a PATCH call to the accounts endpoint. Each account can have up to 25 custom data fields associated. Custom data fields are not required. Custom data allows you to organize accounts and tie them back to records in your own system. To update a custom data field, the field must already have a defined label. To define a Custom Data label, you must use the [Update Organization Custom Data](ref:update-organization-custom-data) endpoint. Publisher account activation/deactivation directly propagates to all pass through accounts. isStatementsProductActive for pass through accounts cannot be independently updated as they directly reflect that of the publisher account. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Create an Access Token](https://docs.arcadia.com/reference/create-access-token.md): Use API credentials from the Dashboard to create an Access Token that has permission to use all Arcadia API endpoints. API access tokens are valid for one hour. - [Create Credential](https://docs.arcadia.com/reference/create-credential.md): The credential endpoint allows you to create a new credential in the system. In order to create a new credential, you must submit the required provider ID, username, and password as defined by the providers endpoint. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Disable Credential Along With its Associated Accounts](https://docs.arcadia.com/reference/disable-credential-along-with-its-associated-accounts.md): To disable a credential along with its accounts, make a PATCH call to this credentials endpoint with a specific credentialId. In order to disable a credential from the system, the credential must have no running job. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Generate Encoded Arcadia Connect URL](https://docs.arcadia.com/reference/generate-encoded-arcadia-connect-url.md): This endpoint generates a submission URL for Arcadia Connect with encoded parameters. The encoding prevents users from tampering with the generated URLs, so they may be shared with users to track which user submitted each Credential. Credentials submitted through an encoded URL will have the provided Correlation ID and will have the `createdBy` field set to the user who generates this link if `isCreatorAttributed` is set to true. A user can submit multiple Credentials through a URL, but the URL expires after 30 days. Learn more about Correlation IDs in Connect [here](https://docs.arcadia.com/docs/add-a-correlation-id-to-connect). - [Get the credential's count of associated account, statement and meter resources](https://docs.arcadia.com/reference/get-the-credentials-count-of-associated-account-statement-and-meter-resources.md): This endpoint returns the count of Accounts, Meters and Statements that was obtained by a specific credential. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Initiate MFA Refresh](https://docs.arcadia.com/reference/initiate-mfa-refresh.md): Starts a job attempting to login to the credential so that its MFA session can be refreshed. This endpoint can only be used for Credentials for Providers which Arcadia supports MFA for. Read more about the MFA workflow [here](https://docs.arcadia.com/docs/mfa). This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Credential's Events](https://docs.arcadia.com/reference/list-credentials-events.md): This endpoint allows you to view the event history for a credential. For example, you query this endpoint to find out when a credential was created and who it was created by. This endpoint is pageable. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Credentials](https://docs.arcadia.com/reference/list-credentials.md): A credential is defined as a set of login requirements needed for Arcadia to access data from utility providers. The credentials endpoint allows you to get a list of all the credentials that are in the Arcadia system. This endpoint is pageable. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Refresh MFA Credentials With Arcadia Connect](https://docs.arcadia.com/reference/refresh-mfa-credentials-with-arcadia-connect.md): This endpoint generates a Connect URL that allows a user to refresh their multi-factor authentication (MFA) session for a specified credential. The URL generated will only work for 72 hours after it is generated. Read more about the MFA workflow [here](https://docs.arcadia.com/docs/mfa). This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Retrieve Credential](https://docs.arcadia.com/reference/retrieve-credential.md): If you have the credentialId for a specific credential, you can get the details of that credential. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Retrieve Sensitive Credentials](https://docs.arcadia.com/reference/retrieve-sensitive-credentials.md): This endpoint allows you to retrieve the passwords for a given credential. You must be an admin user to use this endpoint. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Submit Multi-factor Authentication Method](https://docs.arcadia.com/reference/submit-multi-factor-authentication-method.md): Select the multi-factor authentication (MFA) verification method for the specified credential's current job. Read more about the MFA workflow [here](https://docs.arcadia.com/docs/mfa). - [Submit One-Time Passcode](https://docs.arcadia.com/reference/submit-one-time-passcode.md): Submit the one-time passcode for the specified credential's current job after selecting the multi-factor authentication (MFA) verification method. Read more about the MFA workflow [here](https://docs.arcadia.com/docs/mfa). - [Update Credential](https://docs.arcadia.com/reference/update-credential.md): To make updates to a credential, make a PATCH call to the credentials endpoint with a specific credentialId. For a list of fields that can be updated look below. None of these fields are required, but at least one field must be passed in the body to update a credential. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Update Credentials With Arcadia Connect](https://docs.arcadia.com/reference/update-credentials-with-arcadia-connect.md): This endpoint generates a Connect URL that allows a user to update their password for a specified credential. The URL generated will only work for 72 hours after it is generated. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Delete Credential Along With its Accounts, Meters, and Statements Resources](https://docs.arcadia.com/reference/delete-credential-along-with-its-accounts-meters-and-statements-resources.md): Use this endpoint to delete a Credential from the system. Once completed, this Credential and its associated Accounts, Meters, and Statements resources will be deleted and cannot be recovered. After completion, you can check the status of deletion by using the Deletion Log ID from the response body and call [this endpoint](ref:retrieve-deletion-log). This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Delete Site](https://docs.arcadia.com/reference/delete-site.md): Unlike Credential and File deletions, Site deletion does not delete any related entities, but it does remove references to the deleted Site on those related entities. For example, Meters assigned to the site will be unassigned when the Site is deleted. After completion, you can check the status of deletion by using the Deletion Log ID from the response body and call [this endpoint](ref:retrieve-deletion-log). This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Deletes File Along With its Accounts, Meters, and Statements Resources](https://docs.arcadia.com/reference/deletes-file-along-with-its-accounts-meters-and-statements-resources.md): Once completed, this File and its associated Accounts, Meters, and Statements resources will be deleted and cannot be recovered. After completion, you can check the status of deletion by using the Deletion Log ID from the response body and call [this endpoint](ref:retrieve-deletion-log). - [Retrieve Deletion Log](https://docs.arcadia.com/reference/retrieve-deletion-log.md): This endpoint allows you to view the details of a particular deletion request, after performing the deletion. - [Download Discovered Statement Source](https://docs.arcadia.com/reference/download-discovered-statement-source.md): Download the source file for a discovered statement. - [List Discovered Statement Versions](https://docs.arcadia.com/reference/list-discovered-statement-versions.md): List all versions of a specific Discovered Statement. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Discovered Statements](https://docs.arcadia.com/reference/list-discovered-statements.md): Get a list of discovered statements in the Arcadia system. This endpoint is pageable. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Retrieve a Discovered Statement Version](https://docs.arcadia.com/reference/retrieve-a-discovered-statement-version.md): Retrieve a specific version of a Discovered Statement. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Retrieve Discovered Statement](https://docs.arcadia.com/reference/retrieve-discovered-statement.md): Retrieve a single discovered statement record. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Create a CSV Download Request](https://docs.arcadia.com/reference/create-a-csv-download-request.md): This endpoint will generate a CSV report based on the provided parameters. The `globalSearch` and `search` parameters reuse the search functionality for the list endpoints of the `entityType` specified: - [Account and Statement Gap](ref:list-accounts) - [Credential](ref:list-credentials) - [File](ref:list-files) - [Meter](ref:list-meters) - [Site](ref:list-sites) - [Statement](ref:list-statements) The columns in the report will vary based on `entityType`. By default (if the `columns` parameter is not provided), all available fields will be included. The names of these columns can then be passed in the `columns` parameter for future reports to only include those fields. If `downloadMethod` is set to `IN_BROWSER`, use information in the response to make a request to the [Get the DownloadRequest](ref:get-the-downloadrequest) endpoint to retrieve the file. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Get the DownloadRequest](https://docs.arcadia.com/reference/get-the-downloadrequest.md): If you have the specific download request ID, this endpoint allows you to retrieve detailed information about the download request. - [Stream Download](https://docs.arcadia.com/reference/stream-download.md): Downloading a CSV file through the API is a 2 step process. The first step prepares the download and provides a URL in the response body that can be used for downloading the CSV file. The next step (this one) is to download the file using a GET request with the response body URL. With this endpoint, you can download the accounts, meters, statements or associated metadata when it is ready. The first step can be performed using any of the endpoints below. * [Download Account Statements](ref:download-account-statements) * [Download Meter Usage](ref:download-meter-usage) * [Download Sites' Usage](ref:download-sites-usage) - [Create Expected Account](https://docs.arcadia.com/reference/create-expected-account.md): This endpoint allows you to create a new expected account in the Arcadia system. - [List Expected Accounts](https://docs.arcadia.com/reference/list-expected-accounts.md): Get a list of expected accounts in the Arcadia system. This endpoint is pageable. - [Add Files](https://docs.arcadia.com/reference/add-files.md): This endpoint allows you to upload new files into the system. In order to add new files, they must be in PDF format. Multiple statements cannot be combined into a single file; each individual file must only contain one statement. The maximum number of files in an upload is 75, and the combined size of all files must be less than 1 GB. - [Download File Source](https://docs.arcadia.com/reference/download-file-source.md): This endpoint allows you to retrieve the source PDF for a specific file. - [Get the File's Count of Associated Account, Statement and Meter Resources](https://docs.arcadia.com/reference/get-the-files-count-of-associated-account-statement-and-meter-resources.md): This endpoint returns the count of Accounts, Meters and Statements that was obtained by a specific file. - [List File's Events](https://docs.arcadia.com/reference/list-files-events.md): This endpoint allows you to view the event history for a file. For example, you can query this endpoint to find out when a file was created and who it was created by. This endpoint is pageable. - [List Files](https://docs.arcadia.com/reference/list-files.md): A file is a utility statement PDF uploaded for OCR processing on the Arcadia Platform. This endpoint allows you to get a list of all the files that are in the system. This endpoint is pageable. - [Retrieve File](https://docs.arcadia.com/reference/retrieve-file.md): This endpoint allows you to view the details of a particular file. - [Update File](https://docs.arcadia.com/reference/update-file.md): To update a file, make a PATCH call to the files endpoint with a specific fileId. Currently only correlationId can be updated. - [List Intervals for a Meter](https://docs.arcadia.com/reference/list-intervals-for-a-meter.md): The Intervals API endpoint allow you to interact programmatically with the intervals data offering of the Arcadia Platform to retrieve utility provided intervals data for electric meters. This solution allows you to use utility data to conduct granular energy analysis. Use-cases for this include solar/storage modelling and Demand Response programs validation. The intervals data API endpoints delivers up to a year’s historical data initially and then continues to deliver the latest meter readings on an on-going basis as made available the provider. - [List Normalized Intervals for a Meter](https://docs.arcadia.com/reference/list-normalized-intervals-for-a-meter.md): The Intervals API endpoint allow interacting programmatically with the intervals data offering of the Arcadia Platform to retrieve utility provided intervals data for electric meters. The normalized version of the interval endpoint makes integration simpler by consistently delivering interval data of 15 minute intervals irrespective of the length of timestamp in the source data collected from utility. - [Versioning](https://docs.arcadia.com/reference/api-versioning.md): Arcadia API versioning system and breaking and non-breaking changes definitions. - [Data Values](https://docs.arcadia.com/reference/data-values-1.md) - [Introduction](https://docs.arcadia.com/reference/introduction.md) - [Pagination](https://docs.arcadia.com/reference/pagination.md) - [Rate Limiting](https://docs.arcadia.com/reference/rate-limiting.md) - [Release Phases](https://docs.arcadia.com/reference/release-phases.md) - [Error Responses](https://docs.arcadia.com/reference/response-codes.md) - [Searching](https://docs.arcadia.com/reference/searching.md) - [Testing API Calls](https://docs.arcadia.com/reference/testing-api-calls.md) - [Webhooks](https://docs.arcadia.com/reference/webhooks-overview.md) - [Create Meter through an Intervals Third Party Portal](https://docs.arcadia.com/reference/create-meter-through-an-intervals-third-party-portal.md): Create a new meter in the Arcadia system. This is used for providers that support intervals third party portals for indirect account access. The end user will receive an email and have to approve access before Arcadia can read information from the provider. - [Download Meter Intervals](https://docs.arcadia.com/reference/download-meter-intervals.md): Downloading a CSV file with meter intervals is a 2 step process. The first step (this one) prepares the download and provides a URL in the response body that can be used for downloading the CSV file. [The next step](ref:stream-download) is to download the file using a GET request with the response body URL. The maximum number of meter IDs is 500. If you need to download more than 500 meters, you will need to make multiple requests. The format of the generated CSV is separate from and will not exactly match the JSON you receive from the API endpoint. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Download Meter Usage](https://docs.arcadia.com/reference/download-meter-usage.md): Downloading a CSV file with high-level summary information for meters, statements, sites, and associated metadata is a 2 step process. The first step (this one) prepares the download and provides a URL in the response body that can be used for downloading the CSV file. [The next step](ref:stream-download) is to download the file using a GET request with the response body URL. The maximum number of meter IDs is 500. If you need to download more than 500 meters, you will need to make multiple requests. The format of the generated CSV is separate from and will not exactly match the JSON you receive from the API endpoint. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Meter's Events](https://docs.arcadia.com/reference/list-meters-events.md): This endpoint allows you to view the event history for a meter. For example, you can query this endpoint to find out when a meter was created and who it was created by. This endpoint is pageable. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Meters](https://docs.arcadia.com/reference/list-meters.md): Arcadia retrieves Meters from utility providers using the credentials that are submitted. There can be one or more meters behind a credential. This endpoint is pageable This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Retrieve Meter](https://docs.arcadia.com/reference/retrieve-meter.md): You can use this endpoint to retrieve the details for a specific meter. If your organization does not have the Intervals product enabled and if the associated account is not activated, you will see limited detailed data returned. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Set Meter](https://docs.arcadia.com/reference/set-meter.md): Each meter can have up to 10 custom data fields associated. Custom data fields are not required. Custom data allows you to organize meters and tie them back to records in your own system. To update a custom data field, the field must already have a defined label. To define a Custom Data label, you must use the [Update Organization Custom Data](ref:update-organization-custom-data) endpoint. This is a PUT method, which requires all fields be provided to ensure a complete update of the existing resource. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Update Meter](https://docs.arcadia.com/reference/update-meter.md): To make updates to a specific meter, you can make a PATCH call to the meters endpoint. Each meter can have up to 10 custom data fields associated. Custom data fields are not required. Custom data allows you to organize meters and tie them back to records in your own system. To update a custom data field, the field must already have a defined label. To define a Custom Data label, you must use the [Update Organization Custom Data](ref:update-organization-custom-data) endpoint. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Providers](https://docs.arcadia.com/reference/list-providers.md): Get a list of all Providers available in the Arcadia system. This endpoint is pageable. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Retrieve Provider](https://docs.arcadia.com/reference/retrieve-provider.md): Retrieve a single Provider. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Add Meters to a Site](https://docs.arcadia.com/reference/add-meters-to-a-site.md): This endpoint allows you to associate a list of meters with a site. Provide a non-empty list of meter IDs in the request body to add the specified meters to the site. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Create Site](https://docs.arcadia.com/reference/create-site.md): This endpoint allows you to create a new site in the Arcadia system. A site object allows you to group credentials, accounts, meters, and statements by a location or another logical grouping for your system. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Download Meter Intervals by Site](https://docs.arcadia.com/reference/download-meter-intervals-by-site.md): Downloading a CSV file with meter intervals is a 2 step process. The first step (this one) prepares the download and provides a URL in the response body that can be used for downloading the CSV file. [The next step](ref:stream-download) is to download the file using a GET request with the response body URL. The maximum number of meter IDs is 500. If you need to download more than 500 meters, you will need to make multiple requests. The format of the generated CSV is separate from and will not exactly match the JSON you receive from the API endpoint. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Download Sites' Usage](https://docs.arcadia.com/reference/download-sites-usage.md): Downloading a CSV file with high-level summary information for statements, sites, and associated metadata is a 2 step process. The first step (this one) prepares the download and provides a URL in the response body that can be used for downloading the CSV file. [The next step](ref:stream-download) is to download the file using a GET request with the response body URL. The maximum number of site IDs is 500. If you need to download more than 500 sites, you will need to make multiple requests. The format of the generated CSV is separate from and will not exactly match the JSON you receive from the API endpoint. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Site's Events](https://docs.arcadia.com/reference/list-sites-events.md): This endpoint allows you to view the event history for a site. For example, you can query this endpoint to find out when a site was created and who it was created by. This endpoint is pageable. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Sites](https://docs.arcadia.com/reference/list-sites.md): The sites endpoint allows you to get a list of all the sites that are in the Arcadia system. A site object allows you to group credentials, accounts, meters, and statements by a location or another logical grouping for your system. This endpoint is pageable. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Remove Meters From a Site](https://docs.arcadia.com/reference/remove-meters-from-a-site.md): This endpoint allows you to disassociate a list of meters from a site. Note that the specified meters will not be deleted; only the association between the meters and the site will be removed. Provide a non-empty list of meter IDs in the request body to remove the specified meters from the site. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Retrieve Site](https://docs.arcadia.com/reference/retrieve-site.md): If you have the siteId, you can use this endpoint to retrieve the details for that specific site. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Update Site using PUT method](https://docs.arcadia.com/reference/update-site-using-put-method.md): Each site has 20 fields where you can define values associated. These custom data allow you to organize Arcadia data and tie them back to records in your system as well as enrich your synthetic intervals data. This is a PUT method, which requires all fields to be provided to ensure a complete update of the existing resource. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Update Site](https://docs.arcadia.com/reference/update-site.md): Each site has 20 fields where you can define values associated. These custom data allow you to organize Arcadia data and tie them back to records in your system as well as enrich your synthetic intervals data. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Download Statement Source](https://docs.arcadia.com/reference/download-statement-source.md): Arcadia provides a copy of the source file for where the system retrieved data. In most cases this is a copy of the structured PDF. In some cases this may be a PDF rendering of a portion of the website. This endpoint allows you to retrieve the source files for a specific statement. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Download Statements](https://docs.arcadia.com/reference/download-statements.md): Downloading a CSV file with high-level summary information for accounts, statements, and associated metadata is a 2 step process. The first step (this one) prepares the download and provides a URL in the response body that can be used for downloading the CSV file. [The next step](ref:stream-download) is to download the file using a GET request with the response body URL. The maximum number of statement IDs is 500. If you need to download more than 500 accounts, you will need to make multiple requests. The format of the generated CSV is separate from and will not exactly match the JSON you receive from the API endpoint. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Detailed Statements](https://docs.arcadia.com/reference/list-detailed-statements.md): Get a list of Detailed Statements in the Arcadia system. This endpoint is pageable. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Statement Versions](https://docs.arcadia.com/reference/list-statement-versions.md): List all versions of a specific Statement. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Statements](https://docs.arcadia.com/reference/list-statements.md): Get a list of statements in the Arcadia system. This endpoint does not return any line item charges or usages regardless of contribution status. This endpoint is pageable. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Retrieve Detailed Statement Version](https://docs.arcadia.com/reference/retrieve-detailed-statement-version.md): Retrieve a specific, detailed version of a Statement. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Retrieve Detailed Statement](https://docs.arcadia.com/reference/retrieve-detailed-statement.md): Retrieve a single Detailed Statement record. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Retrieve Statement Version](https://docs.arcadia.com/reference/retrieve-statement-version.md): Retrieve a specific version of a Statement. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Retrieve Statement](https://docs.arcadia.com/reference/retrieve-statement.md): Retrieve a single Statement record. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [List Webhooks](https://docs.arcadia.com/reference/list-webhooks.md): Plug can send webhook events for any notable events for recurring requests. For example, this could include if a new statement is available or we notice a credential is now resulting in login failure. This endpoint allows you to get a list of all the webhooks that are in the system. However, the system will not create any webhooks until your organization has configured a webhook URL. You can configure this in Dashboard by selecting the gear in the top right corner to open the Configuration list, then select Webhooks. This endpoint is pageable. Webhooks are deleted automatically after 30 days past their last send attempt date, except for Realtime Credential Validation (RTCV) webhooks or MFA-related webhooks, which are deleted immediately after successfully being delivered or after 3 failed send attempts. RTCV webhooks have `eventType` of either `REAL_TIME_CREDENTIAL_VALIDATION_SUCCESS` or `REAL_TIME_CREDENTIAL_VALIDATION_FAILURE` and may have a webhook URL different from the organization default if the credential was submitted via Connect. MFA webhooks have `eventType` of either `MFA_CHALLENGE_METHOD` or `MFA_CHALLENGE_CODE`. Note that the webhook resources returned by this endpoint are not the same as the payload that is sent to the webhook URL. That payload is included in the message field as a JSON string in this resource which also includes more metadata about the webhook, such as the last and next send attempt times. For more information on how webhooks work in Plug, see [this page](ref:webhooks-overview). This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Resend Webhook](https://docs.arcadia.com/reference/resend-webhook.md): If you have the webhookId for a specific webhook, you can initiate a resend attempt for that webhook. Note that this happens asynchronously and merely reschedules the webhook to be resent as soon as possible. For non-RTCV webhooks, the URL the webhook will be sent to will update automatically to the current webhook URL for your organization. You can configure this in Dashboard by selecting the gear in the top right corner to open the Configuration list, then selecting Webhooks. See the description of [this endpoint](ref:list-webhooks) for more details on how the system stores webhooks. For more information on how webhooks work in Plug, see [this page](ref:webhooks-overview). This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Retrieve Webhook](https://docs.arcadia.com/reference/retrieve-webhook.md): If you have the webhookId for a specific webhook, you can get the details of that webhook.See the description of [this endpoint](ref:list-webhooks) for more details on how the system stores webhooks. For more information on how webhooks work in Plug, see [this page](ref:webhooks-overview). This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). - [Generate a new Statement for a Sandbox Credential](https://docs.arcadia.com/reference/generate-a-new-statement-for-a-sandbox-credential.md): This endpoint triggers the generation of a new statement for a sandbox credential. It is applicable only in the sandbox mode. This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing). ## Changelog - [[Plug] New Providers - April 2026](https://docs.arcadia.com/changelog/plug-new-providers-april-2026.md) - [[Plug] Extraction Bug Fixes - April 2026](https://docs.arcadia.com/changelog/plug-extraction-bug-fixes-april-2026.md) - [[Plug] New Providers - March 2026](https://docs.arcadia.com/changelog/plug-new-providers-march-2026.md) - [[Plug] Extraction Bug Fixes - March 2026](https://docs.arcadia.com/changelog/plug-extraction-bug-fixes-march-2026.md) - [Plug: Improved full-page capture and general rendering reliability.](https://docs.arcadia.com/changelog/plug-improved-full-page-capture-and-general-rendering-reliability.md)