npm install @youversion/platform-coreA type-safe TypeScript SDK for accessing the YouVersion Platform APIs. Get Bible content and build Bible-based applications.
Use @youversion/platform-core when you need:
- ✅ Direct access to YouVersion Platform APIs
- ✅ Server-side/Node.js Bible data fetching
- ✅ Full control over API calls and data handling
- ✅ Minimal dependencies (works anywhere JavaScript runs)
Use other packages instead if:
- ❌ Building React components → Use @youversion/platform-react-hooks for hooks with state management
- ❌ Need ready-made UI → Use @youversion/platform-react-ui for production-ready components
``bash`
pnpm add @youversion/platform-core
Get your App Key at platform.youversion.com
`ts
import { ApiClient, BibleClient } from '@youversion/platform-core';
const apiClient = new ApiClient({
appKey: 'YOUR_APP_KEY',
});
const bibleClient = new BibleClient(apiClient);
// Find available Bible versions in English
const versions = await bibleClient.getVersions('en*');
console.log(versions.data[0].title);
// Fetch the html text of John 3:16 in that first Bible version
const passage = await bibleClient.getPassage(versions.data[0].id, 'JHN.3.16');
console.log(passage.content);
``
This SDK is licensed under Apache 2.0.
Licensing information for the Bible versions is available
at the YouVersion Platform site.