country_provider Flutter Plugin

GitHub last commit GitHub pull requests GitHub closed pull requests GitHub issues GitHub closed issues

Country Provider is a flutter library wrapper around the API provided by REST Countries https://restcountries.eu (Get information about countries via a RESTful API)

Download App

Getting Started

1. Add library to your pubspec.yaml


dependencies:
  country_provider: ^0.0.2

2. Import library in dart file

import 'package:country_provider/country_provider.dart';

Note

Each method return a List of Country.

Usage

Get all countries.

// Get all countries
List<Country>? countries = await CountryProvider.getAllCountries();

Search by country name. It can be the native name or partial name.

// Search by country name
List<Country>? result = await CountryProvider.getCountriesByName("Ameri");

If partial name, this method could return a list of countries. Else a List of one element.

Search by country full name.

// Search by country full name
Country result = await CountryProvider.getCountryByFullname("India")?.first;

Search by ISO 3166-1 2-letter or 3-letter country code.

// Search by list of ISO 3166-1 2-letter or 3-letter country codes
Country result = await CountryProvider.getCountryByCode("Ind")?.first;

Search by list of ISO 3166-1 2-letter or 3-letter country codes.

// Search by list of ISO 3166-1 2-letter or 3-letter country codes
List<Country>? result =await CountryProvider.getCountriesByListOfCodes(["Ind", "col", "ru"]);

Search by ISO 4217 currency code.

// Search by ISO 4217 currency code
List<Country>? result = await CountryProvider.getCountryByCurrencyCode("Inr")

Search by ISO 639-1 language code.

// Search by ISO 639-1 language code
List<Country>? result = await CountryProvider.getCountriesByLanguageCode(["Hin","en",]);

Search by capital city.

// Search by capital city
var result = await CountryProvider.getCountryByCapitalCity("Delhi");

You can use var instead of explicit types. I use explicit types to show you the return type of each method.

Search by calling code.

// Search by calling code
List<Country>? result = await CountryProvider.getCountryByCallingCode(91);

Search by continent: Africa, Americas, Asia, Europe, Oceania.

//  Search by continent: Africa, Americas, Asia, Europe, Oceania
List<Country>? result = await CountryProvider.getcountryByRegionalBloc("Asia");

Search by regional bloc: EU, EFTA, CARICOM, AU, USAN, EEU, AL, ASEAN , CAIS, CEFTA , NAFTA , SAARC.

//  Search by regional bloc
List<Country>? result = await CountryProvider.getCountriesByContinent("ASEAN");

EU (European Union), EFTA (European Free Trade Association), CARICOM (Caribbean Community), PA (Pacific Alliance), AU (African Union), USAN (Union of South American Nations), EEU (Eurasian Economic Union), AL (Arab League), ASEAN (Association of Southeast Asian Nations), CAIS (Central American Integration System), CEFTA (Central European Free Trade Agreement), NAFTA (North American Free Trade Agreement), SAARC (South Asian Association for Regional Cooperation).

Apply filters

To get filtered country data pass CountryFilter model as argument in search countries method.

// Get all countries name only 
var countries = await CountryProvider.getAllCountries(filter: CountryFilter(isName: true));
List<String> countriesInSpanish = countries.map((e) => e.name).toList();

// Get all countries name only in Spanish
var countries = await CountryProvider.getAllCountries(filter: CountryFilter(isName: true));
List<String> countriesInSpanish = countries.map((e) => e.translations.es).toList();

// Get Europe countries in French language
var europeCountries = await CountryProvider.getcountryByRegionalBloc("Europe",filter: CountryFilter(isName: true));
List<String> europeCountriesInFrench = europeCountries.map((e) => e.translations.?fr).toList();

// Get all countries name with their capital city only
var countries = await CountryProvider.getAllCountries(filter: CountryFilter(isName: true,isCapital:true));

// Get all countries name with country code and their capital city only
var countries = await CountryProvider.getAllCountries(filter: CountryFilter(isName: true,isCapital:true,isAlpha2Code:true,isAlpha3Code: true));


// Feel free to aplly filters 🤓

Default language for country name is English, but you can also get the name in other languages such as: de(German language), es(Spanish language), fr(French language), ja(Japanese language), it(Italian language), br(Breton language), pt(Portuguese language), nl(Dutch language), hr(Croatian language) and fa(Persian language).

Country class

class Country
{	  
    // Get Country name
    String? name;

    // Gets  Top Level Domain
    List<String>? topLevelDomain;
    
    // Gets Alpha2 Code
    String? alpha2Code;
    
    // Gets Alpha3 Code
    String? alpha3Code;
    
    // Gets Calling Code
    List<String>? callingCodes;
    
    // Gets Capital City
    String? capital;
    
    // Get Alt Spelling
    List<String>? altSpellings;
    
    // Get Region
    String? region;
    
    // Get Sub region
    String? subregion;
    
    // Get Population
    int? population;
    
    // Get Latlng(Latitude and Longitude)
    List<double>? latlng;
    
    // Get Demonym
    String? demonym;
    
    // Get Area
    double? area;
    
    // Get Gini
    double? gini;
    
    // Get Timezone
    List<String>? timezones;
    
    // Get Borders
    List<String>? borders;
    
    // Get Native Name
    String? nativeName;
    
    // Get Numeric Code
    String? numericCode;
    
    // Get Currencies
    List<Currency>? currencies;
    
     // Get Languages
    List<Language>? languages;
    
    // Gets Translations
    Translations? translations;
    
    // Get Flag
    String? flag;
    
    // Get Regional Blocs
    List<RegionalBloc>? regionalBlocs;
    
    // Get  Cioc(International Olympic Committee Code)
    String ?cioc;
}

CountryFilter Class

class CountryFilter{
  bool isName;
  bool isCapital;
  bool isRegion;
  bool isAlpha2Code;
  bool isAlpha3Code;
  bool isDemonym;
  bool isTimeZone;
  bool isCallingCode;
  bool isBorders;
  bool isAltSpellings;
  bool isCurrency;
  bool isLanguage;
  bool isLatLong;
  bool isTranslation;
  bool isFlag;

  CountryFilter({
    this.isName = false,
    this.isCapital = false,
    this.isRegion = false,
    this.isAlpha2Code = false,
    this.isAlpha3Code = false,
    this.isDemonym = false,
    this.isTimeZone = false,
    this.isCallingCode = false,
    this.isBorders = false,
    this.isAltSpellings = false,
    this.isCurrency = false,
    this.isLanguage = false,
    this.isLatLong = false,
    this.isTranslation = false,
    this.isFlag = false,
  });
}