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 [2023/01/14 12:34] kd6kpc [Available Data] |
api [2023/09/15 11:44] kd6kpc [Use Authorization] |
||
---|---|---|---|
Line 6: | Line 6: | ||
The RepeaterBook API allows developers access to repeater data. The API is based upon [[https:// | The RepeaterBook API allows developers access to repeater data. The API is based upon [[https:// | ||
- | The API is located at [[https:// | + | The API is located at https:// |
+ | ===== 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, | ||
+ | |||
+ | ===== Use ===== | ||
+ | You may use any RepeaterBook API to develop a service or service to search, display, analyze, retrieve, view, and otherwise ' | ||
+ | |||
+ | ===== Attrubtion ===== | ||
+ | All services that utilize or access the API should display the following notice prominently within the application: | ||
===== Pricing ===== | ===== 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, | + | 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, |
All public-facing apps must provide credit back to RepeaterBook for the data. | All public-facing apps must provide credit back to RepeaterBook for the data. | ||
Line 17: | Line 28: | ||
===== Content Negotiation ===== | ===== Content Negotiation ===== | ||
- | Every request, either by browser or application, | + | Every request, either by browser or application, |
===== Authentication ===== | ===== Authentication ===== | ||
Line 77: | Line 88: | ||
* Notes | * Notes | ||
* Last Update | * 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:// | All repeaters are identified by a combination of the state ID and the repeater ID. The state ID is based on [[https:// | ||
Line 96: | Line 106: | ||
===== Output Format Parameter ===== | ===== Output Format Parameter ===== | ||
- | The format is json - Java Script | + | The format is json - JavaScript |
===== Wildcards ===== | ===== Wildcards ===== | ||
Line 199: | Line 209: | ||
===== Rate Limiting ===== | ===== 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 issues with throttling. If you receive a rate-limiting message, wait at least 10 seconds and up to 60 seconds to reset the limiter. | + | 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 |
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. | 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. |