{
    "name": "India Pincode REST API",
    "version": "v1",
    "description": "Complete India postal pincode database — 1,57,000+ post offices across 36 states\/UTs",
    "endpoints": {
        "GET \/api\/v1\/": "API info (this page)",
        "GET \/api\/v1\/stats": "Dataset statistics",
        "GET \/api\/v1\/states": "List all states & UTs",
        "GET \/api\/v1\/states\/{state}": "All pincodes for a state",
        "GET \/api\/v1\/districts": "List all districts [?state=]",
        "GET \/api\/v1\/districts\/{district}": "All pincodes for a district",
        "GET \/api\/v1\/pincodes": "Paginated pincode list [?state= &district= &type= &delivery=]",
        "GET \/api\/v1\/pincodes\/{pincode}": "All post offices for a pincode",
        "GET \/api\/v1\/offices": "Post offices [?state= &district= &pincode= &type= &delivery=]",
        "GET \/api\/v1\/search?q={query}": "Search by office name \/ district \/ pincode",
        "GET \/api\/v1\/autofill\/{pincode}": "⚡ Form autofill: resolve state, district & city from a pincode",
        "GET \/api\/v1\/autofill\/suggest?q={q}": "⚡ Typeahead: suggest pincodes, cities, districts by partial input"
    },
    "query_params": {
        "page": "Page number (default: 1)",
        "limit": "Results per page (default: 100, max: 500)",
        "state": "Filter by state name (case-insensitive)",
        "district": "Filter by district name (case-insensitive)",
        "pincode": "Filter by pincode number",
        "type": "Filter by office type: BO | PO | HO",
        "delivery": "Filter: delivery | non-delivery",
        "q": "Search query (for \/search endpoint)"
    },
    "office_types": {
        "BO": "Branch Office",
        "PO": "Post Office",
        "HO": "Head Office"
    }
}