Quick Start

1. Create an account

   Sign up at dashboard.opelyx.com to get your free API key. No credit card required.

2. Copy your API key

   Navigate to the API Keys page in the dashboard and copy your key. It starts with op_ followed by 40 hex characters.

   ⚠ Keep your API key secret

   Never share your API key publicly or commit it to version control. Store it in environment variables and use .env files locally. If a key is compromised, revoke it immediately from the dashboard.

3. Make your first request

   curl

   curl -H "Authorization: Bearer op_YOUR_API_KEY_HERE" \
     "https://api.opelyx.com/v1/health/plans?zip=90210&age=30"

   Python

   import requests
   
   response = requests.get(
       "https://api.opelyx.com/v1/health/plans",
       headers={"Authorization": "Bearer op_YOUR_API_KEY_HERE"},
       params={"zip": "90210", "age": 30},
   )
   data = response.json()
   print(f"Found {data['total']} plans")

   JavaScript

   const response = await fetch(
     "https://api.opelyx.com/v1/health/plans?zip=90210&age=30",
     {
       headers: { Authorization: "Bearer op_YOUR_API_KEY_HERE" },
     },
   );
   const data = await response.json();
   console.log(`Found ${data.total} plans`);

4. Explore the response

   The API returns HAL-formatted JSON with _links for navigation and _embedded.plans containing the matched plans.

Next Steps

• Authentication — API key management and security best practices
• First Request — Detailed walkthrough of the plan search workflow
• Health API Overview — Full API capabilities and data coverage