Actions

Difference between revisions of "API"

From The RadioReference Wiki

(14 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
* SOAP Based Web service for RadioReference Database Data
 
* SOAP Based Web service for RadioReference Database Data
 
* 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
 
  
 
<br />
 
<br />
Line 12: Line 11:
 
The radioreference.com SOAP based XML Web service is currently documented using the following WSDL:
 
The radioreference.com SOAP based XML Web service is currently documented using the following WSDL:
  
http://api.radioreference.com/soap2/?wsdl&v=latest
+
* http://api.radioreference.com/soap2/?wsdl&v=latest
  
 
Documentation and version information can be found here:
 
Documentation and version information can be found here:
  
[[RadioReference.com_Web_Service3.1]]
+
* '''[[RadioReference.com_Web_Service3.1|SOAP Web Service Documentation]]'''
  
Further details can be found at:
+
Application support and further details can be found at:
  
 
[[RadioReference.com_Web_Service]].
 
[[RadioReference.com_Web_Service]].
Line 38: Line 37:
 
1.  Apply for a domainKey at the following page on your account settings page:   
 
1.  Apply for a domainKey at the following page on your account settings page:   
  
* http://www.radioreference.com/apps/account/?tab=api
+
* https://www.radioreference.com/account/api
  
 
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.
 
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.
Line 52: Line 51:
 
<nowiki>
 
<nowiki>
 
<script language="JavaScript"
 
<script language="JavaScript"
  src="http://api.radioreference.com/js/?key=DOMAIN_KEY&scid=SUBCAT_ID">
+
  src="https://api.radioreference.com/js/?key=DOMAIN_KEY&scid=SUBCAT_ID">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 67: Line 66:
 
<nowiki>
 
<nowiki>
 
<script language="JavaScript"
 
<script language="JavaScript"
  src="http://api.radioreference.com/js/?key=12345678&scid=195">
+
  src="https://api.radioreference.com/js/?key=12345678&scid=195">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 82: Line 81:
 
<nowiki>
 
<nowiki>
 
<script language="JavaScript"
 
<script language="JavaScript"
  src="http://api.radioreference.com/js/?key=DOMAIN_KEY&sid=SID">
+
  src="https://api.radioreference.com/js/?key=DOMAIN_KEY&sid=SID">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 96: Line 95:
 
<nowiki>
 
<nowiki>
 
<script language="JavaScript"
 
<script language="JavaScript"
  src="http://api.radioreference.com/js/?key=12345678&sid=1434">
+
  src="https://api.radioreference.com/js/?key=12345678&sid=1434">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 111: Line 110:
 
<nowiki>
 
<nowiki>
 
<script language="JavaScript"  
 
<script language="JavaScript"  
  src="http://api.radioreference.com/js/?key=DOMAIN_KEY&tgCid=TGCAT_ID">
+
  src="https://api.radioreference.com/js/?key=DOMAIN_KEY&tgCid=TGCAT_ID">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 127: Line 126:
 
<nowiki>
 
<nowiki>
 
<script language="JavaScript"  
 
<script language="JavaScript"  
  src="http://api.radioreference.com/js/?key=12345678&tgCid=2">
+
  src="https://api.radioreference.com/js/?key=12345678&tgCid=2">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 142: Line 141:
 
<nowiki>
 
<nowiki>
 
<script language="JavaScript"
 
<script language="JavaScript"
  src="http://api.radioreference.com/js/?key=DOMAIN_KEY&sidalltg=SID">
+
  src="https://api.radioreference.com/js/?key=DOMAIN_KEY&sidalltg=SID">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 157: Line 156:
 
<nowiki>
 
<nowiki>
 
<script language="JavaScript"  
 
<script language="JavaScript"  
  src="http://api.radioreference.com/js/?key=12345678&sidalltg=5636">
+
  src="https://api.radioreference.com/js/?key=12345678&sidalltg=5636">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 172: Line 171:
 
<nowiki>
 
<nowiki>
 
<script language="JavaScript"
 
<script language="JavaScript"
  src="http://api.radioreference.com/js/?key= DOMAIN_KEY&siteId=SITE_ID">
+
  src="https://api.radioreference.com/js/?key= DOMAIN_KEY&siteId=SITE_ID">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 187: Line 186:
 
<nowiki>
 
<nowiki>
 
<script language="JavaScript"
 
<script language="JavaScript"
  src="http://api.radioreference.com/js/?key=12345678&siteId=10500">
+
  src="https://api.radioreference.com/js/?key=12345678&siteId=10500">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 202: Line 201:
 
<nowiki>
 
<nowiki>
 
<script language="JavaScript"
 
<script language="JavaScript"
  src="http://api.radioreference.com/js/?key= DOMAIN_KEY&sites=SID">
+
  src="https://api.radioreference.com/js/?key= DOMAIN_KEY&sites=SID">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 214: Line 213:
 
<nowiki>
 
<nowiki>
 
<script language="JavaScript"
 
<script language="JavaScript"
  src="http://api.radioreference.com/js/?key=12345678&sites=1434">
+
  src="https://api.radioreference.com/js/?key=12345678&sites=1434">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
 
</pre>
 
</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 ===
 
=== Customizing the Width of Tables ===
Line 257: Line 228:
 
  &width=500px
 
  &width=500px
  
= The RadioReference Audio Feed Catalog API =
+
[[Category:Database FAQ]]
 
 
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.
 
 
 
<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>
 
 
 
A list of applications currently licensed is provided here: [[Live Audio API Licensees]]
 
 
 
== Documentation ==
 
The Live Audio API current version is 1.1 (Feb 1st, 2011).  The specification is documented in the following PDF:
 
 
 
* [[Media:RRaudioAPI_1.2.pdf‎ | Live Audio API v1.2]]  (PDF)
 
 
 
== Developer Support ==
 
 
 
Developers are encourage to join the Live Audio API Developer's Mailing list.  Announcements and support is provided on this mailing list:
 
 
 
* http://groups.yahoo.com/group/RR_LiveAudioAPI
 
 
 
== Methods Available ==
 
 
 
* feeds = return all feeds in the directory
 
* countries = return all countries that have audio feeds
 
* 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]]
 

Revision as of 16:39, 7 June 2020

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:

  • SOAP Based Web service for RadioReference Database Data
  • Javascript Remote Render Service for RadioReference Database Data


The RadioReference SOAP based XML Web service

Application developers have the opportunity to 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 SOAP based XML Web service is currently documented using the following WSDL:

Documentation and version information can be found here:

Application support and further details can be found at:

RadioReference.com_Web_Service.

Developer Support

The above mailing list has been created for developers who need support and have questions about how to use the Web service. In addition, news and announcements related to changes and updates to the Web service will be communicated here.

Developers of software applications that use the Web service are strongly encouraged to join.

The RadioReference Javascript Remote Render Display Service

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.

Steps for using the Javascript remote render service

1. Apply for a domainKey at the following page on your account settings page:

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:


<script language="JavaScript"
 src="https://api.radioreference.com/js/?key=DOMAIN_KEY&scid=SUBCAT_ID">
</script>

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

Subcategory Additional Details 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:


<script language="JavaScript"
 src="https://api.radioreference.com/js/?key=12345678&scid=195">
</script>

The following would be displayed on the Web page where the code was inserted:

Scid api result.gif

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:


<script language="JavaScript"
 src="https://api.radioreference.com/js/?key=DOMAIN_KEY&sid=SID">
</script>

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

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:


<script language="JavaScript"
 src="https://api.radioreference.com/js/?key=12345678&sid=1434">
</script>

The following would be displayed on the Web page where the code was inserted:

Sid api result.gif

Talkgroup Category

You can display a talkgroup category's talkgroups on a Web page by adding the following code to the page:


<script language="JavaScript" 
 src="https://api.radioreference.com/js/?key=DOMAIN_KEY&tgCid=TGCAT_ID">
</script>

  • 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. See below:


Talkgroup Category Additional Details 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:


<script language="JavaScript" 
 src="https://api.radioreference.com/js/?key=12345678&tgCid=2">
</script>

The following would be displayed on the Web page where the code was inserted:

TgCid api result.gif

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:


<script language="JavaScript"
 src="https://api.radioreference.com/js/?key=DOMAIN_KEY&sidalltg=SID">
</script>

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

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:


<script language="JavaScript" 
 src="https://api.radioreference.com/js/?key=12345678&sidalltg=5636">
</script>

The following would be displayed on the Web page where the code was inserted:

Sidalltg api result.gif

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:


<script language="JavaScript"
 src="https://api.radioreference.com/js/?key= DOMAIN_KEY&siteId=SITE_ID">
</script>

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

Site Additional Details Link 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:


<script language="JavaScript"
 src="https://api.radioreference.com/js/?key=12345678&siteId=10500">
</script>

The following would be displayed on the Web page where the code was inserted:

Site api result.gif

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:


<script language="JavaScript"
 src="https://api.radioreference.com/js/?key= DOMAIN_KEY&sites=SID">
</script>

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


<script language="JavaScript"
 src="https://api.radioreference.com/js/?key=12345678&sites=1434">
</script>

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