diff --git a/README.md b/README.md index c90dc9f..00e04e2 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,8 @@ Various approaches exist to writing your own client, but in general: * Refer to the API docs. These are built on an OpenAPI definition file (`/webassets/apidocs/openapi.yml`), which you can automatically use to generate a client skeleton using various software. -* Call the main "spots" or "alerts" API endpoints to get the data you want. Apply filters if necessary. +* Call the main "spots" or "alerts" API endpoints to get the data you want. For example, your app could call + `https://spothole.app/api/v1/spots` once every few minutes. Apply filters if necessary. * Call the "options" API to get an idea of which bands, modes etc. the server knows about. You might want to do that first before calling the spots/alerts APIs, to allow you to populate your filters correctly. * Refer to the provided HTML/JS interface for a reference on different approaches. For example, the "map" and "bands" @@ -97,6 +98,18 @@ Various approaches exist to writing your own client, but in general: Server-Sent Events (SSE) endpoint to update live. * Let me know if you get stuck, I'm happy to help. +Please don't hammer the API with an unnecessarily high request rate. For example, Spothole only queries the POTA API +once every two minutes, so if your client is interested in POTA data there's no need to poll Spothole any more often +than that. + +If you absolutely must be informed within seconds of a spot arriving in Spothole, please use the SSE endpoints instead, +e.g. `https://spothole.app/api/v1/spots/stream`. + +If you want to handle different types of spot or alert differently within your client, please consider making a single +request to the Spothole API to retrieve all the data, then filtering on your side. For example, call +`https://spothole.app/api/v1/spots?sig=POTA,SOTA` rather than making two separate calls to +`https://spothole.app/api/v1/spots?sig=POTA` and `https://spothole.app/api/v1/spots?sig=SOTA`. + Remember, here at Spothole Inc. we offer an industry-standard "five nines" uptime on our server, with our own unique twist: we don't tell you which side of the decimal point the nines start! (Translation: This is a hobby project. `spothole.app` runs on the same server as my blog and other stuff. It might go down without warning. By all means base diff --git a/templates/add_spot.html b/templates/add_spot.html index c14f8cf..fcb059f 100644 --- a/templates/add_spot.html +++ b/templates/add_spot.html @@ -76,7 +76,7 @@ - + diff --git a/templates/alerts.html b/templates/alerts.html index e222204..a31f345 100644 --- a/templates/alerts.html +++ b/templates/alerts.html @@ -75,7 +75,7 @@ - + diff --git a/templates/bands.html b/templates/bands.html index 7630b85..a58a3de 100644 --- a/templates/bands.html +++ b/templates/bands.html @@ -77,8 +77,8 @@ - - + + diff --git a/templates/base.html b/templates/base.html index b907e39..829c7a7 100644 --- a/templates/base.html +++ b/templates/base.html @@ -1,6 +1,6 @@ {% extends "skeleton.html" %} {% block head_extra %} - + @@ -10,10 +10,10 @@ - - - - + + + + {% end %} {% block body %}
diff --git a/templates/conditions.html b/templates/conditions.html index 90cfdae..0edd4dd 100644 --- a/templates/conditions.html +++ b/templates/conditions.html @@ -284,7 +284,7 @@
- + diff --git a/templates/map.html b/templates/map.html index a8ab33c..16cc546 100644 --- a/templates/map.html +++ b/templates/map.html @@ -95,8 +95,8 @@ - - + + diff --git a/templates/spots.html b/templates/spots.html index d2b5628..96ecffc 100644 --- a/templates/spots.html +++ b/templates/spots.html @@ -116,8 +116,8 @@ - - + + diff --git a/templates/status.html b/templates/status.html index b1e3f0d..3fee150 100644 --- a/templates/status.html +++ b/templates/status.html @@ -59,7 +59,7 @@ - +