Important
This is not an official SDK developed by Esv.org.
Developer-friendly & type-safe Typescript SDK specifically catered to leverage Esv.org API.
ESV.org API: A convenient way to fetch content from ESV.org.
The ESV API provides access to the ESV text, with a customizable presentation in multiple formats.
For more information about the API: ESV API Website
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add esv-sdkpnpm add esv-sdkbun add esv-sdkyarn add esv-sdk zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.Note
This package is published with CommonJS and ES Modules (ESM) support.
This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.
Node.js v20 or greater is required to run the MCP server.
Claude installation steps
Add the following server definition to your claude_desktop_config.json file:
{
"mcpServers": {
"Esv": {
"command": "npx",
"args": ["-y", "--", "esv-sdk", "mcp", "start"],
"env": {
"ESV_API_KEY": "..."
}
}
}
}Cursor installation steps
-
Create a shell script called
mcp-esv.shwith the following content:#!/bin/sh export ESV_API_KEY="..." exec npx -y -- esv-sdk mcp start "$@"
-
Then make it executable with the following command:
chmod +x mcp-esv.sh
-
In Cursor,
Cursor Settings > Features > MCP Servers > Add new MCP serverand use the following settings:Field Value Name Esv Type commandCommand /path/to/mcp-esv.sh
For a full list of server arguments, run:
npx -y -- esv-sdk mcp start --helpFor supported JavaScript runtimes, please consult RUNTIMES.md.
import { Esv } from "esv-sdk";
const esv = new Esv({
apiKey: process.env["ESV_API_KEY"] ?? "",
});
async function run() {
const result = await esv.passages.getHtml({
query: "John 1:1",
});
// Handle the result
console.log(result);
}
run();This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
|---|---|---|---|
apiKey |
apiKey | API key | ESV_API_KEY |
To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:
import { Esv } from "esv-sdk";
const esv = new Esv({
apiKey: process.env["ESV_API_KEY"] ?? "",
});
async function run() {
const result = await esv.passages.getHtml({
query: "John 1:1",
});
// Handle the result
console.log(result);
}
run();Available methods
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
Available standalone functions
passagesGetAudio- Get Bible passage audiopassagesGetHtml- Get Bible passage HTMLpassagesGetText- Get Bible passage textpassagesSearch- Search Bible passages
Some of the endpoints in this SDK support pagination. To use pagination, you
make your SDK calls as usual, but the returned response object will also be an
async iterable that can be consumed using the for await...of
syntax.
Here's an example of one such pagination call:
import { Esv } from "esv-sdk";
const esv = new Esv({
apiKey: process.env["ESV_API_KEY"] ?? "",
});
async function run() {
const result = await esv.passages.search({
query: "<value>",
});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { Esv } from "esv-sdk";
const esv = new Esv({
apiKey: process.env["ESV_API_KEY"] ?? "",
});
async function run() {
const result = await esv.passages.getHtml({
query: "John 1:1",
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
// Handle the result
console.log(result);
}
run();If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { Esv } from "esv-sdk";
const esv = new Esv({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
apiKey: process.env["ESV_API_KEY"] ?? "",
});
async function run() {
const result = await esv.passages.getHtml({
query: "John 1:1",
});
// Handle the result
console.log(result);
}
run();Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the getHtml method may throw the following errors:
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.ErrorT | 400, 401 | application/json |
| errors.APIError | 4XX, 5XX | */* |
If the method throws an error and it is not captured by the known errors, it will default to throwing a APIError.
import { Esv } from "esv-sdk";
import { ErrorT, SDKValidationError } from "esv-sdk/models/errors";
const esv = new Esv({
apiKey: process.env["ESV_API_KEY"] ?? "",
});
async function run() {
let result;
try {
result = await esv.passages.getHtml({
query: "John 1:1",
});
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
// The server response does not match the expected SDK schema
case (err instanceof SDKValidationError): {
// Pretty-print will provide a human-readable multi-line error message
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case (err instanceof ErrorT): {
// Handle err.data$: ErrorTData
console.error(err);
return;
}
default: {
// Other errors such as network errors, see HTTPClientErrors for more details
throw err;
}
}
}
}
run();Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:
| HTTP Client Error | Description |
|---|---|
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |
The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
import { Esv } from "esv-sdk";
const esv = new Esv({
serverURL: "https://api.esv.org/v3/",
apiKey: process.env["ESV_API_KEY"] ?? "",
});
async function run() {
const result = await esv.passages.getHtml({
query: "John 1:1",
});
// Handle the result
console.log(result);
}
run();The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:
import { Esv } from "esv-sdk";
import { HTTPClient } from "esv-sdk/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new Esv({ httpClient });You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
Warning
Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { Esv } from "esv-sdk";
const sdk = new Esv({ debugLogger: console });You can also enable a default debug logger by setting an environment variable ESV_DEBUG to true.
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.