# Apibible.VersesApi

All URIs are relative to *https://api.scripture.api.bible*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getVerse**](VersesApi.md#getVerse) | **GET** /v1/bibles/{bibleId}/verses/{verseId} | 
[**getVerses**](VersesApi.md#getVerses) | **GET** /v1/bibles/{bibleId}/chapters/{chapterId}/verses | 
[**searchBible**](VersesApi.md#searchBible) | **GET** /v1/bibles/{bibleId}/verses/search | 


<a name="getVerse"></a>
# **getVerse**
> InlineResponse20010 getVerse(apiKey, bibleId, verseId, opts)



Gets a &#x60;Verse&#x60; object for a given &#x60;bibleId&#x60; and &#x60;verseId&#x60;. This Verse object also includes an &#x60;content&#x60; property with the verse corresponding to the verseId. 

### Example
```javascript
var Apibible = require('apibible');

var apiInstance = new Apibible.VersesApi();

var apiKey = "apiKey_example"; // String | API Key Authentication Parameter

var bibleId = "bibleId_example"; // String | Id of Bible for passage

var verseId = "verseId_example"; // String | String reference id for the requested verse.

var opts = { 
  'contentType': "html", // String | Content type to be returned in the content property.  Supported values are `html` (default), `json` (beta), and `text` (beta)
  'includeNotes': false, // Boolean | Include footnotes in content
  'includeTitles': true, // Boolean | Include section titles in content
  'includeChapterNumbers': false, // Boolean | Include chapter numbers in content
  'includeVerseNumbers': true, // Boolean | Include verse numbers in content
  'parallels': "parallels_example" // String | Comma delimited list of bibleIds to include
};
apiInstance.getVerse(apiKey, bibleId, verseId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **apiKey** | **String**| API Key Authentication Parameter | 
 **bibleId** | **String**| Id of Bible for passage | 
 **verseId** | **String**| String reference id for the requested verse. | 
 **contentType** | **String**| Content type to be returned in the content property.  Supported values are &#x60;html&#x60; (default), &#x60;json&#x60; (beta), and &#x60;text&#x60; (beta) | [optional] [default to html]
 **includeNotes** | **Boolean**| Include footnotes in content | [optional] [default to false]
 **includeTitles** | **Boolean**| Include section titles in content | [optional] [default to true]
 **includeChapterNumbers** | **Boolean**| Include chapter numbers in content | [optional] [default to false]
 **includeVerseNumbers** | **Boolean**| Include verse numbers in content | [optional] [default to true]
 **parallels** | **String**| Comma delimited list of bibleIds to include | [optional] 

### Return type

[**InlineResponse20010**](InlineResponse20010.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="getVerses"></a>
# **getVerses**
> InlineResponse2009 getVerses(apiKey, bibleId, chapterId)



Gets an array of &#x60;Verse&#x60; objects for a given &#x60;bibleId&#x60; and &#x60;chapterId&#x60; 

### Example
```javascript
var Apibible = require('apibible');

var apiInstance = new Apibible.VersesApi();

var apiKey = "apiKey_example"; // String | API Key Authentication Parameter

var bibleId = "bibleId_example"; // String | Id of Bible whose Verses to fetch

var chapterId = "chapterId_example"; // String | Id of the Chapter whose Verses to fetch

apiInstance.getVerses(apiKey, bibleId, chapterId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **apiKey** | **String**| API Key Authentication Parameter | 
 **bibleId** | **String**| Id of Bible whose Verses to fetch | 
 **chapterId** | **String**| Id of the Chapter whose Verses to fetch | 

### Return type

[**InlineResponse2009**](InlineResponse2009.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="searchBible"></a>
# **searchBible**
> InlineResponse20011 searchBible(apiKey, bibleId, opts)



Gets search results for a given &#x60;bibleId&#x60; and query string.  Searches will match all verses with the list of keywords provided in the query string. Order of the keywords does not matter. However all keywords must be present in a verse for it to be considered a match. The total number of results returned from a search can be limited by populating the &#x60;limit&#x60; attribute in the query string with a non-negative integer value.  If no limit value is provide a default of 10 is used. &#x60;offset&#x60; can be used to traverse paginated results.  So for example if you are using the default &#x60;limit&#x60; of 10, using an &#x60;offset&#x60; of 10 will return the second page of results, namely results 11-20. The &#x60;text&#x60; property of each verse object contains only the verse text.  It does not contain footnote references. However, those can be queried directly using the &#x60;/bibles/{bibleId}/verses/{verseId}&#x60; endpoint. 

### Example
```javascript
var Apibible = require('apibible');

var apiInstance = new Apibible.VersesApi();

var apiKey = "apiKey_example"; // String | API Key Authentication Parameter

var bibleId = "bibleId_example"; // String | Id of Bible whose Section to fetch

var opts = { 
  'query': "query_example", // String | Search keywords. 
  'limit': 56, // Number | Integer limit for how many matching results to return. Default is 10.
  'offset': 56 // Number | Offset for search results. Used to paginate results
};
apiInstance.searchBible(apiKey, bibleId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **apiKey** | **String**| API Key Authentication Parameter | 
 **bibleId** | **String**| Id of Bible whose Section to fetch | 
 **query** | **String**| Search keywords.  | [optional] 
 **limit** | **Number**| Integer limit for how many matching results to return. Default is 10. | [optional] 
 **offset** | **Number**| Offset for search results. Used to paginate results | [optional] 

### Return type

[**InlineResponse20011**](InlineResponse20011.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined