Differences

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

--- api [2022/05/26 12:09] – [Sample usages] kd6kpc
+++ api [2025/01/24 22:30] (current) – [CHANGE LOG] KD6KPC
@@ Line 1: / Line 1: @@
 ====== API ======
+===== NEW INFORMATION =====
+**COMING SOON**: A key will be required for commercial access to the API. Please stay tuned for additional information. If you would like to be notified and obtain a key in advance, include your email address in the header of your API requests to our endpoint.
+All commercial API users will need to complete a form to request access. For-profit (commercial) entities must purchase access to the API, while non-commercial users can access it at no cost. All users must adhere to the conditions outlined below.
 ===== Overview =====
@@ Line 6: / Line 12: @@
 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]]
+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 =====
+  - **Personal Use Only:**
+      * The use of RepeaterBook data is strictly limited to **personal use**.
+      * **Prohibited:** Incorporating the data into any commercial product or service for sale, distribution, or any other purpose without prior written permission from RepeaterBook.com.
+  - **Non-Competition Clause:**
+      * RepeaterBook data and API must not be used in ways that directly or indirectly **compete** with RepeaterBook’s web or mobile applications.
+      * Applications or services that provide **similar functionality** or replicate RepeaterBook’s offerings are not allowed.
+  - **No Redistribution Without Permission:**
+      * The data may not be included in any app, website, or other medium that is distributed **beyond immediate personal use** without **explicit written consent** from RepeaterBook.com.
+  - **API Use Guidelines:**
+      * The RepeaterBook API must not be used to **duplicate the functionality, methods, or presentations** already provided by RepeaterBook.
+      * Unordered List ItemUse of the API should complement, not replace, the services offered by RepeaterBook.
+  - **Attribution Requirement:**
+      * Any application or website utilizing RepeaterBook data must:
+           * Clearly **acknowledge RepeaterBook** as the source of the data.
+           * Provide a **visible link** to RepeaterBook.com.
+  - **Mapping and Exporting Tools:**
+      * RepeaterBook provides **mapping** and **data exporting tools** for user convenience.
+      * Developing tools that replicate these features is not permitted without **prior written authorization.**
+===== Scope =====
+This Agreement governs all content, documentation, code, and related materials provided through the API. By accessing or using the API or any of its content, you acknowledge and accept the terms outlined in this Agreement.
+===== Use =====
+You are authorized to use the RepeaterBook API to develop services or applications that facilitate searching, displaying, analyzing, retrieving, viewing, or otherwise accessing information derived from FCC data.
+===== Modification or False Representation of Content =====
+You are prohibited from modifying or misrepresenting content obtained through the API while attributing it to RepeaterBook as the source.
+===== Right to Limit =====
+Your use of the API is subject to certain limitations on access, calls, or usage as outlined in this Agreement or as otherwise communicated by RepeaterBook. If RepeaterBook reasonably determines that you have attempted to exceed or circumvent these limits, your access to the API may be temporarily or permanently suspended. RepeaterBook reserves the right to monitor your API usage to enhance service quality and ensure compliance with this Agreement.
+While specific rate limits are not published, they are set to accommodate normal human interactions. Automated processes, particularly those designed to harvest large volumes of data, will be detected. In such cases, the site administrator will be notified, and access to RepeaterBook.com may be restricted or entirely disabled.
+When the rate limit is exceeded, the API will return a 429 Error: "Too Many Requests" response. It is the responsibility of the requesting program to cease further requests to the endpoint upon receiving this error. Failure to comply may result in the API endpoint being permanently disabled for the offending program.
+===== Service Termination =====
+You may terminate this Agreement at any time by ceasing all use of the API. RepeaterBook reserves the right, at its sole discretion, to (1) refuse API access if it determines that your use violates any RepeaterBook policy or (2) terminate or deny access to the API, in whole or in part, for any reason, at any time.
+Provisions of this Agreement that, by their nature, should survive termination will remain in effect, including but not limited to warranty disclaimers, indemnity obligations, and limitations of liability.
+===== Changes =====
+RepeaterBook reserves the right, at its sole discretion, to modify or replace this Agreement, in whole or in part. Your continued use or access to the API after any changes to this Agreement are posted constitutes your acceptance of the updated terms.
+In the future, RepeaterBook may offer new services and/or features through the API. Any new features or services will be subject to the terms and conditions of this Agreement.
+===== Disclaimer of Warranties =====
+The API is provided on an "as is" and "as available" basis. RepeaterBook disclaims all warranties, whether express or implied, including, but not limited to, implied warranties of merchantability, fitness for a particular purpose, and non-infringement. RepeaterBook makes no guarantees that the API will be free from errors or that access will be continuous, uninterrupted, or secure.
+===== Limitations on Liability =====
+Under no circumstances shall RepeaterBook be liable, whether under contract, negligence, strict liability, or any other legal or equitable theory, for:
+  - **Special, incidental, or consequential damages**;
+  - **Costs related to the procurement of substitute products or services**; or
+  - **Interruptions in use, loss of data, or corruption of data**.
+===== General Representations =====
+By using the API, you represent and warrant that:
+  - Your use of the API will fully comply with the RepeaterBook Privacy Policy, this Agreement, and all applicable laws and regulations.
+  - Your use of the API will not infringe upon or misappropriate the intellectual property rights of any third party.
+===== Indemnification =====
+You agree to indemnify and hold harmless RepeaterBook, its contractors, employees, agents, and affiliates from any and all claims, liabilities, damages, and expenses (including reasonable attorney's fees) arising out of your use of the API, including but not limited to any violation of this Agreement.
+===== Miscellaneous =====
+This Agreement constitutes the entire understanding between you and RepeaterBook regarding its subject matter. Any modifications to this Agreement may only be made by RepeaterBook through the posting of a revised version on this page.
+===== No Waiver of rights =====
+RepeaterBook's failure to exercise or enforce any right or provision of this Agreement shall not constitute waiver of such right or provision.
 ===== Pricing =====
-All of 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 in place to prevent abuse and help ensure that 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 information provided through the API is intended to be open data and is free to use for personal, non-commercial purposes. As a public service from RepeaterBook.com, no fees are charged for accessing this API for typical, non-commercial use. However, RepeaterBook reserves the right to charge a fee for commercial use of the API or its data. Any such usage must be explicitly authorized, and terms will be outlined in a separate agreement.
-===== Conent Negotiation =====
+Reasonable rate limits are in place to prevent abuse and ensure equitable access for all users. While the exact rate limits are not disclosed, they are designed to accommodate typical usage generously. If the rate limit is exceeded, the API will return an error response, and requests may be retried once the limit resets, typically within 5 minutes. Proxies are more likely to reach the limit, whereas direct client requests are less likely to be affected.
-Every request, either by browser or application, sends header information any time 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, and this 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.
+All public-facing applications using this API must clearly credit RepeaterBook as the source of 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 to a security event. This will be replaced with an API key in the future.
+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: (Name or URL of your app, valid@myemail.com)**
-**User-Agent: (myweatherapp.com, contact@myweatherapp.com)**
+Replace the data with your valid data.
+<color #ed1c24>Note: API tokens will be required for continued commercial usage on January 6, 2025.</color>
 ===== Format =====
@@ Line 63: / Line 148: @@
   * P-25 Capable
   * P-25 NAC
+  * M17
+  * M17 CAN
   * Tetra Capable
   * Tetra MCC
@@ Line 68: / Line 155: @@
   * Yaesu System Fusion Capable
   * YSF Digital ID Uplink
-  * YSF Digial ID Downlink
+  * YSF Digital ID Downlink
   * YSF DSC
   * Analog Capable
+  * Notes
   * Last Update
-  * Trustee
 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]]
@@ Line 80: / Line 167: @@
   * city - Repeater city
   * landmark
-  * state - State / Province
+  * state_id - State / Province
   * country - Repeater country
   * county - Repeater county
@@ Line 86: / Line 173: @@
   * 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 - Java Script Object Notation
+The format is json - JavaScript Object Notation.
 ===== Wildcards =====
@@ Line 104: / Line 192: @@
-===== Examples =====
+===== Sample Usage =====
 **HTTPS example - US and Canada**
@@ Line 143: / Line 231: @@
   * P-25 Capable
   * P-25 NAC
+  * M17
+  * M17 CAN
   * Tetra Capable
   * Tetra MCC
@@ Line 148: / Line 238: @@
   * Yaesu System Fusion Capable
   * YSF Digital ID Uplink
-  * YSF Digial ID Downlink
+  * YSF Digital ID Downlink
   * YSF DSC
   * Analog Capable
+  * Notes
   * Last Update
-  * Trustee
 On Repeaterbook.com, repeaters are identified by a combination of the state ID and the repeater ID.
@@ Line 166: / Line 256: @@
-===== Output Format Parameter =====
-The format is json - Java Script Object Notation
 ===== Wildcards =====
@@ Line 190: / Line 278: @@
   * 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
+===== CHANGE LOG =====
+/24/2025: Clarified token requirement is for commercial use of the API
+/24/2025: Updated the query term for api/export.php is 'state_id'. It was 'state'. The variable must be the state FIPS code.