w1cdn/spothole
1
0
Fork 0
mirror of https://git.ianrenton.com/ian/spothole.git synced 2026-09-24 16:24:32 +00:00
Code Issues 13 Packages Projects Releases Wiki Activity

Rationalise docs part 1 #151

Browse Source
This commit is contained in:
Ian Renton
2026-09-23 17:31:44 +01:00
parent 31c7c2095e
commit b45a6d8b78
11 changed files with 37 additions and 263 deletions
Download Patch File Download Diff File Expand all files Collapse all files
static/apidocs/openapi.yml
+9 -9
View File
@@ -3,16 +3,16 @@ openapi: 3.1.0
info:
title: Spothole API
description: |-
Spothole is a utility to aggregate "spots" from amateur radio DX clusters and xOTA spotting sites, and provide an open JSON API as well as a website to browse the data.
While there are other web-based interfaces to DX clusters, and sites that aggregate spots from various outdoor activity programmes for amateur radio, Spothole differentiates itself by supporting a large number of data sources, and by being "API first" rather than just providing a web front-end. This allows other software to be built on top of it. Spothole itself is also open source, Public Domain licenced code that anyone can take and modify.
The API calls described below allow third-party software to access data from Spothole, and receive data on spots and alerts in a consistent format regardless of the data sources used by Spothole itself. Utility calls are also provided for general data lookups.
Please note that the data coming out of Spothole is only as good as the data going in. People mis-hear and make typos when spotting callsigns all the time, and there are plenty of areas where Spothole's location data may be inaccurate. If you are doing something where accuracy is important, such as contesting, you should not rely on Spothole's data to fill in any gaps in your log.
Spothole's source code is located at https://git.ianrenton.com/ian/spothole and the README there provides setup instructions if you would like to run your own copy. A demonstration server of Spothole is located at https://spothole.app. The README also contains some examples of how you could query the API of the demonstration server to integrate the data into your own apps.
Spothole is a utility to aggregate "spots" from amateur radio DX clusters and xOTA spotting sites, and provide an open JSON API as well as a website to browse the data. This page is an OpenAPI specification which describes Spothole's API. Clients can use this API to retrieve all the spots, alerts, and other information known to Spothole.
You can find out more information about Spothole at https://spothole.app/help.
The API provided by https://spothole.app is provided free of charge, and no authentication is required. By using it, you accept the following:
* You wrote the client code yourself, OR, if you got an AI to write it for you, you promise to read and understand what it wrote before contacting me about any problems.
* You set a sensible refresh rate and will not try to take down the server by bombarding it with tons of requests.
* There is no uptime guarantee. This is a hobby project and sometimes I will accidentally break stuff.
* Trans rights are human rights.
## Changelog
### 2.2