@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Netatmo
@base https://api.netatmo.net/api
@version 1.1.5
@auth OAuth2 | OAuth2
@endpoints 22
@hint download_for_search
@toc getpublicdata(1), getuser(1), devicelist(1), getmeasure(1), getthermostatsdata(1), getstationsdata(1), gethomecoachsdata(1), getthermstate(1), syncschedule(1), setthermpoint(1), switchschedule(1), createnewschedule(1), partnerdevices(1), gethomedata(1), getcamerapicture(1), geteventsuntil(1), getlasteventof(1), getnextevents(1), setpersonsaway(1), setpersonshome(1), addwebhook(1), dropwebhook(1)

@group getpublicdata
@endpoint GET /getpublicdata
@required {lat_ne: any, lon_ne: any, lat_sw: any, lon_sw: any}
@optional {required_data: any, filter: any}
@returns(200)

@endgroup

@group getuser
@endpoint GET /getuser
@returns(200)

@endgroup

@group devicelist
@endpoint GET /devicelist
@optional {app_type: any, device_id: any, get_favorites: any}
@returns(200)

@endgroup

@group getmeasure
@endpoint GET /getmeasure
@required {device_id: any, scale: any, type: any}
@optional {module_id: any, date_begin: any, date_end: any, limit: any, optimize: any, real_time: any}
@returns(200)

@endgroup

@group getthermostatsdata
@endpoint GET /getthermostatsdata
@optional {device_id: any}
@returns(200)

@endgroup

@group getstationsdata
@endpoint GET /getstationsdata
@optional {device_id: any, get_favorites: any}
@returns(200)

@endgroup

@group gethomecoachsdata
@endpoint GET /gethomecoachsdata
@optional {device_id: any}
@returns(200)

@endgroup

@group getthermstate
@endpoint GET /getthermstate
@required {device_id: any, module_id: any}
@returns(200)

@endgroup

@group syncschedule
@endpoint POST /syncschedule
@required {device_id: any, module_id: any, therm_program: any}
@returns(200)

@endgroup

@group setthermpoint
@endpoint POST /setthermpoint
@required {device_id: any, module_id: any, setpoint_mode: any}
@optional {setpoint_endtime: any, setpoint_temp: any}
@returns(200)

@endgroup

@group switchschedule
@endpoint POST /switchschedule
@required {device_id: any, module_id: any, schedule_id: any}
@returns(200)

@endgroup

@group createnewschedule
@endpoint POST /createnewschedule
@required {device_id: any, module_id: any, therm_program: any}
@returns(200)

@endgroup

@group partnerdevices
@endpoint GET /partnerdevices
@returns(200)

@endgroup

@group gethomedata
@endpoint GET /gethomedata
@optional {home_id: any, size: any}
@returns(200)

@endgroup

@group getcamerapicture
@endpoint GET /getcamerapicture
@required {image_id: any, key: any}
@returns(200)

@endgroup

@group geteventsuntil
@endpoint GET /geteventsuntil
@required {home_id: any, event_id: any}
@returns(200)

@endgroup

@group getlasteventof
@endpoint GET /getlasteventof
@required {home_id: any, person_id: any}
@optional {offset: any}
@returns(200)

@endgroup

@group getnextevents
@endpoint GET /getnextevents
@required {home_id: any, event_id: any}
@optional {size: any}
@returns(200)

@endgroup

@group setpersonsaway
@endpoint POST /setpersonsaway
@required {home_id: any}
@optional {person_id: any}
@returns(200)

@endgroup

@group setpersonshome
@endpoint POST /setpersonshome
@required {home_id: any, person_ids: any}
@returns(200)

@endgroup

@group addwebhook
@endpoint GET /addwebhook
@required {url: any, app_type: any}
@returns(200)

@endgroup

@group dropwebhook
@endpoint GET /dropwebhook
@required {app_type: any}
@returns(200)

@endgroup

@end