User Tools

Site Tools


api

API

Overview

The RepeaterBook API allows developers access to repeater data. The API is based upon JSON to promote machine data discovery.

The API is located at https://www.repeaterbook.com/api

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 public-facing apps must provide credit back to RepeaterBook for the data.

Content Negotiation

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 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.

User-Agent: (myweatherapp.com, [email protected])

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/Nearest City
  • Landmark
  • County (US only)
  • State
  • 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

All repeaters are identified by a combination of the state ID and the repeater ID. The state ID is based on American National Standards Institute (ANSI) Codes for States

api/export.php

  • 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

Output Format Parameter

The format is json - Java Script Object Notation

Wildcards

  • % - 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

Sample Usage

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
  • 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

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

  • 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

Sample usages

Limitations and Exclusions

  • ATV repeaters are not included
api.txt · Last modified: 2022/05/26 13:44 by kd6kpc