Getting Started

Authentication

Copy page

The YouVersion Bible API uses App Key authentication to secure all requests. This ensures that only authorized applications can access the API.

App Key Authentication

All API requests must include your App Key in the X-YVP-App-Key header. This header is required for every endpoint.

Header Format

Code
 
X-YVP-App-Key: YOUR_APP_KEY

Example Request

Code
 
curl -H "X-YVP-App-Key: YOUR_APP_KEY" \
     https://api.youversion.com/v1/bibles

Example Response

Code
 
{
  "data": [
    {
      "id": 111,
      "abbreviation": "NIV",
      "title": "New International Version 2011",
      "language": {
        "iso_639_1": "en",
        "name": "English"
      }
    }
  ]
}

Getting Your App Key

To obtain an App Key for the YouVersion Bible API:

1. Sign up as for a [https://platform.youversion.com/join](YouVersion Platform Partner account)
2. Provide details about your application and use case and create an app on the YouVersion Platform Portal
3. Receive your unique App Key from the YVP system.

Security Best Practices

• Keep your App Key secure: add best practices

Error Responses

If authentication fails, you'll receive a 401 Unauthorized response:

Code
 
{
  "error": "Unauthorized",
  "message": "Invalid or missing App Key"
}

Rate Limiting

App Keys are subject to rate limiting to ensure fair usage. Check the response headers for rate limit information:

• X-RateLimit-Limit: Maximum requests per time window
• X-RateLimit-Remaining: Remaining requests in current window
• X-RateLimit-Reset: Time when the rate limit resets

Multiple Environments

The API is available in multiple environments:

• Development: https://api-dev.youversion.com/v1
• Production: https://api.youversion.com/v1
• Local: http://127.0.0.1:8000/v1 (for development purposes)

Use the appropriate environment for your use case and ensure your App Key is valid for the environment you're targeting.