Difference between revisions of "API"

Revision as of 16:23, 1 July 2023

RadioReference.com and Broadcastify provides a set of APIs for Webmasters and Application Developers to integrate data from radioreference.com and broadcastify into their own products. There are five different APIs currently available:

SOAP Based Web service for RadioReference Database Data
Broadcastify Audio Feed Catalog API
Broadcastify Feed Owner API
Javascript Remote Render Service for RadioReference Database Data
Broadcastify Calls Node Ingest API

The RadioReference Database Web Service

The RadioReference Database Web Service is an SOAP (Simple Object Application Protocol) XML based Web service which allows integration of applications and other Web services using RadioReference Database data. The API is completely free to use by developers, however and API key is required, and the end users must have an active premium subscription to access the data through the API.

Application developers can provide users complete access to RadioReference.com data through their own applications. From software applications to automatically program a user's scanner based on their location, to alternative display mechanisms of RadioReference data, the SOAP API provides all the methods needed to develop a robust and exciting set applications.

The Radioreference.com Database Web Service service is currently documented using the following WSDL:

http://api.radioreference.com/soap2/?wsdl&v=latest

Documentation and endpoint version information can be found here:

SOAP Web Service Documentation

A list of applications that support the Web service and further details can be found at:

RadioReference.com_Web_Service.

An API key is required to utilize the Web service. If you wish to apply for an API key to get started developing applications to use RadioReference data, please submit a support request to us at support@radioreference.com and we will work with you to get an API key issued.

Broadcastify Audio Feed Catalog API

The Broadcastify Audio Feed Catalog API provides XML and JSON based directory services for all live audio feeds on Broadcastify.

Documentation: Live Audio Feed Catalog API v 1.3 Documentation

NOTE: The broadcastify audio feed catalog API is only available to approved licensees. We are currently not issuing addtional licenses to mobile app developers at this time. If you are interested in developing an application or service that uses Broadcastify's live audio feeds, you will need access to this API, and we strongly encourage you to contact us directly at support@broadcastify.com with details on your plans to use the feed catalog API to integrate with your application.

Broadcastify Feed Owner API

Broadcastify Feed Owners have a freely available API to dynamically get statistics and status of their feeds.

Documentation: Feed Owner API Documentation

The RadioReference Javascript Remote Render Display Service

The RadioReference Javascript remote render service allows web designers and web page developers to integrate data from the radioreference.com database into their own Web pages for free.

Documentation: RR_Javascript_remote_render_service

Broadcastify Node Ingest API

Broadcastify Calls is a high capacity service that ingests radio system calls.

Broadcastify Calls is different from regular broadcastify feeds as the calls platform captures every single call on a conventional or trunked system, as individual call files, and makes those calls available in real time and in archives. The API is available for 3rd party SDR applications to upload calls to the Broadcastify Calls Platform.

Documentation: Broadcastify-Calls-API

@@ Line 1: / Line 1: @@
-The RadioReference.com Application Programming Interface provides a set of services for Webmasters and Application Developers to integrate data from radioreference.com into their own products.  There are two core components of the RadioReference.com API:
+RadioReference.com and Broadcastify provides a set of APIs for Webmasters and Application Developers to integrate data from radioreference.com and broadcastify into their own products.  There are five different APIs currently available:
-== The RadioReference Javascript Remote Render Display Service ==
+* SOAP Based Web service for RadioReference Database Data
+* Broadcastify Audio Feed Catalog API
+* Broadcastify Feed Owner API
+* Javascript Remote Render Service for RadioReference Database Data
+* Broadcastify Calls Node Ingest API
-The RadioReference Javascript remote render service allows webmaster and web page developers to integrate data from the radioreference.com database into their own Web pages.
+<br />
+== The RadioReference Database Web Service ==
-=== Steps for using the Javascript remote render service ===
+The RadioReference Database Web Service is an SOAP (Simple Object Application Protocol) XML based Web service which allows integration of applications and other Web services using RadioReference Database data.  The API is completely free to use by developers, however and API key is required, and the end users must have an active premium subscription to access the data through the API.
-.  Apply for a domainKey at the following page on your account settings page:
+Application developers can provide users complete access to RadioReference.com data through their own applications.  From software applications to automatically program a user's scanner based on their location, to alternative display mechanisms of RadioReference data, the SOAP API provides all the methods needed to develop a robust and exciting set applications.
-* http://www.radioreference.com/apps/account/?tab=api
+The Radioreference.com Database Web Service service is currently documented using the following WSDL:
-.  Wait for your domainKey to be approved by the administration staff.  You will receive an email to your email address on record when approved.
+* http://api.radioreference.com/soap2/?wsdl&v=latest
+<br />
+Documentation and endpoint version information can be found here:
-.  Add the necessary javascript code snippet and domainKey to your page for the data you want to remotely render.
+* [[RadioReference.com_Web_Service3.1|SOAP Web Service Documentation]]
+<br />
+A list of applications that support the Web service and further details can be found at:
-=== Data available for remote rendering ===
+[[RadioReference.com_Web_Service]].
-==== Frequency Subcategory ====
+An API key is required to utilize the Web service.  If you wish to apply for an API key to get started developing applications to use RadioReference data, '''please submit a support request to us at support@radioreference.com''' and we will work with you to get an API key issued.
-You can display a frequency subcategory on a Web page by adding the following code to the page:
+== Broadcastify Audio Feed Catalog API ==
-<pre>
-<nowiki>
-<script language="JavaScript" src="http://api.radioreference.com/js/?key=DOMAIN_KEY&scid=SUBCAT_ID">
-</script>
-</nowiki>
-</pre>
-[[Image:Scid_api_1.gif|250px|thumb|right|Subcategory Additional Details]]
+The Broadcastify Audio Feed Catalog API provides XML and JSON based directory services for all live audio feeds on Broadcastify.
-[[Image:Scid_api_2.gif|250px|thumb|right|Subcategory Unique ID (SUBCAT_ID)]]
-* DOMAIN_KEY = Your uniquely assigned and active domain key
+* Documentation:  [https://support.broadcastify.com/hc/en-us/articles/204740425-Live-Audio-Feed-Catalog-API-v-1-3-Documentation Live Audio Feed Catalog API v 1.3 Documentation]
-* SUBCAT_ID = The unique radioreference.com subcategory ID.  This can be found by clicking the subcategory additional details icon for a subcategory.
+<br />
+NOTE:  The broadcastify audio feed catalog API '''is only available to approved licensees'''.  We are currently not issuing addtional licenses to mobile app developers at this time.   If you are interested in developing an application or service that uses Broadcastify's live audio feeds, you will need access to this API, and we strongly encourage you to contact us directly at support@broadcastify.com with details on your plans to use the feed catalog API to integrate with your application.
-For example, to display the Comal County Fire SO frequency subcategory on a page, you would add the following code:
+== Broadcastify Feed Owner API ==
-<pre>
-<nowiki>
-<script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&scid=195">
-</script>
-</nowiki>
-</pre>
-The following would be displayed on the Web page where the code was inserted:
+Broadcastify Feed Owners have a freely available API to dynamically get statistics and status of their feeds.
-[[Image:Scid_api_result.gif|border|400px]]
+* Documentation:  [https://support.broadcastify.com/hc/en-us/articles/204172369-Feed-Owner-API-v0-9-Documentation Feed Owner API Documentation ]
-==== Trunked Radio System Information ====
+== The RadioReference Javascript Remote Render Display Service ==
-You can display a trunking system's general information on a Web page by adding the following code to the page:
-<pre>
-<nowiki>
-<script language="JavaScript" src="http://api.radioreference.com/js/?key=DOMAIN_KEY&sid=SID">
-</script>
-</nowiki>
-</pre>
-[[Image:Sid_api_1.gif|250px|thumb|right|Trunked System SID]]
-* DOMAIN_KEY = Your uniquely assigned and active domain key
-* SID = The unique radioreference.com trunked system system identifier.  This can be found by viewing the URL for the trunked system.
-For example, to display the Bexar County / San Antonio EDACS system's general information, you would include the following code on your page:
-<pre>
-<nowiki>
-<script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&sid=1434">
-</script>
-</nowiki>
-</pre>
-The following would be displayed on the Web page where the code was inserted:
-[[Image:Sid_api_result.gif|border|400px]]
-==== Talkgroup Category ====
-You can display a talkgroup category's talkgroups on a Web page by adding the following code to the page:
-<pre>
-<nowiki>
-<script language="JavaScript" src="http://api.radioreference.com/js/?key=DOMAIN_KEY&tgCid=TGCAT_ID">
-</script>
-</nowiki>
-</pre>
-[[Image:TgCid_api_1.gif|250px|thumb|right|Talkgroup Category Additional Details]]
-[[Image:TgCid_api_2.gif|250px|thumb|right|Talkgroup Category Unique ID (TGCAT_ID)]]
-* DOMAIN_KEY = Your uniquely assigned and active domain key
-* TGCAT_ID = The unique radioreference.com talkgroup category ID.  This can be found by clicking the talkgroup category additional details icon.
-For example, to display the City of Arlington's Fire Department Talkgroups from the Arlington Trunked System, you would add the following code:
-<pre>
-<nowiki>
-<script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&tgCid=2">
-</script>
-</nowiki>
-</pre>
-The following would be displayed on the Web page where the code was inserted:
-[[Image:TgCid_api_result.gif|border|400px]]
-==== Trunked System Complete Talkgroup List ====
-You can display all talkgroups for a trunking system on a Web page by adding the following code to the page:
-<pre>
-<nowiki>
-<script language="JavaScript" src="http://api.radioreference.com/js/?key=DOMAIN_KEY&sidalltg=SID">
-</script>
-</nowiki>
-</pre>
-[[Image:Sidalltg_api_1.gif|250px|thumb|right|Trunked System SID]]
-* DOMAIN_KEY = Your uniquely assigned and active domain key
-* SID = The unique radioreference.com trunked system system identifier.  This can be found by viewing the URL for the trunked system.
-For example, to display all talkgroups for the Parker County TX Trunking system , you would add the following code:
-<pre>
-<nowiki>
-<script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&sidalltg=5636">
-</script>
-</nowiki>
-</pre>
-The following would be displayed on the Web page where the code was inserted:
-[[Image:Sidalltg_api_result.gif|border|400px]]
-==== Trunked System Site with Frequencies====
-You can display a individual trunked system site with frequencies on a Web page by adding the following code to the page:
-<pre>
-<nowiki>
-<script language="JavaScript" src="http://api.radioreference.com/js/?key= DOMAIN_KEY&siteId=SITE_ID">
-</script>
-</nowiki>
-</pre>
-[[Image:Site_api_1.gif|250px|thumb|right|Site Additional Details Link]]
-[[Image:Site_api_2.gif|225px|thumb|right|Site Unique ID (SITE_ID)]]
-* DOMAIN_KEY = Your uniquely assigned and active domain key
-* SITE_ID = The unique radioreference.com siteId.  This can be found by clicking the site description link for a trunked system site.
-For example, to display the trunked system site for the Irving TX Public Safety Trunking System, the following code would be used:
+The RadioReference Javascript remote render service allows web designers and web page developers to integrate data from the radioreference.com database into their own Web pages for free.
-<pre>
-<nowiki>
-<script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&siteId=10500">
-</script>
-</nowiki>
-</pre>
-The following would be displayed on the Web page where the code was inserted:
+* Documentation:  [[RR_Javascript_remote_render_service]]
-[[Image:Site_api_result.gif|border|500px]]
+== Broadcastify Node Ingest API ==
+[https://www.broadcastify.com/calls Broadcastify Calls] is a high capacity service that ingests radio system calls.
+Broadcastify Calls is different from regular broadcastify feeds as the calls platform captures every single call on a conventional or trunked system, as individual call files, and makes those calls available in real time and in archives.  The API is available for 3rd party SDR applications to upload calls to the Broadcastify Calls Platform.
-== The RadioReference REST based XML Web service ==
+* Documentation:  [[Broadcastify-Calls-API]]
+<br /><br />
-The radioreference.com REST based XML Web service is currently documented here:   [[RadioReference.com_Web_Service]].
+[[Category:Database FAQ]]