API Documentation

Welcome to the API documentation. Below are the details of the available endpoints.

Endpoints

1. Get Names

Retrieve a list of names from the database.

    
    GET /api/names
    
    

Query Parameters:

• starts_with: Filter names that start with this letter.
• count: Number of names to return (default: 1).

Example Request:

    
    curl -H "X-API-KEY: your_generated_api_key" "https://mallunames.vercel.app/api/names?starts_with=A&count=6"
    
    

Python Example Request:

    
    import requests

    url = "https://mallunames.vercel.app/api/names"
    headers = {
        "X-API-KEY": "your_generated_api_key"
    }
    params = {
        "starts_with": "A",
        "count": 6
    }

    response = requests.get(url, headers=headers, params=params)
    data = response.json()
    print(data)
    
    

Example Response:

    
    {
        "names": ["Abhinav", "Anna", "Aswathy", "Arjun", "Anjali", "Ava"]
    }
    
    

Authentication

All requests must include the API key in the X-API-KEY header.

Request an API Key

If you need an API key, please email us with your request, and we will send you an API key.