Beach Hui API Documentation
Build amazing applications with real-time beach and reef data
Quick Start
1
Get Your API Key
Sign up for a Pro or Business account to get your API key
2
Make Your First Call
Use our RESTful endpoints to fetch beach data
3
Build Amazing Apps
Integrate beach data into your applications
Base URL
https://api.beachhui.com/v1API Endpoints
Beaches
Alerts
Reef Health
GET
/api/v1/beachesList all beaches
Example Request
// Get beach conditions
fetch('https://api.beachhui.com/v1/beaches/waikiki/conditions', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
})
.then(response => response.json())
.then(data => console.log(data));Example Response
{
"beach": {
"id": "waikiki",
"name": "Waikiki Beach",
"location": {
"lat": 21.2765,
"lng": -157.8255
}
},
"conditions": {
"waveHeight": 2.5,
"wavePeriod": 8,
"waterTemp": 78,
"visibility": 25,
"uvIndex": 8,
"windSpeed": 12,
"windDirection": "ENE"
},
"safety": {
"overall": "good",
"flags": ["green"],
"hazards": [],
"lifeguards": true
},
"timestamp": "2024-01-15T10:30:00Z"
}Rate Limits
Free Plan
10
requests per day
Pro Plan
100
requests per day
Business Plan
Unlimited
no limits
Authentication
The Beach Hui API uses API keys to authenticate requests. You can get your API key from your dashboard after signing up for a Pro or Business account.
Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEYSecurity Note: Keep your API key secure and never expose it in client-side code or public repositories.
Official SDKs
Need Help?
Our developer support team is here to help you integrate Beach Hui API