Getting Started

Quick Start

Make your first API call in under 2 minutes.

1. Get Your API Key

For testing, use our demo API key:

demo-key-12345

2. Make Your First Request

Fetch A1 level vocabulary with a simple cURL request:

cURL

curl -X GET "https://german-language.onrender.com/vocab?level=a1&limit=5" \
  -H "X-API-Key: demo-key-12345"

3. Understand the Response

You'll receive a JSON response like this:

Response 200 OK

{
  "level": "A1",
  "total": 834,
  "returned": 5,
  "data": [
    {
      "german": "Haus",
      "english": "house",
      "gender": "das",
      "pos": "noun",
      "example_de": "Das Haus ist groß.",
      "example_en": "The house is big."
    },
    // ... more entries
  ]
}

Available Endpoints

Endpoint	Description
`GET /vocab`	Get vocabulary by CEFR level
`GET /vocab/search`	Search vocabulary
`GET /grammar`	Get grammar rules
`GET /sentences`	Get sentences by level
`GET /alphabet`	Get alphabet with pronunciation
`GET /stats`	Get dataset statistics

Next Steps

Learn about authentication and explore the full API reference.