User Tools

Site Tools


api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
api [2019/11/28 09:59]
KD6KPC
api [2019/12/06 11:16]
KD6KPC [API Information]
Line 1: Line 1:
-====== RT Systems ====== +====== API Information ======
-[[https://www.rtsystemsinc.com/|RT Systems]] +
-===== Application Import =====+
  
-Users can select a number of parameters from the Repeaterbook search from within the application:+Repeaterbook.com has an API for querying data. All endpoints are available without authentication and support the listed query string parameters, format parameters, and wildcard operators.
  
-  * State or Province +This API is currently only available for repeaters in North America (United States, Canada, and Mexico). If you are interested in an API for other parts of the world, please [[https://www.repeaterbook.com/index.php/admin-contact|Contact Me]].
-  * Frequency bands +
-  * Location +
-  * Radius+
  
 +===== Available Data =====
  
-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 is blank, then the user will receive all of the repeaters for the entire state/province.+  * State ID (FIPS) 
 +  * Repeater ID 
 +  * Frequency 
 +  * Input Frequency 
 +  * PL/CTCSS Uplink 
 +  * PL/CTCSS TSQ Downlink 
 +  * Location/Nearest City 
 +  * Landmark 
 +  * County (US only) 
 +  * State 
 +  * Country 
 +  * Callsign 
 +  * Use/Membership 
 +  * 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 
 +  * Tetra Capable 
 +  * Tetra MCC 
 +  * Tetra MNC 
 +  * Yaesu System Fusion Capable 
 +  * YSF Digital ID Uplink 
 +  * YSF Digial ID Downlink  
 +  * YSF DSC 
 +  * Analog Capable 
 +  * Last Update 
 +  * Trustee
  
-===== ROW Import ===== +On Repeaterbook.com, repeaters are identified by a combination of the state ID and the repeater ID. 
-With Repeaterbook's expansion to cover repeaters from around the world, Repeaterbook is changing the API to allow users to enter their location, anywhere around the world, and receive an export.+===== api/export.php =====
  
-RT Systems provides the following: +  * callsign - Repeater callsign 
-  * Latitude +  * city - Repeater city 
-  * Longitude +  * landmark 
-  * Radius +  * state - State / Province 
-  * Radius unit +  * country - Repeater country (United States, Canada, Mexico) 
-  * Band(s)+  * county - Repeater county 
 +  * frequency - Repeater frequency 
 +  * mode - Repeater operating mode (analog, DMR, NXDN, P25, tetra) 
 +  * emcomm - ARES, RACES, SKYWARN, CANWARN
  
-Repeaterbook then searches the North American database and the Rest of World database for any matching repeaters and imports them to the app. 
  
-===== Web Export ===== +===== Output Format Parameter =====
-Repeaterbook.com offers a data export from many of its search pages. The data can be imported into the RT Systems application.+
  
-Search types where you can find the export include:+The format is json - Java Script Object Notation
  
-  * North American Single State Search +===== Wildcards =====
-  * North American Multi-State Search +
-  * North American/Worldwide Keyword Search +
-  * North American/Worldwide Travel Search +
-  * North American/Worldwide Proximity Search +
-  * 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 uplink 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 |+
  
 +  * % - will allow wild card searching
  
 +examples
 +  * callsign=kd6% - All callsigns beginning with 'kd6'
 +  * callsign=%kpc - All callsigns ending with 'kpc'
 +  * callsign=kd%kpc - All callsigns beginning with 'kd' and ending with 'kpc'
 +  * callsign=%kp% - All callsigns with 'kp' in them
 +
 +===== Multi-Select with parameters =====
 +
 +THIS IS FUTURE DEVELOPMENT AND IS CURRENTLY NOT AVAILABLE
 +
 +examples
 +  * country[]=Canada&country[]=United States - All records from Canada and the US
 +  * state=Maine&state=New Hampshire - All records from Maine and New Hampshire
 +
 +Note that brackets are added to the end of the duplicate variables.
 +
 +===== Sample usages =====
 +
 +**HTTPS example - US and Canada**
 +
 +https://www.repeaterbook.com/api.php?country=United%20States&country=Canada
 +
 +===== Limitations and Exclusions =====
 +
 +  * ATV repeaters are not included
 +  * Due to server constraints, queries are limited to 3,500 rows
api.txt · Last modified: 2023/09/15 11:50 by kd6kpc