countries-api-json
v1.0.4
Published
A comprehensive package providing detailed information about countries in a structured JSON format.
Maintainers
Readme
countries-api-json
A comprehensive list of countries and their details in JSON format. Useful for applications that need country data for various purposes such as dropdowns, validations, etc.
Installation
To install this package, run:
```bash npm install countries-api-json ```
Usage
Here is a basic example of how to use this package:
```javascript const countries = require('countries-api-json');
// Example usage console.log(countries); // Prints the entire list of countries
// Accessing specific country details const zambia = countries.find(country => country.code === 'ZM'); console.log(zambia); // { name: 'Zambia', code: 'ZM', dial_code: '+260', flag: '🇿🇲', flag_url: 'https://flagcdn.com/w40/zm.png' }
// Using flag_url (works on all platforms including Windows) console.log(zambia.flag_url); // https://flagcdn.com/w40/zm.png ```
API
The package exports a JSON array of country objects. Each country object contains the following properties:
- `name` (String): The name of the country.
- `code` (String): The ISO 3166-1 alpha-2 code of the country.
- `dial_code` (String): The international dialing code of the country.
- `flag` (String): The flag emoji of the country.
- `flag_url` (String): The flag image URL of the country (works on all platforms including Windows).
Example Country Object
```json { "name": "Zambia", "code": "ZM", "dial_code": "+260", "flag": "🇿🇲", "flag_url": "https://flagcdn.com/w40/zm.png" } ```
Contributing
Contributions are welcome! Please open an issue or submit a pull request for any bugs or features.
- Fork the repository
- Create a new branch (`git checkout -b feature-branch`)
- Commit your changes (`git commit -am 'Add some feature'`)
- Push to the branch (`git push origin feature-branch`)
- Open a pull request
License
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgements
- Thank you to everyone who has contributed to this project.
