Documentation Index
Fetch the complete documentation index at: https://docs.nectarclimate.com/llms.txt
Use this file to discover all available pages before exploring further.
What is a connection?
Think of a connection like setting up automatic bill pay at your bank — except instead of paying bills, Nectar is downloading and reading them for you. You give Nectar the login credentials for a utility website (like ConEdison, PG&E, or Duke Energy), and Nectar logs in on your behalf every week to grab new bills and extract the data. Once a connection is set up, you never have to visit that utility website again. Nectar handles it all: finding new bills, downloading the PDFs, reading them with AI, and filing the data in the right place. It’s the core of how Nectar works, and it’s what saves most customers dozens of hours every month.How to create a connection
Choose your utility provider
Enter the login credentials
Configure your settings
Configuration settings explained
When you create a connection, the configuration step has several settings that control how Nectar collects and processes data. Here’s what each one means in plain terms:Sites
Which of your buildings does this utility account serve? For example, if your ConEdison login covers both your Manhattan and Brooklyn offices, select both sites. This tells Nectar where to file the bills and usage data. If you’re not sure which sites an account covers, it’s fine to select your best guess — you can always reassign data later.Datasource types
What types of utility service does this account cover? Most utility accounts are straightforward — just electricity, or just natural gas. But some combined accounts cover multiple services (like electricity and gas on the same bill). Select all the types that apply: Electricity, Gas, Water, Waste, Fuel, Solar, or District (steam, chilled water, hot water). Nectar will only process bills that match your selections.Data collection start date
How far back should Nectar look for bills? You have three choices:| Mode | When to use it | Example |
|---|---|---|
| Company default | Use whatever start date your company is configured with. Good for keeping all your connections consistent. | Your company default is set to January 2023, so every new connection pulls bills back to that date. |
| Current month | Only collect bills from this month forward. Good if you only care about future data and don’t need historical bills. | It’s March 2026 — Nectar will only grab bills from March onward. |
| Custom date | Pick a specific date. Useful when you need historical data going back to a particular point. | You’re preparing a 2024 emissions report, so you set the start date to January 1, 2024. |
Multiply by occupancy
For shared buildings where you only lease a portion of the space. If you occupy 40% of a shared office building, this setting adjusts your usage numbers to reflect only your share. A bill showing 10,000 kWh would become 4,000 kWh in your reports. Leave this off if you fully occupy the building or if the utility account already reflects only your space.Custom container
For waste and fuel accounts only. If your waste hauler picks up a specific dumpster, or a fuel company delivers to a specific tank, enter the container details (name, size, and units) here. Nectar uses this information to calculate total consumption from delivery records. For example, if you have a 500-gallon propane tank and receive deliveries of 250 gallons at a time, Nectar can track your total fuel consumption accurately.Owner email
Who should receive notifications about this connection? Enter the email address of the person who manages this utility account. They’ll get notified if the connection encounters an error (like a changed password) or when new data is collected. Usually this is you, but for accounts you manage for someone else it might be a facility manager or site contact.MFA requirement
Does this utility website require a security code to log in? Some utility portals send a text message code, use an authenticator app, or ask security questions during login. If yours does, check this box. During setup you may complete a one-time login in the browser (including MFA), then Nectar walks you through MFA forwarding — how SMS or email codes are delivered so Nectar can complete automated logins on the weekly schedule. If forwarding stops working or the portal rotates MFA, you may need to Reconnect and refresh that setup later.What to expect after connecting
- First data: Nectar typically completes the first collection within a few hours; allow up to 48 hours in some cases. How many bills you get depends on the start date setting and how much history the utility portal makes available (most keep 12 to 24 months).
- Weekly checks: After the initial pull, Nectar checks the utility portal every week for new bills. You don’t need to do anything — new bills are downloaded and processed automatically.
- Notifications: The owner email receives updates when new data arrives or when an issue needs attention.
What to share with the account holder
If you’re an energy consultant connecting someone else’s utility account, here’s a simple explanation you can pass along:“We use a platform called Nectar to automatically collect your utility data. We’ll need the login credentials for your utility website — the same username and password you’d use to view your bills online. Nectar logs in weekly to download new bills and extract the data. Your credentials are encrypted and stored securely. You can also connect the account yourself through a secure link we’ll send you.”If the account holder is uncomfortable sharing credentials directly, consider sending them an invitation instead — they enter their own login without you seeing it.
Connection status
After you create a connection, its status tells you whether data is flowing smoothly or something needs your attention. Plain-language definitions for every status — what it means and what to do — live in one place: Glossary — Connection status.Managing connections
Deactivate and activate — Need to temporarily stop data collection? Open the actions menu on the connection and click Deactivate connection. The status changes to Deactivated, weekly checks stop, and no new bills are collected — but every bill, account, and meter that was already collected stays in place. Click Activate connection when you’re ready and the next weekly check picks up from where it left off. Deactivation is reversible at any time, so prefer it over deleting whenever you might come back to the connection. If you manage connections via the API, deactivate and activate map toPATCH /connection/{id}/details with {"isActive": false} and {"isActive": true} — see the Connection lifecycle developer guide.
Delete — Permanently remove a connection you no longer need. Deletion is the right choice when the utility account itself is closed or you’ve moved to a different provider. If you might come back to the connection later, deactivate it instead — deactivation keeps everything in place and you can activate in one click.
Reconnect — If a connection enters an error state (password changed, MFA expired, etc.), use the Reconnect action. For most credential errors you re-enter username and password in the browser; for MFA token expired, Nectar opens MFA forwarding setup instead — configure how codes reach Nectar for automated logins. Reconnecting preserves the link to all existing accounts, meters, and historical data. Don’t create a new connection for the same utility account — always reconnect instead.
Send an invitation — Need the account holder to connect their own account? Open Data Input > Invitations. You can pre-fill the utility URL, sites, and utility types so they have less to fill in. See Invitations for details.
Bulk import connections
Create dozens of connections in a single upload — both online (utility portal logins) and email (forwarded bills) connection types are supported in the same template. The platform parses your file in your browser, lets you match columns, and shows validation errors inline so you can fix them without re-uploading.Steps
- Go to Data Input > Connections and click Bulk import.
- Click Download template in the upload area and choose either Excel (.xlsx) or CSV (.csv) — both files have the same columns and example rows, so pick whichever your tooling prefers.
- Drop your filled file. Required columns are auto-mapped by header name; review the mapping in step 2.
- Review and fix rows inline. Cells with errors show a red border — click a cell to edit it.
- Click Import N connections when there are zero errors.
Always-required columns
| Field | Description |
|---|---|
| Connection type | ONLINE (portal login + scrape) or EMAIL (vendor forwards bills to your nectar inbox). |
| Utility provider | Datasource brand name, e.g. Duke Energy. The platform resolves this to an existing datasource by name + URL similarity, or auto-creates a new one for review by Nectar. |
| Utility login URL | The portal entry URL for the provider. Required even when the platform already knows the datasource — it confirms you mean the same brand at the same portal. |
| Sites | Comma-separated site names. Must match exactly to existing sites in this company (case-insensitive). |
| Owner email | Workflow owner — receives reconnection requests if the connection enters an error state. |
Required for ONLINE rows
| Field | Description |
|---|---|
| Username | Utility portal username. |
| Password | Utility portal password. Encrypted on the server using AES-128. |
Required for EMAIL rows
| Field | Description |
|---|---|
| Sender emails | Comma-separated From: addresses your vendor uses to send bills. |
| Email frequency | MONTHLY, QUARTERLY, ANNUALLY, or IRREGULARLY. |
Optional columns (any row)
| Field | Description |
|---|---|
| Country | ISO-2 country code (default US) — controls which proxy region is used for online portals. |
| Datasource types | Comma-separated commodity codes (e.g. ELECTRICITY, GAS). Defaults to the datasource’s own list when blank. |
| Data collection start date | YYYY-MM-DD — when data collection should begin. Defaults to your company default. |
| Multiply by occupancy | true for commercial leased buildings where billed usage is the whole-floor total. |
| Requires MFA | true for portals that require an MFA code. See callout below. |
| Custom container name / size / units | For waste and fuel accounts that bill by container delivery. |
| Notes | Free text. |
Limits
- Up to 200 connections per import.
- Sites must already exist in your sites — bulk-create sites first if needed (see Sites — Bulk import).
- Security questions (Q&A pairs) are not supported in bulk. Set those up via the per-connection edit screen after import.
What happens after import
The same things that happen for any individual connection — Nectar starts collecting bills on the next weekly cycle, the owner email receives status notifications, and connections that fail will surface asPassword Incorrect, MFA Token Expired, or similar in the Connection status list.
FAQ
Does Nectar store the utility password?
Does Nectar store the utility password?
What happens if the utility password changes?
What happens if the utility password changes?
What if I accidentally submit the same connection twice?
What if I accidentally submit the same connection twice?
Can I connect the same utility account twice?
Can I connect the same utility account twice?
How many connections can I have?
How many connections can I have?
What if the utility website changes its design?
What if the utility website changes its design?
How often does Nectar check for new bills?
How often does Nectar check for new bills?
Why is my connection showing an error?
Why is my connection showing an error?
Can I connect utility accounts outside the US?
Can I connect utility accounts outside the US?
What does deactivating a connection do?
What does deactivating a connection do?
How do I reconnect a failed connection?
How do I reconnect a failed connection?