This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
api [2019/02/10 16:24] 127.0.0.1 external edit |
api [2023/09/15 11:44] kd6kpc [Use Authorization] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | [[https:// | + | |
- | ===== Application Import | + | |
- | Users can select a number of parameters from the Repeaterbook search from within the application: | + | ===== Overview ===== |
- | * State or Province | ||
- | * Frequency bands | ||
- | * Location | ||
- | * Radius | ||
+ | The RepeaterBook API allows developers access to repeater data. The API is based upon [[https:// | ||
- | If the user does not enter a location, the import will include all repeaters for the selected band(s). If the user does not select any bands, the import will include all repeaters for the selected location. If the location in blank, then the user will receive | + | The API is located at https://www.repeaterbook.com/ |
- | ===== ROW Import | + | ===== Use Authorization |
- | With Repeaterbook' | + | |
- | RT Systems provides | + | Use of the data is for personal use only. The data cannot be fed to a commercial product for sale or otherwise. The use of the data may not compete with the RepeaterBook web or mobile application products. The data cannot be incorporated into an app or website with distribution beyond immediate personal use without the expressed written consent of RepeaterBook.com. |
- | * Latitude | + | |
- | * Longitude | + | |
- | * Radius | + | |
- | * Radius unit | + | |
- | * Band(s) | + | |
- | Repeaterbook then searches | + | ===== Scope ===== |
+ | All of the content, documentation, | ||
- | ===== Web Export | + | ===== Use ===== |
- | Repeaterbook.com offers | + | You may use any RepeaterBook API to develop |
- | Search types where you can find the export include: | + | ===== Attrubtion ===== |
+ | All services that utilize or access | ||
+ | ===== Pricing ===== | ||
- | * North American Single State Search | + | 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. |
- | * North American Multi-State Search | + | |
- | * North American/ | + | |
- | * North American/ | + | |
- | * North American/ | + | |
- | * Custom Radio Memories | + | |
- | * United States County Search | + | |
- | * Worldwide Search by Country | + | |
- | ==== API Details ==== | + | |
- | ^Column ^ Details ^Values ^ | + | |
- | |Channel Number |The memory number |Auto-incremented | | + | |
- | |Receive Frequency |The repeater downlink frequency | | | + | |
- | |Transmit Frequency |The repeater uplinkm frequency | | | + | |
- | |Offset Direction |Split direction |-, +, s, x | | + | |
- | |Name |Name the channel |Repeater Callsign | | + | |
- | |Tone Mode |Signaling method |None, Tone, T SQL, DCS, D Code | | + | |
- | |CTCSS|Uplink signaling tone | | | + | |
- | |RX CTCSS |Downlink signaling tone | | | + | |
- | |DCS |Uplink signaling digital code | | | + | |
- | |RX DCS |Downlink digital signaling code | | | + | |
- | |Comment| |Repeater nearest city and landmark | | + | |
+ | All public-facing apps must provide credit back to RepeaterBook for the data. | ||
+ | ===== 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 ===== | ||
+ | |||
+ | * State ID (FIPS) | ||
+ | * Repeater ID | ||
+ | * Frequency | ||
+ | * Input Frequency | ||
+ | * PL/CTCSS Uplink | ||
+ | * PL/CTCSS TSQ Downlink | ||
+ | * Location/ | ||
+ | * Landmark | ||
+ | * County (US only) | ||
+ | * State | ||
+ | * Callsign | ||
+ | * Use/ | ||
+ | * Operational Status | ||
+ | * ARES | ||
+ | * RACES | ||
+ | * SKYWARN | ||
+ | * CANWARN | ||
+ | * 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 | ||
+ | |||
+ | All repeaters are identified by a combination of the state ID and the repeater ID. The state ID is based on [[https:// | ||
+ | ===== api/ | ||
+ | |||
+ | * callsign - Repeater callsign | ||
+ | * city - Repeater city | ||
+ | * landmark | ||
+ | * state - State / Province | ||
+ | * country - Repeater country | ||
+ | * county - Repeater county | ||
+ | * frequency - Repeater frequency | ||
+ | * mode - Repeater operating mode (analog, DMR, NXDN, P25, tetra) | ||
+ | * emcomm - ARES, RACES, SKYWARN, CANWARN | ||
+ | * stype - Service type. Only required when searching for GMRS repeaters. ex: stype=gmrs | ||
+ | |||
+ | |||
+ | ===== Output Format Parameter ===== | ||
+ | |||
+ | The format is json - JavaScript Object Notation. | ||
+ | |||
+ | ===== Wildcards ===== | ||
+ | |||
+ | * % - will allow wild card searching | ||
+ | |||
+ | examples | ||
+ | * callsign=kd6% - All callsigns beginning with ' | ||
+ | * callsign=%kpc - All callsigns ending with ' | ||
+ | * callsign=kd%kpc - All callsigns beginning with ' | ||
+ | * callsign=%kp% - All callsigns with ' | ||
+ | |||
+ | |||
+ | |||
+ | ===== 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 | ||
+ | * callsign=kd6% - All callsigns beginning with ' | ||
+ | * callsign=%kpc - All callsigns ending with ' | ||
+ | * callsign=kd%kpc - All callsigns beginning with ' | ||
+ | * callsign=%kp% - All callsigns with ' | ||
+ | |||
+ | |||
+ | ===== Sample usages ===== | ||
+ | |||
+ | **HTTPS example - Switzerland** | ||
+ | |||
+ | https:// | ||
+ | |||
+ | ===== Limitations and Exclusions ===== | ||
+ | |||
+ | * ATV repeaters are not included | ||
+ | |||
+ | ===== 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 |