This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
api [2019/11/29 12:20] kd6kpc [Limitations and Exclusions] |
api [2023/04/02 17:57] kd6kpc [Overview] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== API Information | + | ====== API ====== |
- | Repeaterbook.com has an API for querying data. All endpoints are available without authentication and support are listed query string parameters, format parameters, and wildcard operators. | + | ===== Overview ===== |
- | This API is currently | + | |
+ | The RepeaterBook API allows developers access to repeater data. The API is based upon [[https:// | ||
+ | |||
+ | The API is located at https:// | ||
+ | |||
+ | ===== Use Authorization ===== | ||
+ | |||
+ | Use of the data is for personal use only. The data cannot be fed to a commercial product | ||
+ | |||
+ | |||
+ | ===== Pricing ===== | ||
+ | |||
+ | All the information presented via the API is intended to be open data and free to use for any purpose. As a public service of RepeaterBook.com, we do not charge any fees for the usage of this service. However, there are reasonable rate limits to prevent abuse and help ensure everyone has access. The rate limit is not public information but allows a generous amount for typical use. If the rate limit is exceeded, a request will return with an error and may be retried after the limit clears (typically within 5 minutes). Proxies are more likely to reach the limit, whereas requests directly from clients are not likely. | ||
+ | |||
+ | All public-facing apps must provide credit back to RepeaterBook | ||
+ | |||
+ | ===== Content Negotiation ===== | ||
+ | |||
+ | Every request, either by browser or application, | ||
+ | |||
+ | ===== Authentication ===== | ||
+ | |||
+ | A User Agent is required to identify your application. This string can be anything, and the more unique to your application, | ||
+ | |||
+ | **User-Agent: | ||
+ | |||
+ | ===== Format ===== | ||
+ | |||
+ | Endpoints have the JSON default format. | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ===== North America ===== | ||
===== Available Data ===== | ===== Available Data ===== | ||
Line 17: | Line 50: | ||
* County (US only) | * County (US only) | ||
* State | * State | ||
- | * Country | ||
* Callsign | * Callsign | ||
* Use/ | * Use/ | ||
Line 37: | Line 69: | ||
* P-25 Capable | * P-25 Capable | ||
* P-25 NAC | * P-25 NAC | ||
+ | * M17 | ||
+ | * M17 CAN | ||
* Tetra Capable | * Tetra Capable | ||
* Tetra MCC | * Tetra MCC | ||
Line 42: | Line 76: | ||
* Yaesu System Fusion Capable | * Yaesu System Fusion Capable | ||
* YSF Digital ID Uplink | * YSF Digital ID Uplink | ||
- | * YSF Digial | + | * YSF Digital |
* YSF DSC | * YSF DSC | ||
* Analog Capable | * Analog Capable | ||
+ | * Notes | ||
* Last Update | * Last Update | ||
- | * Trustee | ||
- | On Repeaterbook.com, | + | All repeaters are identified by a combination of the state ID and the repeater ID. The state ID is based on [[https:// |
===== api/ | ===== api/ | ||
Line 55: | Line 89: | ||
* landmark | * landmark | ||
* state - State / Province | * state - State / Province | ||
- | * country - Repeater country | + | * country - Repeater country |
* county - Repeater county | * county - Repeater county | ||
* frequency - Repeater frequency | * frequency - Repeater frequency | ||
* mode - Repeater operating mode (analog, DMR, NXDN, P25, tetra) | * mode - Repeater operating mode (analog, DMR, NXDN, P25, tetra) | ||
* emcomm - ARES, RACES, SKYWARN, CANWARN | * emcomm - ARES, RACES, SKYWARN, CANWARN | ||
+ | * stype - Service type. Only required when searching for GMRS repeaters. ex: stype=gmrs | ||
===== Output Format Parameter ===== | ===== Output Format Parameter ===== | ||
- | The format is json - Java Script | + | The format is json - JavaScript |
===== Wildcards ===== | ===== Wildcards ===== | ||
Line 76: | Line 111: | ||
* callsign=%kp% - All callsigns with ' | * callsign=%kp% - All callsigns with ' | ||
- | ===== Multi-Select with parameters ===== | ||
- | THIS IS FUTURE DEVELOPMENT AND IS CURRENTLY NOT AVAILABLE | + | |
+ | ===== Sample Usage ===== | ||
+ | |||
+ | **HTTPS example - US and Canada** | ||
+ | |||
+ | https:// | ||
+ | |||
+ | ===== Limitations and Exclusions ===== | ||
+ | |||
+ | * ATV repeaters are not included | ||
+ | |||
+ | ===== Outside of North America ===== | ||
+ | |||
+ | ===== Available Data ===== | ||
+ | |||
+ | * State ID (FIPS) | ||
+ | * Repeater ID | ||
+ | * Frequency | ||
+ | * Input Frequency | ||
+ | * PL/CTCSS Uplink | ||
+ | * PL/CTCSS TSQ Downlink | ||
+ | * Location/ | ||
+ | * Landmark | ||
+ | * Region (if available) | ||
+ | * Country | ||
+ | * Callsign | ||
+ | * Use/ | ||
+ | * Operational Status | ||
+ | * Operating Mode | ||
+ | * AllStar Node | ||
+ | * EchoLink Node | ||
+ | * IRLP Node | ||
+ | * WIRES Node | ||
+ | * DMR Capable | ||
+ | * DMR ID | ||
+ | * DMR Color Code | ||
+ | * D-Star Capable | ||
+ | * NXDN Capable | ||
+ | * P-25 Capable | ||
+ | * P-25 NAC | ||
+ | * M17 | ||
+ | * M17 CAN | ||
+ | * Tetra Capable | ||
+ | * Tetra MCC | ||
+ | * Tetra MNC | ||
+ | * Yaesu System Fusion Capable | ||
+ | * YSF Digital ID Uplink | ||
+ | * YSF Digital ID Downlink | ||
+ | * YSF DSC | ||
+ | * Analog Capable | ||
+ | * Notes | ||
+ | * Last Update | ||
+ | |||
+ | On Repeaterbook.com, | ||
+ | ===== api/ | ||
+ | |||
+ | * callsign - Repeater callsign | ||
+ | * city - Repeater city | ||
+ | * landmark | ||
+ | * country - Repeater country | ||
+ | * region- Repeater region (if available) | ||
+ | * frequency - Repeater frequency | ||
+ | * mode - Repeater operating mode (analog, DMR, NXDN, P25, tetra) | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ===== Wildcards ===== | ||
+ | |||
+ | * % - will allow wild card searching | ||
examples | examples | ||
- | * country[]=Canada& | + | * callsign=kd6% - All callsigns beginning with ' |
- | * state=Maine& | + | * callsign=%kpc - All callsigns ending with ' |
+ | * callsign=kd%kpc | ||
+ | * callsign=%kp% - All callsigns with ' | ||
- | Note that brackets are added to the end of the duplicate variables. | ||
===== Sample usages ===== | ===== Sample usages ===== | ||
- | **HTTPS example - US and Canada** | + | **HTTPS example - Switzerland** |
- | https:// | + | https:// |
===== Limitations and Exclusions ===== | ===== Limitations and Exclusions ===== | ||
* ATV repeaters are not included | * ATV repeaters are not included | ||
- | * Due to server constraints, | + | |
+ | ===== Rate Limiting ===== | ||
+ | |||
+ | Various actions of the API can be rate limited. The actual limits are not published. However, if a human user using a browser is querying the API, there should not be any throttling issues. If you receive a rate-limiting message, wait at least 10 seconds and up to 60 seconds to reset the limiter. | ||
+ | |||
+ | The API is not intended for use by non-human-initiated (automated) transactions. If you have a business requirement that requires exceptions to the rate limits, please get in touch with the RepeaterBook administrator for pricing options. | ||
+ | |||
+ | ===== Requested Improvements ===== | ||
+ | |||
+ | * Add an array of linked repeaters |