RepeaterBook Wiki

User Tools

Site Tools

Trace:
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
Last revision Both sides next revision
api [2019/11/29 12:11]
kd6kpc [Available Data] 		api [2023/09/15 11:44]
kd6kpc [Use Authorization]
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 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]].+ 
 +The RepeaterBook API allows developers access to repeater data. The API is based upon [[https://www.json.org/json-en.html|JSON]] to promote machine data discovery. 
 + 
 +The API is located at https://www.repeaterbook.com/api. Please so not try to go to this link without the parameters set below, you will receive an error. 
 + 
 +===== Use Authorization ===== 
 + 
 +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. 
 + 
 +===== Scope ===== 
 +All of the content, documentation, code, and related materials made available to you through the API are subject to these terms. Access to or use of the API or its content constitutes acceptance of this Agreement. 
 + 
 +===== Use ===== 
 +You may use any RepeaterBook API to develop a service or service to search, display, analyze, retrieve, view, and otherwise 'get' information from FCC data. 
 + 
 +===== Attrubtion ===== 
 +All services that utilize or access the API should display the following notice prominently within the application: "This product uses RepeaterBook Data API but is not endorsed or certified by RepeaterBook". You may use the RepeaterBook name or logos to identify the source of API content subject to these rules. You may not use the RepeaterBook name, logo, or the like to imply endorsement of any product, service, or entity, not-for-profit, commercial, or otherwise. 
 +===== 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 for the data. 
 + 
 +===== Content Negotiation ===== 
 + 
 +Every request, either by browser or application, sends header information whenever you visit any website. For example, a commonly used header called "UserAgent" tells a website what type of device you are using so it can tailor the best experience for you. No private information is shared in a header, which is standard practice for all sites. Developers can override these headers for specific purposes. You can get full details by visiting the header field definitions page at the [[https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html|World Wide Web]] Consortium site. 
 + 
 +===== Authentication ===== 
 + 
 +A User Agent is required to identify your application. This string can be anything, and the more unique to your application, the less likely it will be affected by a security event. If you include contact information (website or email), we can contact you if your string is associated with a security event. This will be replaced with an API key in the future. 
 + 
 +**User-Agent: (myweatherapp.com, [email protected])** 
 + 
 +===== Format ===== 
 + 
 +Endpoints have the JSON default format. 
 + 
 + 
 + 
 + 
 +===== North America =====
  
 ===== Available Data ===== ===== Available Data =====
Line 17: Line 57:
   * County (US only)   * County (US only)
   * State   * State
-  * Country 
   * Callsign   * Callsign
   * Use/Membership   * Use/Membership
Line 37: Line 76:
   * 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 83:
   * Yaesu System Fusion Capable   * Yaesu System Fusion Capable
   * YSF Digital ID Uplink   * YSF Digital ID Uplink
-  * YSF Digial ID Downlink +  * YSF Digital ID Downlink 
   * YSF DSC   * YSF DSC
   * Analog Capable   * Analog Capable
 +  * Notes
   * Last Update   * Last Update
-  * Trustee 
  
-On Repeaterbook.com, repeaters are identified by a combination of the state ID and the repeater ID.+All repeaters are identified by a combination of the state ID and the repeater ID. The state ID is based on [[https://www.nrcs.usda.gov/wps/portal/nrcs/detail/?cid=nrcs143_013696|American National Standards Institute (ANSI) Codes for States]]
 ===== api/export.php ===== ===== api/export.php =====
  
Line 55: Line 96:
   * landmark   * landmark
   * state - State / Province   * state - State / Province
-  * country - Repeater country (United States, Canada, Mexico)+  * 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 Object Notation+The format is json - JavaScript Object Notation.
  
 ===== Wildcards ===== ===== Wildcards =====
Line 76: Line 118:
   * callsign=%kp% - All callsigns with 'kp' in them   * callsign=%kp% - All callsigns with 'kp' in them
  
-===== Multi-Select with parameters ===== 
  
-THIS IS FUTURE DEVELOPMENT AND IS CURRENTLY NOT AVAILABLE+ 
 +===== Sample Usage ===== 
 + 
 +**HTTPS example - US and Canada** 
 + 
 +https://www.repeaterbook.com/api/export.php?country=United%20States&country=Canada 
 + 
 +===== 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/Nearest City 
 +  * Landmark 
 +  * Region (if available) 
 +  * Country 
 +  * Callsign 
 +  * Use/Membership 
 +  * 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, repeaters are identified by a combination of the state ID and the repeater ID. 
 +===== api/export.php ===== 
 + 
 +  * 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&country[]=United States - All records from Canada and the US +  * callsign=kd6% - All callsigns beginning with 'kd6' 
-  * state=Maine&state=New Hampshire - All records from Maine and New Hampshire+  * 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
  
-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://www.repeaterbook.com/api.php?country=United%20States&country=Canada+https://www.repeaterbook.com/api/exportROW.php?country=Switzerland
  
 ===== Limitations and Exclusions ===== ===== Limitations and Exclusions =====
  
   * ATV repeaters are not included   * 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
api.txt · Last modified: 2023/09/15 11:50 by kd6kpc

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: Public Domain
Public Domain Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki