Documentation: meters
Rate limit: 300 requests per minute. Once the limit is exceeded, any further requests will result in a 429 (Too Many Requests) response.
| Row Name | Type | Example |
|---|---|---|
|
customer_external_id * ID for the specific customer associated with the meter
|
string |
1 |
|
device_external_id * ID for the specific meter tracked by the data provider (source)
|
string |
1234 |
|
serial_number * serial number of system
|
string |
A1233754345JL |
|
manufacturer * manufacturer of system, needed to make ID when combined with serial number
|
string |
HOP |
|
uid customer_uid + device_uid
|
string |
123-123 |
|
customer_name customer first and last name (p14)
|
string |
John Smith - stored as 7c6e6899401b76f23d4eaf4931975872f1b5d9ae026b8b8213a25cf7812d936b |
|
customer_id_number customer identification number
|
string |
L23FX1236 - stored as 6a099e5c63f0138de7b3dfa7e03c17e551ea23e53c6399a2f0d490d5d87457de |
|
customer_id_type type of customer identification |
string |
National ID |
|
customer_gender Male, Female, Other, or Unknown (null) |
enum: M, F, O |
M |
|
customer_birth_year year of purchaser birth, for demographic analysis Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
integer |
1990 |
|
customer_former_electricity_source e.g. none, solar, genset |
string |
none |
|
customer_household_size number of residents of household (if residential use) Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
integer |
5 |
|
customer_profession Profession of the customer - e.g. farmer or shop owner |
string |
farmer |
|
customer_address customer address
|
string |
Some Street 123, Example Village - stored as 452a20d7b82bd6ad82f0bf482f382bfe55f90dcb140e1e79d38b15a4450770d7 |
|
customer_country two-letter country code according to ISO 3166-1 alpha-2 |
string |
ZM |
|
customer_latitude customer latitude (blurred to 3 decimal points) Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.
|
float |
12.123 |
|
customer_longitude customer longitude (blurred to 3 decimal points) Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.
|
float |
20.456 |
|
customer_email customer email (p14)
|
string |
test@example.com - stored as b37645e1cc4bc50636c11a9a19566f2ae56764333789159dacb171580c42e49b |
|
customer_phone customer telephone (p14)
|
string |
0123456789 - stored as c340f947f1f7cb83c8f40bb5a7ad24ca78486bdfb2ef587f55ea537de17efc27 |
|
customer_phone_2 customer telephone 2 (p14)
|
string |
0123456789 - stored as c340f947f1f7cb83c8f40bb5a7ad24ca78486bdfb2ef587f55ea537de17efc27 |
|
customer_location_area_1 customer first-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country |
string |
Western |
|
customer_location_area_2 customer second-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country |
string |
Bundibugyo |
|
customer_location_area_3 customer third-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country |
string |
Bughendera County |
|
customer_location_area_4 customer fourth-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country |
string |
Bukonzo |
|
customer_location_area_5 customer fifth-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country |
string |
Buhundu |
|
installation_date date system was installed |
date |
2021-01-01 |
|
purchase_date if meter is part of an installation - date system was purchased |
date |
2022-01-01 |
|
firmware_version firmware version installed on the smart meter / modem |
string |
1.2-rc3 |
|
model specific model of system |
string |
DTZ1737 |
|
customer_category how the system is to be used: household, institutional, commercial |
string |
commercial |
|
customer_sub_category which type of business, which institution |
string |
barber shop |
|
account_external_id ID for the specific account (e.g. paygo loan) associated with the meter |
string |
11223344 |
|
payment_plan monthly or annual payment plan - e.g. Medium Consumption or High Consumption, paygo or cash |
string |
Medium Consumption |
|
payment_plan_days if meter is part of an installation with loan - repayment plan of loan Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
float |
720.5 |
|
payment_plan_down_payment if meter is part of an installation with loan - amount paid at time of purchase Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
float |
1500.0 |
|
payment_plan_amount_financed if meter is part of an installation with loan - amount to be repaid after down payment Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
float |
1500.0 |
|
total_price Total sales price of the device Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
float |
130000 |
|
payment_plan_currency if meter is part of an installation with loan - currency code of payment plan, in ISO 4217 three character format |
string |
ZMW |
|
primary_use what type of appliance (if any) is attached? - e.g. cooking, milling, tv |
string |
cooking |
|
repossession_date date system was repossessed, null if not repossessed |
date |
2022-01-01 |
|
is_locked no energy coming through |
boolean |
FALSE |
|
max_power_w max connection max load in watts Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
float |
5000 |
|
is_test Is the system installed in the field (FALSE) or for testing purposes (TRUE) |
boolean |
true |
|
device_uid organization_id + manufacturer + serial_number
|
string |
1-a2ei-ABC123 |
|
customer_uid organization_id + data_origin + customer_external_id
|
string |
1-api-1 |
|
account_uid organization_id + data_origin + account_external_id
|
string |
1-api-1 |
|
grid_uid organization_id + data_origin + grid_external_id; FK from grids table
|
string |
a2ei-X98679862w |
|
grid_name name of the (mini-)grid the meter is connected to, typically given by operator company. |
string |
SMU 12 Chinsanka |
|
grid_external_id ID for the specific (mini-)grid, used to build the grid_uid |
string |
X98679862w |
|
created_at Timestamp when row was inserted
|
datetime |
2021-05-03 6:23:55 |
|
updated_at Timestamp when row was updated
|
datetime |
2021-05-03 6:23:55 |
|
source_id References Source of data
|
integer |
1 |
|
import_id References Import of data
|
integer |
1 |
|
organization_id References Organization of data
|
integer |
1 |
|
custom Saves additional imported data out of standard structure
|
jsonb |
{ "some": "key" } |
|
data_origin Origin of the data, generic or name of the api
|
string |
generic |
|
last_import_id Id of the last import which updated the record
|
integer |
337 |
|
last_source_id Id of the last Source which updated the record
|
integer |
33 |