YouVersion.Platform.API.Models.Unofficial
0.1.3
dotnet add package YouVersion.Platform.API.Models.Unofficial --version 0.1.3
NuGet\Install-Package YouVersion.Platform.API.Models.Unofficial -Version 0.1.3
<PackageReference Include="YouVersion.Platform.API.Models.Unofficial" Version="0.1.3" />
<PackageVersion Include="YouVersion.Platform.API.Models.Unofficial" Version="0.1.3" />
<PackageReference Include="YouVersion.Platform.API.Models.Unofficial" />
paket add YouVersion.Platform.API.Models.Unofficial --version 0.1.3
#r "nuget: YouVersion.Platform.API.Models.Unofficial, 0.1.3"
#:package YouVersion.Platform.API.Models.Unofficial@0.1.3
#addin nuget:?package=YouVersion.Platform.API.Models.Unofficial&version=0.1.3
#tool nuget:?package=YouVersion.Platform.API.Models.Unofficial&version=0.1.3
YouVersion.Platform.API.Models.Unofficial
Part of the YouVersion Platform SDK for .NET.
Domain model types for the YouVersion Platform REST API.
This package is a zero-dependency, pure-POCO library - no external NuGet dependencies required. All types are immutable record types with System.Text.Json property-name attributes.
Included types
| Type | Description |
|---|---|
| BibleVersionSummary | Lightweight version item returned by the list endpoint |
| BibleVersion | Full version metadata including available books |
| Book | A book within a Bible version (USFM code + human name) |
| Chapter | A chapter within a book |
| Verse | A single verse identifier |
| BibleIndex | Full book/chapter/verse structure for a version, as returned by GET /v1/bibles/{id}/index — the authoritative source for real, per-version counts |
| IndexBook | A book's structural position within a BibleIndex (title, canon, chapters, optional intro section) |
| IndexChapter | A chapter's structural position within an IndexBook |
| IndexVerse | A verse's structural position within an IndexChapter (no scripture text — use Passage for content) |
| IndexSection | A named, non-chapter section of a book (e.g. an introduction) |
| BookCanon | Enum identifying which scriptural canon a book belongs to (Old Testament, New Testament, Deuterocanon) |
| Passage | Scripture content returned by a passage fetch |
| PassageRequestOptions | Options controlling format, headings, and footnotes |
| PassageFormat | Text or Html enum |
| Highlight | A user Bible verse highlight — identified by (BibleId, PassageId), Color is a hex string |
| PagedResult(T) | Generic paged envelope with Data and NextPageToken |
Target framework
net10.0
Attribution
Always display the version Copyright field alongside Passage.Reference when showing Bible text.
Related packages
This package has no dependencies on other packages in this SDK. It's consumed by:
YouVersion.Platform.API.Unofficial— typed HTTP clients that return these model types.YouVersion.Platform.SDK.Services.Unofficial— business-logic services built on top ofPlatform.API.YouVersion.Platform.SDK.Components.Unofficial— Blazor components that render these types.
See the solution README for the full package list and architecture overview.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|