ryanjmcgowan/countrydata

Provides a .net wrapper around the GeoNames Data

CountryData

Provides a .net wrapper around the GeoNames Data. Also exposes the data as per country json files.

Support is available via a Tidelift Subscription.

Contents

• Usage
• Bogus Usage
• Json Files
  • Country Codes
  • Country Information
  • Country Location Data
  • Structure
• Security contact information

NuGet packages

• https://nuget.org/packages/CountryData/
• https://nuget.org/packages/CountryData.Bogus/

The NuGets contain a static copy of all data. This data is embedded as resources inside the assembly. No network calls are done by the assembly. To get the latests version of the data do a NuGet update. There are several options to help keep a NuGet update:

• Dependabot: creates pull requests to keep dependencies secure and up-to-date.
• Using NuGet wildcards.
• Libraries.io supports subscribing to NuGet package updates.

Usage

// All country info. This is only the country metadata
// and not all locationData.
var allCountryInfo = CountryLoader.CountryInfo;
var costaRicaInfo = allCountryInfo.Single(x => x.Iso == "CR");

// Loads all location data for a specific country
var australiaData = CountryLoader.LoadAustraliaLocationData();
var name = australiaData.Name;
var state = australiaData.States.First();
var province = state.Provinces.First();
var community = province.Communities.First();
var place = community.Places.First();
var postCode = place.PostCode;
var placeName = place.Name;
var latitude = place.Location.Latitude;
var longitude = place.Location.Longitude;

^{snippet source | anchor}

Bogus Usage

var faker = new Faker<Target>()
    .RuleFor(
        property: u => u.RandomCountryName,
        setter: (f, u) => f.Country().Name())
    .RuleFor(
        property: u => u.RandomCountryCurrency,
        setter: (f, u) => f.Country().CurrencyCode())
    .RuleFor(
        property: u => u.AustralianCapital,
        setter: (f, u) => f.Country().Australia().Capital)
    .RuleFor(
        property: u => u.RandomIrelandState,
        setter: (f, u) => f.Country().Ireland().State().Name)
    .RuleFor(
        property: u => u.RandomIcelandPostCode,
        setter: (f, u) => f.Country().Iceland().PostCode());
var targetInstance = faker.Generate();

^{snippet source | anchor}

Json Files

Country Codes

List of country codes: https://raw.githubusercontent.com/SimonCropp/CountryData/master/Data/countrycodes.txt

https://raw.githubusercontent.com/SimonCropp/CountryData/master/Data/PostCodes/[CountryCode].json.txt

Country Information

https://github.com/SimonCropp/CountryData/blob/master/Data/countryInfo.json.txt

Country Location Data

For example the url for Australia (AU) is:

https://raw.githubusercontent.com/SimonCropp/CountryData/master/Data/PostCodes/AU.json.txt

Structure

The GeoNames data is structured as:

Country > State > Province > Community > Place

However many countries do not have data for every level.

Security contact information

To report a security vulnerability, use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Icon

World designed by Pedro Santos from The Noun Project.