Data requests are the trigger for Urjanet to pull utility data. The information provided in the request informs where data is sourced, what data is returned, and how Urjanet notifies you of the results.
Submitting a data request is simple. Only 3 pieces of information are required:
- Provider ID (See: Searching for Utility Providers)
Once submitted, Urjanet works on the request in the background. It typically takes around 10 minutes to complete a request, but the exact timing depends on the utility provider.
The status of a request can be checked at any point during processing. For a complete list of statuses, see Urjanet's Developer Documentation.
Optional Request Parameters
When submitting a request, you should specify a Use Case. This decision will define the statement data file you receive from Urjanet.
Providers occasionally require additional factors to access their website. These fields are commonly used to hold Security Questions & Answers, site codes, or other miscellaneous data.
Typically, these fields are not required. If a provider does require this data, Urjanet will make it a requirement for submission.
When Urjanet completes its work on your request, you can receive a notification via a Callback URL. While not required, this can be a great way to know when your data is ready.
You can specify your own identifier when submitting a request. This can be used to tag the source of the submission or the user who placed the request.
Period Start & End
You can filter the data set to only return bills of a specific period. Setting a Period Start/End will ensure invoices have a Statement Date that is inside your window. For example, Period Start of 11-01-2017 would include all bills made available by the utility after 11-01-2017.
This window can be configured to match your needs. By default, the On-Demand API will set the default window to 12 months.
Data Request Link
After submission, Urjanet returns a link to the new data request. This link can be used to query the status of the request, and will later be used to download statements.