Recipients

get
Get all recipients

https://api.openx.solar/recipient/all
curl -X GET -H "Content-Type: application/x-www-form-urlencoded" -H "Origin: localhost" "http://api2.openx.solar/recipient/all"
Request
Response
Request
Query Parameters
token
required
string
username
required
string
Response
200: OK

post
Register Recipient

https://api.openx.solar/recipient/register
Request
Response
Request
Body Parameters
seedpwd
required
string
pwhash
required
string
username
required
string
name
required
string
Response
200: OK

get
Validate Recipient

https://api.openx.solar/recipient/validate
curl -X GET "http://api2.openx.solar/recipient/validate?username=martin&token=pmkjMEnyeUpdTyhdHElkBExEKeLIlYft"
Request
Response
Request
Query Parameters
token
required
string
username
required
string
Response
200: OK

post
Payback Recipient

https://api.openx.solar/recipient/payback
Request
Response
Request
Body Parameters
projIndex
required
string
seedpwd
required
string
amount
required
string
assetName
required
string
token
required
string
username
required
string
Response
200: OK

post
Store device ID

https://api.openx.solar/recipient/deviceId
Request
Response
Request
Body Parameters
deviceId
required
string
token
required
string
username
required
string
Response
200: OK

post
Store device start time

https://api.openx.solar/recipient/startdevice
Request
Response
Request
Body Parameters
start
required
string
token
required
string
username
required
string
Response
200: OK

post
Store location of device

https://api.openx.solar/recipient/storelocation
Request
Response
Request
Body Parameters
location
required
string
token
required
string
username
required
string
Response
200: OK

get
Choose blind auction

https://api.openx.solar/recipient/auction/choose/blind
curl -X GET "http://api2.openx.solar/recipient/auction/choose/blind?username=martin&token=pmkjMEnyeUpdTyhdHElkBExEKeLIlYft"
Request
Response
Request
Query Parameters
username
required
string
token
required
string
Response
200: OK

get
Choose vickrey auction

https://api.openx.solar/recipient/auction/choose/vickrey
curl -X GET "http://api2.openx.solar/recipient/auction/choose/vickrey?username=martin&token=pmkjMEnyeUpdTyhdHElkBExEKeLIlYft"
Request
Response
Request
Query Parameters
username
required
string
token
required
string
Response
200: OK

get
Choose time auction

https://api.openx.solar/recipient/auction/choose/time
curl -X GET "http://api2.openx.solar/recipient/auction/choose/time?username=martin&token=pmkjMEnyeUpdTyhdHElkBExEKeLIlYft"
Request
Response
Request
Query Parameters
username
required
string
token
required
string
Response
200: OK

post
Unlock Project

https://api.openx.solar/recipient/unlock/opensolar
Request
Response
Request
Body Parameters
projIndex
required
string
seedpwd
required
string
token
required
string
username
required
string
Response
200: OK

post
Add Email

https://api.openx.solar/recipient/addemail
Request
Response
Request
Body Parameters
email
optional
string
token
required
string
username
required
string
Response
200: OK

post
Finalize Project

https://api.openx.solar/recipient/finalize
Request
Response
Request
Body Parameters
projIndex
required
string
token
required
string
username
required
string
Response
200: OK

post
Originate Project

https://api.openx.solar/recipient/originate
Request
Response
Request
Body Parameters
projIndex
required
string
token
required
string
username
required
string
Response
200: OK

get
Get Asset Trust Limit

https://api.openx.solar/recipient/trustlimit
curl -X GET -H "Content-Type: application/x-www-form-urlencoded" -H "Origin: localhost" "http://api2.openx.solar/user/increasetrustlimit?username=john&token=pmkjMEnyeUpdTyhdHElkBExEKeLIlYft&trust=10&seedpwd=x"
Request
Response
Request
Body Parameters
assetName
required
string
token
required
string
username
required
string
Response
200: OK

post
Store State Hash Teller

https://api.openx.solar/recipient/ssh
Request
Response
Request
Body Parameters
ssh
required
string
token
required
string
username
required
string
Response
200: OK

post
One time unlock

https://api.openx.solar/recipient/onetimeunlock
Request
Response
Request
Body Parameters
seedpwd
required
string
projIndex
required
string
token
required
string
username
required
string
Response
200: OK

post
Register Teller

https://api.openx.solar/recipient/register/teller
Request
Response
Request
Body Parameters
projIndex
required
string
url
required
string
token
required
string
username
required
string
Response
200: OK

get
Recipient Dashboard

https://api.openx.solar/recipient/dashboard
Request
Response
Request
Query Parameters
username
required
string
token
required
string
Response
200: OK

post
Set Company Bool

https://api.openx.solar/recipient/company/set
Request
Response
Request
Body Parameters
token
required
string
username
required
string
Response
200: OK

post
Set company details

https://api.openx.solar/recipient/company/details
Request
Response
Request
Body Parameters
companytype
optional
string
name
optional
string
legalname
optional
string
address
optional
string
country
optional
string
city
optional
string
zipcode
optional
string
role
optional
string
token
required
string
username
required
string
Response
200: OK

post
Store Teller Energy Value

https://api.openx.solar/recipient/teller/energy
Request
Response
Request
Body Parameters
energy
required
string
token
required
string
username
required
string
Response
200: OK