Skip to main content

Install

Quick Start

Authentication

For public endpoints, no auth is needed. For user endpoints (api.me.*), pass an access token:
See @urantia/auth for how to obtain an access token via OAuth.

Endpoint Groups

Every method returns typed responses with full autocomplete. For detailed parameter docs, see the API Reference.

Content

Utilities

User Data (Authenticated)

Languages

Supported languages: eng (English, default), es (Spanish), fr (French), pt (Portuguese), de (German), ko (Korean). The language field in the response tells you which language was returned. If a translation isn’t available for the requested language, the API falls back to English and returns language: "eng".
Entity translations (names, descriptions, aliases) are available for all 4,456 entities in all 5 languages. Paragraph translations are coming soon.

Paragraph References

The SDK accepts all three reference formats interchangeably:

Options

Error Handling

All methods throw an Error with the API’s error message on failure: