Documentation: shs

Represents installations of Solar Home Systems at individual customers
To import data in this format you can use our API. -> API Documentation
Rate limit: 300 requests per minute. Once the limit is exceeded, any further requests will result in a 429 (Too Many Requests) response.
You can also supply us with files in xlsx, csv or json format. -> Example CSV
Required Type p14n Blurred Autogenerated

device_external_id

id for the specific shs system as tracked by the data provider (source)

string

account_external_id

id for the specific account (e.g. paygo loan) associated with the shs device

string

serial_number

serial number of system

string

manufacturer

manufacturer of system, needed to make id when combined with serial number

string

customer_external_id

ID for the specific customer associated with the shs device

string

uid

customer_uid + device_uid

string

purchase_date

date system was purchased

date

model

model of system, needed e.g. for matching eligible systems of an rbf program

string

pv_power_w

PV panel size in watts

float

battery_energy_wh

battery capacity in watt-hour

float

voltage_v

system voltage in volts; e.g. - 5, 12 if DC or 110, 230 if AC

float

rated_power_w

max rated capacity in watts

float

customer_category

how the system is to be used: \"household\", \"institutional\", \"commercial\"

string

customer_sub_category

which type of business, which institution

string

primary_use

what appliance is the main load of system

string

payment_plan_days

repayment plan of system/loan

float

payment_plan_down_payment

amount paid at time of purchase, total cost if paid in full at purchase

float

payment_plan_amount_financed

amount to be repaid after down payment, 0 if paid in full at purchase

float

total_price

Total sales price of the device

float

payment_plan_type

\"paygo\" or \"full\" if paid in full at purchase

string

payment_plan_currency

currency code of payment plan, in ISO 4217 three character format

string

paid_off_date

date system was paid off, null if not paid off

date

repossession_date

date system was repossessed, null if not repossessed

date

is_test

is a test system, should be excluded in overall analyses

boolean

customer_name

customer first and last name (p14)

string

customer_id_number

customer identification number

string

customer_id_type

type of customer identification

string

customer_gender

Male, Female, Other, or Unknown (null)

enum: M, F, O

customer_birth_year

year of purchaser birth, for demographic analysis

integer

customer_former_electricity_source

e.g. none, solar, genset

string

customer_household_size

Number of residents of household (if residential use)

integer

customer_profession

profession of customer - e.g. farmer or shop owner

string

customer_address

customer address (p14)

string

customer_country

two-letter country code according to https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

string

customer_latitude

customer latitude (blurred to 3 decimal points)

float

customer_longitude

customer longitude (blurred to 3 decimal points)

float

customer_email

customer email (p14)

string

customer_phone

customer telephone (p14)

string

customer_phone_2

customer telephone 2 (p14)

string

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

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

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

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

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

seller_external_id

ID for the specific sales agent associated with the shs device

string

seller_name

sales agent name (p14)

string

seller_gender

male (M), female (F), other (O) or unknown (null)

enum: M, F, O

seller_address

sales agend address (p14)

string

seller_country

two-letter country code according to https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

string

seller_latitude

sales agent's latitude (blurred to 3 decimal points)

float

seller_longitude

sales agent's longitude (blurred to 3 decimal points)

float

seller_email

sales agent email (p14)

string

seller_phone

sales agent telephone (p14)

string

seller_location_area_1

sales agent first-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country

string

seller_location_area_2

sales agent second-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country

string

seller_location_area_3

sales agent third-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country

string

seller_location_area_4

sales agent fourth-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country

string

device_uid

organization_id + manufacturer + serial_number

string

customer_uid

organization_id + data_origin + customer_external_id

string

account_uid

organization_id + data_origin + account_external_id

string

created_at

Timestamp when row was inserted

datetime

updated_at

Timestamp when row was updated

datetime

source_id

References Source of data

integer

import_id

References Import of data

integer

organization_id

References Organization of data

integer

custom

Saves additional imported data out of standard structure

jsonb

data_origin

Origin of the data, generic or name of the api

string

last_import_id

Id of the last import which updated the record

integer

last_source_id

Id of the last Source which updated the record

integer