Country State City Documentation

Comprehensive documentation for the Country State City (CSC) ecosystem - your complete solution for geographical data integration.

The Country State City ecosystem is a complete geographical data solution that provides developers with:

• REST API: Access to 250+ countries, 5,299+ states/provinces, and 153,765+ cities
• Database: Ready-to-use geographical data in multiple database formats
• Tools: Export and update tools for data management
• SDKs: Official libraries for popular programming languages

This documentation covers four main areas:

• Authentication and security
• Countries, states, and cities endpoints
• SDKs and integration examples
• Request/response specifications

• Schema and data structure
• Installation guides for major databases:
  • MySQL, PostgreSQL, SQLite
  • MongoDB, SQL Server, DuckDB
• Contributing guidelines

• Update Tool: Submit data corrections and additions
• Export Tool: Download data in various formats (JSON, CSV, SQL, XML)
• Integration workflows

• Claude Code integration
• Cursor AI setup
• Windsurf configuration

• 🌍 API Portal - Get your API key
• 📚 Live Documentation - Browse the docs online
• 🔧 GitHub Repository - Source code
• 💝 Support the Project - Help us maintain the service

• Node.js 16+ installed
• npm or yarn package manager

1. Clone and install dependencies:

   git clone [repository-url]
   cd docs
   npm install

2. Install Mintlify CLI globally:

   npm install -g mint

3. Start local development server:

   npm run dev
   # or
   mint dev

4. View documentation: Open http://localhost:3000 in your browser

• npm run dev - Start local development server
• npm run build - Build documentation for production
• npm run sync-changelog - Sync changelog from API

We welcome contributions to improve the documentation! Here's how you can help:

1. Fork this repository
2. Create a feature branch (git checkout -b improve-docs)
3. Make your changes following our writing guidelines
4. Test locally with npm run dev
5. Submit a pull request

For geographical data corrections or additions, please use our Update Tool rather than direct pull requests.

This documentation follows industry-standard technical writing practices:

• Clear, direct language appropriate for technical audiences
• Second person voice ("you") for instructions
• Active voice and present tense
• Progressive disclosure from basic to advanced concepts
• Complete, runnable code examples
• Proper error handling in all examples

All documentation is built with Mintlify and uses MDX format with YAML frontmatter.

• 📧 Email: [email protected]
• 🐛 Bug Reports: GitHub Issues
• 💬 Community: Join our community discussions
• 📖 Documentation Issues: Open an issue in this repository

Documentation is automatically deployed to production when changes are pushed to the main branch via GitHub integration with Mintlify.

If needed, you can trigger a manual build:

npm run build

This documentation is released under the MIT License.

Made with ❤️ by the Country State City Team

Get your API key • View Documentation • GitHub