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!

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

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 | | --- | --- | --- | | timeout | number | Timeout for API calls.Default: 0 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | customHeaderAuthenticationCredentials | CustomHeaderAuthenticationCredentials | The credential object for customHeaderAuthentication |

The API client can be initialized as follows:

import { Client } from 'geo-db-sdk';

const client = new Client({
  customHeaderAuthenticationCredentials: {
    'x-rapidapi-key': 'x-rapidapi-key'
  },
  timeout: 0,
});

Authorization

This API uses the following authentication schemes.

• UserSecurity (Custom Header Signature)

List of APIs

• Geo
• Locale

SDK Infrastructure

Configuration

• HttpClientOptions
• RetryConfiguration
• ProxySettings

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError