Skip to main content

​
Quickstart Guide

Get up and running with Nepal Administrative Divisions quickly. This guide covers both the web interface and API access.

​
Using the Web Interface

1

Access the Application

Navigate to the application URL in your web browser. The home page displays all 7 provinces of Nepal.
2

Browse Provinces

Click on any province to view its districts. Each province card shows:
  • Province name
  • Headquarters
  • Total area
  • Official website
3

Explore Districts

From a province page, click on any district to see its municipalities. District information includes area, headquarters, and website.
4

Search Divisions

Use the search feature to quickly find any province, district, or municipality by name. The search returns detailed information and context.
5

Visualize Data

Visit the visualization page to see interactive charts showing administrative data across Nepal.

​
Making Your First API Call

1

Get All Provinces

The simplest API call returns all 7 provinces:
curl https://your-app-url/api/provinces/
Response includes province ID, name, area, website, and headquarters for each province.
2

Get Districts in a Province

Retrieve districts using either province ID or name:
curl https://your-app-url/api/districts/?province_id=3
Returns all districts within the specified province with detailed information.
3

Get Municipalities in a District

Retrieve municipalities by specifying province and district:
curl https://your-app-url/api/municipalities/?province_id=3&district_id=27
Returns municipalities with area, website, and ward information.
4

Get All Data at Once

You can retrieve all districts or municipalities without filters:
curl https://your-app-url/api/districts/
All API endpoints return JSON responses. The API supports filtering by both ID (numeric) and name (case-insensitive string matching).

​
API Documentation

For interactive API exploration and detailed schema information, visit the Swagger documentation: 
https://your-app-url/docs
The Swagger UI allows you to:
  • Test endpoints directly in your browser
  • View request/response schemas
  • See all available parameters
  • Generate code examples

​
Example Response

Here’s what a province response looks like: 
{
  "id": 3,
  "name": "Bagmati",
  "area_sq_km": "20,300",
  "website": "https://bagamatiprovince.gov.np/",
  "headquarter": "Hetauda"
}
Municipalities include ward information: 
{
  "id": 293,
  "category_id": 1,
  "name": "Kathmandu",
  "area_sq_km": "49.45",
  "website": "https://kathmandu.gov.np/",
  "wards": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32]
}

​
Next Steps

API Reference

Explore detailed API endpoint documentation

Browse Divisions

Learn about browsing provinces, districts, and municipalities

Build docs developers (and LLMs) love

Get started for freeTalk to us