Quick Start

Get up and running with the Bubbly Maps API in just a few steps!

1. Choose Your Authentication Method

2. Make Your First Request

Get All Waypoints

No authentication required! Start by fetching all water fountain locations:

curl https://bubblymaps.org/api/waypoints

Search for Waypoints

Find water fountains in a specific area:

curl "https://bubblymaps.org/api/waypoints/search?q=central+park"

3. Create a Waypoint

To add a new water fountain location, you'll need authentication:

curl -X POST https://bubblymaps.org/api/waypoints \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
    "name": "Community Park Fountain",
    "latitude": 40.7580,
    "longitude": -73.9855,
    "description": "Clean drinking water available 24/7",
    "region": "New York"
  }'

4. Add a Review

Help the community by reviewing waypoints:

curl -X POST https://bubblymaps.org/api/reviews \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
    "bubblerId": 42,
    "rating": 5,
    "comment": "Great fountain with cold, clean water!"
  }'

Next Steps

Common Use Cases

Building a Mobile App

1. Fetch all waypoints to display on a map
2. Use the search endpoint for location-based queries
3. Allow users to add reviews for waypoints they visit
4. Submit new waypoint locations with photos

Data Integration

1. Get platform statistics for analytics dashboards
2. Fetch waypoint data for integration with other services
3. Monitor changes through the waypoint logs
4. Use the meta endpoint for version compatibility checks

Community Contributions

1. Add new water fountain locations you discover
2. Update existing waypoints with better descriptions
3. Add photos to help others find fountains
4. Review fountains to help others know what to expect

Rate Limits

Currently, the API does not enforce strict rate limits, but please be respectful:

• Cache responses when possible
• Don't make excessive requests in short time periods
• Use appropriate search queries instead of fetching all data repeatedly

Support

Need help? Here are some resources:

• 📚 Full API Reference - Check the complete API documentation
• 🔐 Authentication Guide - Learn about API authentication
• 🐛 Report Issues - Found a bug? Open an issue
• 💬 Community - Join the discussion on GitHub

Example Projects

Want to see the API in action? Check out these examples:

• Web Application - bubblymaps.org - The official Bubbly Maps website
• GitHub Repository - bubblymaps/bubblymaps - Full source code