Actions

Difference between revisions of "API"

From The RadioReference Wiki

 
(41 intermediate revisions by 2 users not shown)
Line 1: Line 1:
RadioReference.com provides a set of APIs for Webmasters and Application Developers to integrate data from radioreference.com into their own products.  There are three different APIs currently available:
+
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
 
* 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
 
* Javascript Remote Render Service for RadioReference Database Data
* XML/JSON based Web service for the live audio feed catalog
+
* Broadcastify Calls Node Ingest API
  
 
<br />
 
<br />
= The RadioReference SOAP based XML Web service =
+
== The RadioReference Database Web Service ==
  
Application developers have the opportunity to provide users complete access to RadioReference.com data through their own applicationsFrom 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 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.
  
The radioreference.com SOAP based XML Web service is currently documented using the following WSDL:
+
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://api.radioreference.com/soap2/?wsdl&v=latest
+
The Radioreference.com Database Web Service service is currently documented using the following WSDL:
  
Further details can be found at:
+
* http://api.radioreference.com/soap2/?wsdl&v=latest
 +
<br />
 +
Documentation and endpoint version information can be found here:
 +
 
 +
* [[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:
  
 
[[RadioReference.com_Web_Service]].
 
[[RadioReference.com_Web_Service]].
  
= The RadioReference Javascript Remote Render Display 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.
  
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. 
+
== Broadcastify Audio Feed Catalog API ==
  
== Steps for using the Javascript remote render service ==
+
The Broadcastify Audio Feed Catalog API provides XML and JSON based directory services for all live audio feeds on Broadcastify.
  
1.  Apply for a domainKey at the following page on your account settings page: 
+
* 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]
 
+
<br />
* http://www.radioreference.com/apps/account/?tab=api
+
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.
 
 
2. Wait for your domainKey to be approved by the administration staff.  You will receive an email to your email address on record when approved.
 
 
 
3.  Add the necessary javascript code snippet and domainKey to your page for the data you want to remotely render.
 
 
 
== Data available for remote rendering ==
 
 
 
=== Frequency Subcategory ===
 
 
 
You can display a frequency subcategory 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&scid=SUBCAT_ID">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
* DOMAIN_KEY = Your uniquely assigned and active domain key
 
* SUBCAT_ID = The unique radioreference.com subcategory ID.  This can be found by clicking the subcategory additional details icon for a subcategory.  See below:
 
 
 
[[Image:Scid_api_1.gif|250px|Subcategory Additional Details]]
 
[[Image:Scid_api_2.gif|250px|Subcategory Unique ID (SUBCAT_ID)]]
 
 
 
For example, to display the Comal County Fire SO frequency subcategory on a page, you would add the following code:
 
<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:
 
 
 
[[Image:Scid_api_result.gif|border|400px]]
 
 
 
=== Trunked Radio System Information ===
 
 
 
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>
 
 
 
* 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.  See below:
 
 
 
[[Image:Sid_api_1.gif|250px|Trunked System SID]]
 
 
 
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|250px]]
 
 
 
=== 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>
 
 
 
* DOMAIN_KEY = Your uniquely assigned and active domain key
 
* TGCAT_ID = The unique radioreference.com talkgroup category IDThis can be found by clicking the talkgroup category additional details icon. See below:
 
 
 
 
 
[[Image:TgCid_api_1.gif|250px|Talkgroup Category Additional Details]]
 
[[Image:TgCid_api_2.gif|250px|Talkgroup Category Unique ID (TGCAT_ID)]]
 
 
 
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>
 
 
 
* 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.
 
 
 
[[Image:Sidalltg_api_1.gif|300px|Trunked System SID]]
 
 
 
For example, to display all talkgroups for the Parker County TX Trunking system , you would add the following code to your page:
 
 
 
<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>
 
 
 
* 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.  See below:
 
 
 
[[Image:Site_api_1.gif|250px|Site Additional Details Link]]
 
[[Image:Site_api_2.gif|225px|Site Unique ID (SITE_ID)]]
 
 
 
For example, to display the trunked system site for the Irving TX Public Safety Trunking System, the following code would be used:
 
<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:
 
 
 
[[Image:Site_api_result.gif|border|500px]]
 
 
 
=== All Trunked System Sites ===
 
 
 
You can display all trunked system sites 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&sites=SID">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
* 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 trunked system sites for the San Antonio TX Public Safety Trunking System, the following code would be used:
 
<pre>
 
<nowiki>
 
<script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&sites=1434">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
=== An Audio Feed ===
 
 
 
You can embed an audio feed player for a RadioReference hosted audio feed using:
 
<pre>
 
<nowiki>
 
<script language="JavaScript" src="http://api.radioreference.com/js/?key= DOMAIN_KEY&feedId=ID&as=STARTVALUE">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
* DOMAIN_KEY = Your uniquely assigned and active domain key
 
* ID = The unique radioreference.com audio feed identifier. Feed providers can retrieve this value from their feed owner's page
 
* STARTVALUE = set to 0 to not auto start playing the feed.  Set to 1 to auto start playing the feed on load.
 
 
 
For example, to display a feed with feedId 1024 and start playing on load you would use:
 
<pre>
 
<nowiki>
 
<script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&feedId=1024&as=1">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
The following example is an embedded audio feed
 
 
 
[[Image: Screen shot 2009-09-30 at 4.52.14 PM.png|border|200px]]
 
 
 
=== Customizing the Width of Tables ===
 
 
 
Adding the following to any method query will allow you to customize the width of the table(s) returned by the method (does not apply to audio feed method)
 
 
 
&width=100%
 
 
 
or
 
 
 
&width=500px
 
  
= The RadioReference Audio Feed Catalog API =
+
== Broadcastify Feed Owner API ==  
  
The audio feed catalog API provides all live audio feeds and their details in XML and JSON format.  A license is required to use this API, and a special license key is issued to users.
+
Broadcastify Feed Owners have a freely available API to dynamically get statistics and status of their feeds.
  
<div class="boxyl">Please note that as of November 15th 2009 RadioReference is no longer approving any new applications for API keys for developers of '''iPhone audio streaming applications'''. There are already 10+ applications available that primarly accomplish the same objectives, and approving further applications will only serve to dilute the market further for our existing valued partners. </div>
+
* Documentation:  [https://support.broadcastify.com/hc/en-us/articles/204172369-Feed-Owner-API-v0-9-Documentation Feed Owner API Documentation ]
  
A list of applications currently licensed is provided here: [[Live Audio API Licensees]]
+
== The RadioReference Javascript Remote Render Display Service ==
  
== Documentation ==
+
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.
The Live Audio API current version is 1.0. The specification is documented in this
 
[[Media:RRaudioAPI_1.0.pdf|link]]
 
  
== Mailing List ==
+
* Documentation:  [[RR_Javascript_remote_render_service]]
  
Developers are encourage to join the Live Audio API Developer's Mailing list.  Announcements and support is provided on this mailing list:
+
== Broadcastify Node Ingest API ==
  
* http://groups.yahoo.com/group/RR_LiveAudioAPI
+
[https://www.broadcastify.com/calls Broadcastify Calls] is a high capacity service that ingests radio system calls.
  
== Methods Available ==
+
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.
  
* feeds = return all feeds in the directory
+
* Documentation:  [[Broadcastify-Calls-API]]
* countries = return all countries that have audio feeds
+
<br /><br />
* states = return all states in a country
 
* counties = returns all counties in a state that have audio feeds
 
* county = returns all feeds present in a county
 
* feed = return an individual feed's details
 
  
[[Category:FAQ]]
+
[[Category:Database FAQ]]

Latest 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:


Documentation and endpoint version information can be found here:


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.


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.

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.

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.