Developer Tools: API

Application Programming Interface (API)

Tags

Tags are annotations applied to selected Bible verses. Tags belong to users. Individual tags retrieved via API will also include the verse references to which they refer.

List

GET /tags.xml

Returns all, site-wide tags.

Note: This request for all tags will not include their verse references.

Example:

Request
XML
JSON
GET https://ga.bibles.org/v2/tags.xml
Response
<?xml version="1.0" encoding="utf-8"?>
<response>
  <tags>
    <tag id="1">
      <id>1</id>
      <name><![CDATA[locusts]]></name>
    </tag>
    <tag id="2">
      <id>2</id>
      <name><![CDATA[universe]]></name>
    </tag>
    <tag id="3">
      <id>3</id>
      <name><![CDATA[beginning]]></name>
    </tag>
  </tags>
  <meta>
    <fums><![CDATA[<script>
var _BAPI=_BAPI||{};
if(typeof(_BAPI.t)==='undefined'){
document.write('\x3Cscript src="'+document.location.protocol+'//d2ue49q0mum86x.cloudfront.net/include/fums.c.js"\x3E\x3C/script\x3E');}
document.write("\x3Cscript\x3E_BAPI.t('50538d015430f6.55053824');\x3C/script\x3E");
</script><noscript><img src="https://d3a2okcloueqyx.cloudfront.net/nf1?t=50538d015430f6.55053824" height="1" width="1" border="0" alt="" style="height: 0; width: 0;" /></noscript>]]></fums>
    <fums_tid>50538d015430f6.55053824</fums_tid>
    <fums_js_include>d2ue49q0mum86x.cloudfront.net/include/fums.c.js</fums_js_include>
    <fums_js><![CDATA[var _BAPI=_BAPI||{};if(typeof(_BAPI.t)!='undefined'){ _BAPI.t('50538d015430f6.55053824'); }]]></fums_js>
    <fums_noscript><![CDATA[<img src="https://d3a2okcloueqyx.cloudfront.net/nf1?t=50538d015430f6.55053824" height="1" width="1" border="0" alt="" style="height: 0; width: 0;" />]]></fums_noscript>
  </meta>
</response>

Show

GET /tags/#{tag_id}.xml

Returns the tag identified by the specified ID. Tag IDs are numbers and can be found by listing all tags.

Example:

Request
XML
JSON
GET https://ga.bibles.org/v2/tags/31.xml
Response
<?xml version="1.0" encoding="utf-8"?>
<response>
  <tags>
    <tag id="31">
      <id>31</id>
      <name><![CDATA[peace]]></name>
      <references>
        <reference>
          <start>eng-GNTD:2Cor.4.15</start>
          <end>eng-GNTD:2Cor.4.16</end>
          <created_at>Wed, 30 Nov -001 00:00:00 -0600</created_at>
          <updated_at>Wed, 30 Nov -001 00:00:00 -0600</updated_at>
        </reference>
        <reference>
          <start>eng-GNTD:Matt.10.1</start>
          <end>eng-GNTD:Matt.10.42</end>
          <created_at>Wed, 30 Nov -001 00:00:00 -0600</created_at>
          <updated_at>Wed, 30 Nov -001 00:00:00 -0600</updated_at>
        </reference>
        <reference>
          <start>eng-GNTD:John.3.3</start>
          <end>eng-GNTD:John.3.4</end>
          <created_at>Wed, 30 Nov -001 00:00:00 -0600</created_at>
          <updated_at>Wed, 30 Nov -001 00:00:00 -0600</updated_at>
        </reference>
      </references>
    </tag>
  </tags>
  <meta>
    <fums><![CDATA[<script>
var _BAPI=_BAPI||{};
if(typeof(_BAPI.t)==='undefined'){
document.write('\x3Cscript src="'+document.location.protocol+'//d2ue49q0mum86x.cloudfront.net/include/fums.c.js"\x3E\x3C/script\x3E');}
document.write("\x3Cscript\x3E_BAPI.t('5053a7c180ad24.30347179');\x3C/script\x3E");
</script><noscript><img src="https://d3a2okcloueqyx.cloudfront.net/nf1?t=5053a7c180ad24.30347179" height="1" width="1" border="0" alt="" style="height: 0; width: 0;" /></noscript>]]></fums>
    <fums_tid>5053a7c180ad24.30347179</fums_tid>
    <fums_js_include>d2ue49q0mum86x.cloudfront.net/include/fums.c.js</fums_js_include>
    <fums_js><![CDATA[var _BAPI=_BAPI||{};if(typeof(_BAPI.t)!='undefined'){ _BAPI.t('5053a7c180ad24.30347179'); }]]></fums_js>
    <fums_noscript><![CDATA[<img src="https://d3a2okcloueqyx.cloudfront.net/nf1?t=5053a7c180ad24.30347179" height="1" width="1" border="0" alt="" style="height: 0; width: 0;" />]]></fums_noscript>
  </meta>
</response>

GET /tags/#{tag_name}.xml

For convenience, you may also retrieve tags by name. Make sure you properly URL encode the tag name.

Example:

Request
XML
JSON
GET https://ga.bibles.org/v2/tags/peace.xml
Response
<?xml version="1.0" encoding="utf-8"?>
<response>
  <tags>
    <tag id="31">
      <id>31</id>
      <name><![CDATA[peace]]></name>
      <references>
        <reference>
          <start>eng-GNTD:2Cor.4.15</start>
          <end>eng-GNTD:2Cor.4.16</end>
          <created_at>Wed, 30 Nov -001 00:00:00 -0600</created_at>
          <updated_at>Wed, 30 Nov -001 00:00:00 -0600</updated_at>
        </reference>
        <reference>
          <start>eng-GNTD:Matt.10.1</start>
          <end>eng-GNTD:Matt.10.42</end>
          <created_at>Wed, 30 Nov -001 00:00:00 -0600</created_at>
          <updated_at>Wed, 30 Nov -001 00:00:00 -0600</updated_at>
        </reference>
        <reference>
          <start>eng-GNTD:John.3.3</start>
          <end>eng-GNTD:John.3.4</end>
          <created_at>Wed, 30 Nov -001 00:00:00 -0600</created_at>
          <updated_at>Wed, 30 Nov -001 00:00:00 -0600</updated_at>
        </reference>
      </references>
    </tag>
  </tags>
  <meta>
    <fums><![CDATA[<script>
var _BAPI=_BAPI||{};
if(typeof(_BAPI.t)==='undefined'){
document.write('\x3Cscript src="'+document.location.protocol+'//d2ue49q0mum86x.cloudfront.net/include/fums.c.js"\x3E\x3C/script\x3E');}
document.write("\x3Cscript\x3E_BAPI.t('5053a872dc33c3.20229420');\x3C/script\x3E");
</script><noscript><img src="https://d3a2okcloueqyx.cloudfront.net/nf1?t=5053a872dc33c3.20229420" height="1" width="1" border="0" alt="" style="height: 0; width: 0;" /></noscript>]]></fums>
    <fums_tid>5053a872dc33c3.20229420</fums_tid>
    <fums_js_include>d2ue49q0mum86x.cloudfront.net/include/fums.c.js</fums_js_include>
    <fums_js><![CDATA[var _BAPI=_BAPI||{};if(typeof(_BAPI.t)!='undefined'){ _BAPI.t('5053a872dc33c3.20229420'); }]]></fums_js>
    <fums_noscript><![CDATA[<img src="https://d3a2okcloueqyx.cloudfront.net/nf1?t=5053a872dc33c3.20229420" height="1" width="1" border="0" alt="" style="height: 0; width: 0;" />]]></fums_noscript>
  </meta>
</response>