GeoDB-SDK 1.0.0

Getting Started with GeoDB Cities API

Introduction

The GeoDB API focuses on getting global city and region data. Easily obtain country, region, and city data for use in your apps!

<ul> <li>Filter cities by name prefix, country, location, time-zone, and even minimum population.</li> <li>Sort cities by name, country code, elevation, and population - or any combination of these.</li> <li>Get all country regions.</li> <li>Get all cities in a given region.</li> <li> Display results in multiple languages.</li> <li>RESTful API adheres to industry best-practices, including HATEOAS-style links to facilitate paging results. </li> <li>Backed by cloud-based load-balanced infrastructure for resiliency and performance!</li> <li>Data is periodically refreshed from GeoNames and WikiData.</li> </ul> <p>Notes: <ul> <li> Since the database is periodically updated, this may <strong>very rarely</strong> result in certain cities being marked deleted (e.g., duplicates removed). By default, endpoints returning city data will exclude cities marked deleted. However, in the unlikely event that this occurs while your app is paging through a set of affected results - and you care about the paged results suddenly changing underneath - specify <tt>includeDeleted=SINCE_YESTERDAY</tt> (or <tt>SINCE_LAST_WEEK</tt> if you're really paranoid!). </li> </ul> <hr/> <h3>Useful Resources</h3> <ul> <li> SDKs <ul> <li> <a href='https://www.npmjs.com/package/wft-geodb-angular-client'>Angular</a>, <a href='https://github.com/wirefreethought/geodb-sample-angular-app'>Sample App</a> </li> <li><a href='https://github.com/wirefreethought/geodb-java-client'>Java</a></li> <li><a href='https://www.npmjs.com/package/wft-geodb-js-client'>JavaScript</a></li> </ul> <li><a href='swagger.json'>Swagger Docs</a></li> <li><a href='http://creativecommons.org/licenses/by/3.0/'>Usage License</a></li> </li>
</ul>

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package GeoDB-SDK --version 1.0.0

You can also view the package at: https://www.nuget.org/packages/GeoDB-SDK/1.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

using GeoDBCitiesAPI.Standard;
using GeoDBCitiesAPI.Standard.Authentication;

GeoDBCitiesAPIClient client = new GeoDBCitiesAPIClient.Builder()
    .CustomHeaderAuthenticationCredentials(
        new CustomHeaderAuthenticationModel.Builder(
            "x-rapidapi-key"
        )
        .Build())
    .Build();

Authorization

This API uses the following authentication schemes.

• UserSecurity (Custom Header Signature)

List of APIs

• Geo
• Locale

SDK Infrastructure

Configuration

• HttpClientConfiguration
• HttpClientConfigurationBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter