Skip to content

The most comprehensive address data package for Turkey! 81 provinces, 973 districts, 870+ neighborhoods, and 245+ streets. With TypeScript support!

Notifications You must be signed in to change notification settings

halilertekin/turkey_province_image

Repository files navigation

πŸ‡ΉπŸ‡· Turkey Province Image & Data

The most comprehensive address data package for Turkey! 81 provinces, 973 districts, 870+ neighborhoods, and 245+ streets. With TypeScript support!

npm version TypeScript License: ISC

πŸ‡¬πŸ‡§ English | πŸ‡ΉπŸ‡· TΓΌrkΓ§e

πŸ“Š Data Statistics

  • πŸ‡ΉπŸ‡· 81 Provinces - Complete Turkey
  • 🏘️ 973 Districts - Complete List
  • 🏠 32,000+ Neighborhoods - Complete Turkey (New!)
  • πŸ›£οΈ 245+ Streets - Famous streets
  • πŸ–ΌοΈ 81 Province Images - Visual content

πŸ“¦ Installation

npm install turkey_province_image

πŸš€ Quick Start

const turkeyData = require('turkey_province_image');

// Get all provinces (81)
const cities = turkeyData.getAllCities();

// Get Istanbul's districts (39)
const districts = turkeyData.getDistrictsByCity('34');

// Get neighborhoods
const neighborhoods = turkeyData.getNeighborhoodsByDistrict('0607');

// Search
const results = turkeyData.searchCities('ANKARA');

πŸ“š TypeScript Support

import turkeyData, { City, District, Neighborhood, Street } from 'turkey_province_image';

const city: City | undefined = turkeyData.getCityByCode('34');
const districts: District[] = turkeyData.getDistrictsByCity('34');

πŸ“‹ Features

  • βœ… 81 Provinces - Complete Turkey
  • βœ… 973 Districts - Official list
  • βœ… 32,000+ Neighborhoods - Complete Turkey
  • βœ… 245+ Streets - Famous streets
  • βœ… TypeScript Support - Full type safety
  • βœ… 7 Geographic Regions - Regional filtering
  • βœ… 24 API Methods - CRUD + Search
  • βœ… Hierarchical Data - Province β†’ District β†’ Neighborhood β†’ Street

πŸ—‚οΈ Data Coverage

Neighborhoods (32,000+):

  • Complete list of neighborhoods for all 81 provinces and 973 districts.
  • Updated from open data sources (2024/2025).

Streets (245+):

  • Istanbul: 45 | Ankara: 35 | Izmir: 35
  • Other major cities: 130+ streets

πŸ”§ API Methods (24)

Province Methods

getAllCities()                    // Get all provinces (81)
getCityByCode(code)              // Get by plate code
getCityByName(name)              // Get by name
getCitiesByRegion(region)        // Get by region
searchCities(query)              // Search provinces

District Methods

getAllDistricts()                // Get all districts (973)
getDistrictsByCity(cityCode)     // Get by province
getDistrictByCode(districtCode)  // Get by code
searchDistricts(query)           // Search districts

Neighborhood & Street Methods

getAllNeighborhoods()            // All neighborhoods
getNeighborhoodsByCity(code)     // By province
getNeighborhoodsByDistrict(code) // By district
searchNeighborhoods(query)       // Search

getAllStreets()                  // All streets
getStreetsByCity(code)           // By province
getStreetsByDistrict(code)       // By district
searchStreets(query)             // Search

πŸ’‘ Usage Examples

Example 1: Get Complete Hierarchy

const istanbul = turkeyData.getCityByCode('34');
const districts = turkeyData.getDistrictsByCity('34');
const neighborhoods = turkeyData.getNeighborhoodsByCity('34');

console.log(`${istanbul.cityName}: ${districts.length} districts, ${neighborhoods.length} neighborhoods`);
// Output: Δ°STANBUL: 39 districts, 219 neighborhoods

Example 2: Regional Analysis

const marmaraCities = turkeyData.getCitiesByRegion('Marmara');
console.log(`Marmara Region: ${marmaraCities.length} provinces`);
// Output: Marmara Region: 11 provinces

Example 3: Search

const merkezDistricts = turkeyData.searchDistricts('MERKEZ');
console.log(`Districts named MERKEZ: ${merkezDistricts.length}`);

const ataturkStreets = turkeyData.searchStreets('ATATÜRK');
console.log(`Ataturk streets: ${ataturkStreets.length}`);

πŸ“ Updates

v3.3.0 (2025-12-15) πŸŽ‰

  • ✨ 32,000+ Neighborhoods - Complete neighborhood data for all of Turkey added!
  • πŸ”„ Data Source Update - Switched to GitHub-based open data for easier updates.
  • ✨ 245+ Streets - Complete street data
  • 🌍 English README - Default language
  • πŸ‡ΉπŸ‡· Turkish README - Available as README.tr.md

Previous Versions

  • v3.2.0: Neighborhood & street expansion
  • v3.1.0: 973 districts added
  • v3.0.0: TypeScript support
  • v2.0.0: Geographic regions
  • v1.0.0: Initial release

πŸ—‚οΈ Data Sources

🀝 Contributing

Contributions are welcome! Check CONTRIBUTING.md for guidelines.

Needed:

  • Adding all neighborhoods (50,000+ total in Turkey)
  • Expanding street data
  • Coordinate information (lat/lng)
  • Population data

πŸ‘€ Author

Halil Ertekin

πŸ“„ License

ISC

⭐ Support

If you like the project, don't forget to star it!


Made with ❀️ in Turkey πŸ‡ΉπŸ‡·

About

The most comprehensive address data package for Turkey! 81 provinces, 973 districts, 870+ neighborhoods, and 245+ streets. With TypeScript support!

Topics

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published