🗺️ Planner APIs Documentation

APIs for fetching city, region, and country ranking data to support planning and insights. Click an API below to view details, parameters, and examples.

City Rank API GET

Endpoint: /api/planner/city-rank

Description: Fetch city ranking data based on metrics like population, economy, culture, and infrastructure.

Query Parameters:

Parameter	Type	Description
`city`	string (optional)	Name of the city. If omitted, returns all cities.
`metric`	string (optional)	Filter by metric: "economy", "culture", "infrastructure"
`date`	string (optional)	Specific date for ranking snapshot

Example Response:

{
  "city": "Jaunpur",
  "rank": 12,
  "metrics": {
    "economy": 8,
    "culture": 5,
    "infrastructure": 15
  }
}

Region Rank API GET

Endpoint: /api/planner/region-rank

Description: Fetch rank data for a specific region based on aggregated city metrics.

Query Parameters:

Parameter	Type	Description
`region`	string (required)	Name of the region

Example Response:

{
  "region": "Awadh",
  "rank": 3,
  "cities": ["Lucknow", "Faizabad", "Jaunpur"]
}

Country Rank API GET

Endpoint: /api/planner/country-rank

Description: Fetch country-level ranking data based on region and city performance metrics.

Query Parameters:

Parameter	Type	Description
`country`	string (required)	Name of the country
`metric`	string (optional)	Filter by metric

Example Response:

{
  "country": "India",
  "rank": 1,
  "top_regions": ["Awadh", "Mughalpur", "Bengal"]
}