geo-db-sdk 1.0.0

GeoDB Cities API provides comprehensive global city and region data with filtering by name, country, location, and population, supporting multiple languages and offering detailed geographic information including coordinates, elevation, and timezone data.

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!

• Filter cities by name prefix, country, location, time-zone, and even minimum population.
• Sort cities by name, country code, elevation, and population - or any combination of these.
• Get all country regions.
• Get all cities in a given region.
• Display results in multiple languages.
• RESTful API adheres to industry best-practices, including HATEOAS-style links to facilitate paging results.
• Backed by cloud-based load-balanced infrastructure for resiliency and performance!
• Data is periodically refreshed from GeoNames and WikiData.

Notes:

• Since the database is periodically updated, this may very rarely 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 includeDeleted=SINCE_YESTERDAY (or SINCE_LAST_WEEK if you're really paranoid!).

---

Useful Resources

• SDKs
  • Angular, Sample App
  • Java
  • JavaScript
• Swagger Docs
• Usage License

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install geo-db-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/geo-db-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:

Parameter	Type	Description
http_client_instance	HttpClient	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 60
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ['GET', 'PUT']
custom_header_authentication_credentials	CustomHeaderAuthenticationCredentials	The credential object for Custom Header Signature

The API client can be initialized as follows:

from geodbcitiesapi.configuration import Environment
from geodbcitiesapi.geodbcitiesapi_client import GeodbcitiesapiClient
from geodbcitiesapi.http.auth.custom_header_authentication import CustomHeaderAuthenticationCredentials

client = GeodbcitiesapiClient(
    custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(
        x_rapidapi_key='x-rapidapi-key'
    ),
    environment=Environment.PRODUCTION
)

Authorization

This API uses the following authentication schemes.

• UserSecurity (Custom Header Signature)

List of APIs

• Geo
• Locale

SDK Infrastructure

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime