HazardHub:Request: Difference between revisions
Jump to navigation
Jump to search
Created page with "{{HazardHubNav |InputOutputCollapse= }} {{CustomTOC}} ==Profile (/me)== The Profile service is used to retrieve info about your profile. ===Example Call=== <pre> curl -H "A..." |
No edit summary |
||
| Line 71: | Line 71: | ||
<pre> | <pre> | ||
curl -H "Authorization: Token token=TOKEN" "http://api.hazardhub.com/v1/property?address=1820+South+Ocean+Boulevard&city=Palm+Beach&state=FL&zip=33480" -v | curl -H "Authorization: Token token=TOKEN" "http://api.hazardhub.com/v1/property?address=1820+South+Ocean+Boulevard&city=Palm+Beach&state=FL&zip=33480" -v | ||
</pre> | |||
{|class="alternate01" cellspacing="0" | |||
!Requested Field | |||
!Input | |||
!style="border-right:0px;"|Description | |||
|- | |||
|lat | |||
|Number(Double) | |||
|Latitude of the point. | |||
|- | |||
|lng | |||
|Number(Double) | |||
|Longitude of the point. | |||
|- | |||
|address | |||
|String | |||
|Address string | |||
|- | |||
|city | |||
|String | |||
|City | |||
|- | |||
|state | |||
|String | |||
|State/Province | |||
|- | |||
|zip | |||
|String | |||
|ZIP/Postal Code | |||
|} | |||
==Risks and Property== | |||
The Risks and Property service is used to retrieve information about risks and property in one request. | |||
===Example Call=== | |||
<pre> | |||
curl -H "Authorization: Token token=TOKEN" "http://api.hazardhub.com/v1/risks_and_property?lat=26.653622&lng=-80.0367709" -v | |||
</pre> | |||
<pre> | |||
curl -H "Authorization: Token token=TOKEN" "http://api.hazardhub.com/v1/risks_and_property?address=1820+South+Ocean+Boulevard&city=Palm+Beach&state=FL&zip=33480" -v | |||
</pre> | </pre> | ||
Latest revision as of 20:34, 17 October 2017
| HazardHub Navigation | |||
|---|---|---|---|
| |||
| |||
|
Profile (/me)
The Profile service is used to retrieve info about your profile.
Example Call
curl -H "Authorization: Token token=TOKEN" "http://api.hazardhub.com/v1/me" -v
| Added Header | Input | Description |
|---|---|---|
| Authorization | User Token | The user token. |
Schema
Authorization: Token token=- The authorization header must contain your token to use the API.
Risks
The Risks service is used to retrieve risk score cards by specifying the geo point.
If you use "address" then the "lat" and "lng" fields are not required. Alternatively, if you use the "lat" and "lng" fields then "address" is not required.
Example Call
curl -H "Authorization: Token token=TOKEN" "http://api.hazardhub.com/v1/risks?lat=37.757815&lng=-122.5076403" -v
curl -H "Authorization: Token token=TOKEN" "http://api.hazardhub.com/v1/risks?address=135+Swifts+Beach+Road%2C+Wareham%2C+MA%2C+USA" -v
| Requested Field | Input | Description |
|---|---|---|
| lat | Number(Double) | Latitude of the point. |
| lng | Number(Double) | Longitude of the point. |
| address | String | Target place or address. |
Property
The Property service is used to retrieve information about property.
Example Call
curl -H "Authorization: Token token=TOKEN" "http://api.hazardhub.com/v1/property?lat=26.653622&lng=-80.0367709" -v
curl -H "Authorization: Token token=TOKEN" "http://api.hazardhub.com/v1/property?address=1820+South+Ocean+Boulevard&city=Palm+Beach&state=FL&zip=33480" -v
| Requested Field | Input | Description |
|---|---|---|
| lat | Number(Double) | Latitude of the point. |
| lng | Number(Double) | Longitude of the point. |
| address | String | Address string |
| city | String | City |
| state | String | State/Province |
| zip | String | ZIP/Postal Code |
Risks and Property
The Risks and Property service is used to retrieve information about risks and property in one request.
Example Call
curl -H "Authorization: Token token=TOKEN" "http://api.hazardhub.com/v1/risks_and_property?lat=26.653622&lng=-80.0367709" -v
curl -H "Authorization: Token token=TOKEN" "http://api.hazardhub.com/v1/risks_and_property?address=1820+South+Ocean+Boulevard&city=Palm+Beach&state=FL&zip=33480" -v
| Requested Field | Input | Description |
|---|---|---|
| lat | Number(Double) | Latitude of the point. |
| lng | Number(Double) | Longitude of the point. |
| address | String | Address string |
| city | String | City |
| state | String | State/Province |
| zip | String | ZIP/Postal Code |