GeoDB Cities API API Reference

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

API Endpoint
https://wft-geo-db.p.mashape.com/
Response Content-Types: application/json
Schemes: https
Version: 1.0.0

Authentication

UserSecurity

type
apiKey
name
X-Mashape-Key
in
header

Geo

Geo Endpoints

Geo

Find cities

GET /v1/geo/cities

Find cities, filtering by optional criteria. If no criteria are set, you will get back all known cities.

namePrefix: string
in query

Only cities whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language.

countryIds: string
in query

Only cities in these countries (comma-delimited country codes or WikiData ids)

excludedCountryIds: string
in query

Only cities NOT in these countries (comma-delimited country codes or WikiData ids)

minPopulation: integer (int32)
in query

Only cities having at least this population

location: string
in query

Only cities near this location. Latitude/longitude in ISO-6709 format: ±DD.DDDD±DDD.DDDD

radius: integer (int32)
in query

The location radius within which to find cities

distanceUnit: string MI
in query

The unit of distance: MI | KM

timeZoneIds: string
in query

Only cities in these time-zones

asciiMode: boolean false
in query

Display results using ASCII characters

languageCode: string
in query

Display results in this language

limit: integer (int32) 10
in query

The maximum number of results to retrieve

offset: integer (int32) 0
in query

The zero-ary offset index into the results

sort: string
in query

How to sort the results. Format: ±SORT_FIELD,±SORT_FIELD where SORT_FIELD = countryCode | elevation | name | population

includeDeleted: string NONE
in query

Whether to include any cities marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE

hateoasMode: boolean true
in query

Include HATEOAS-style links in results

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": [
    {
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "distance": "number (double)",
      "id": "integer (int32)",
      "latitude": "number (double)",
      "longitude": "number (double)",
      "region": "string",
      "regionCode": "string",
      "wikiDataId": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}
Geo

Find cities near city

GET /v1/geo/cities/{cityId}/nearbyCities

Find cities near the given origin city, filtering by optional criteria. If no criteria are set, you will get back all known cities.

cityId: string
in path

The city id (either native 'id' or 'wikiDataId')

minPopulation: integer (int32)
in query

Only cities having at least this population

radius: integer (int32)
in query

The location radius within which to find cities

distanceUnit: string MI
in query

The unit of distance: MI | KM

asciiMode: boolean false
in query

Display results using ASCII characters

languageCode: string
in query

Display results in this language

limit: integer (int32) 10
in query

The maximum number of results to retrieve

offset: integer (int32) 0
in query

The zero-ary offset index into the results

sort: string
in query

How to sort the results. Format: ±SORT_FIELD,±SORT_FIELD where SORT_FIELD = countryCode | elevation | name | population

includeDeleted: string NONE
in query

Whether to include any cities marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE

hateoasMode: boolean true
in query

Include HATEOAS-style links in results

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": [
    {
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "distance": "number (double)",
      "id": "integer (int32)",
      "latitude": "number (double)",
      "longitude": "number (double)",
      "region": "string",
      "regionCode": "string",
      "wikiDataId": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}
Geo

Find cities near location

GET /v1/geo/locations/{locationId}/nearbyCities

Find cities near the given location, filtering by optional criteria. If no criteria are set, you will get back all known cities.

locationId: string
in path

Only cities near this location. Latitude/longitude in ISO-6709 format: ±DD.DDDD±DDD.DDDD

minPopulation: integer (int32)
in query

Only cities having at least this population

radius: integer (int32)
in query

The location radius within which to find cities

distanceUnit: string MI
in query

The unit of distance: MI | KM

asciiMode: boolean false
in query

Display results using ASCII characters

languageCode: string
in query

Display results in this language

limit: integer (int32) 5
in query

The maximum number of results to retrieve

offset: integer (int32) 0
in query

The zero-ary offset index into the results

sort: string
in query

How to sort the results. Format: ±SORT_FIELD,±SORT_FIELD where SORT_FIELD = countryCode | elevation | name | population

includeDeleted: string NONE
in query

Whether to include any cities marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE

hateoasMode: boolean true
in query

Include HATEOAS-style links in results

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": [
    {
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "distance": "number (double)",
      "id": "integer (int32)",
      "latitude": "number (double)",
      "longitude": "number (double)",
      "region": "string",
      "regionCode": "string",
      "wikiDataId": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}
Geo

Get city details

GET /v1/geo/cities/{cityId}

Get the details for a specific city, including location coordinates, population, and elevation above sea-level (if available).

cityId: string
in path

The city id (either native 'id' or 'wikiDataId')

asciiMode: boolean false
in query

Display results using ASCII characters

languageCode: string
in query

Display results in this language

200 OK

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "city": "string",
    "country": "string",
    "countryCode": "string",
    "deleted": "boolean",
    "elevationMeters": "integer (int32)",
    "id": "integer (int32)",
    "latitude": "number (double)",
    "longitude": "number (double)",
    "population": "integer (int32)",
    "region": "string",
    "regionCode": "string",
    "timezone": "string",
    "wikiDataId": "string"
  },
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}
Geo

Get city distance

GET /v1/geo/cities/{cityId}/distance

Get distance to the given city

cityId: string
in path

The city id (either native 'id' or 'wikiDataId')

fromCityId: string
in query

Distance from this city

distanceUnit: string MI
in query

The unit of distance: MI | KM

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": "number (double)",
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}
Geo

Get city date-time

GET /v1/geo/cities/{cityId}/dateTime

Get city date-time

cityId: string
in path

The city id (either native 'id' or 'wikiDataId')

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": "string (date-time)",
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}
Geo

Get city time

GET /v1/geo/cities/{cityId}/time

Get city time

cityId: string
in path

The city id (either native 'id' or 'wikiDataId')

200 OK

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": "string",
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}
Geo

Find countries

GET /v1/geo/countries

Find countries, filtering by optional criteria. If no criteria are set, you will get back all known countries.

namePrefix: string
in query

Only countries whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language.

currencyCode: string
in query

Only countries supporting this currency

asciiMode: boolean false
in query

Display results using ASCII characters

languageCode: string
in query

Display results in this language

limit: integer (int32) 10
in query

The maximum number of results to retrieve

offset: integer (int32) 0
in query

The zero-ary offset index into the results

hateoasMode: boolean true
in query

Include HATEOAS-style links in results

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": [
    {
      "code": "string",
      "currencyCodes": [
        "string"
      ],
      "name": "string",
      "wikiDataId": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}
Geo

Get country details

GET /v1/geo/countries/{countryId}

Get the details for a specific country, including number of regions.

countryId: string
in path

An ISO-3166 country code or WikiData id

asciiMode: boolean false
in query

Display results using ASCII characters

languageCode: string
in query

Display results in this language

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "code": "string",
    "currencyCodes": [
      "string"
    ],
    "flagImageUri": "string",
    "name": "string",
    "numRegions": "integer (int32)",
    "wikiDataId": "string"
  },
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}
Geo

Find country regions

GET /v1/geo/countries/{countryId}/regions

Get all regions in a specific country. These could be states, provinces, districts, or otherwise major political divisions.

countryId: string
in path

An ISO-3166 country code or WikiData id

namePrefix: string
in query

Only regions whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language.

asciiMode: boolean false
in query

Display results using ASCII characters

languageCode: string
in query

Display results in this language

limit: integer (int32) 10
in query

The maximum number of results to retrieve

offset: integer (int32) 0
in query

The zero-ary offset index into the results

hateoasMode: boolean true
in query

Include HATEOAS-style links in results

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": [
    {
      "countryCode": "string",
      "fipsCode": "string",
      "isoCode": "string",
      "name": "string",
      "wikiDataId": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}
Geo

Get region details

GET /v1/geo/countries/{countryId}/regions/{regionCode}

Get the details of a specific country region, including number of cities.

countryId: string
in path

An ISO-3166 country code or WikiData id

regionCode: string
in path

An ISO-3166 or FIPS region code

asciiMode: boolean false
in query

Display results using ASCII characters

languageCode: string
in query

Display results in this language

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "capital": "string",
    "countryCode": "string",
    "fipsCode": "string",
    "isoCode": "string",
    "name": "string",
    "numCities": "integer (int32)",
    "wikiDataId": "string"
  },
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}
Geo

Find country region cities

GET /v1/geo/countries/{countryId}/regions/{regionCode}/cities

Get the cities in a specific country region. The country and region info is omitted in the response.

countryId: string
in path

An ISO-3166 country code or WikiData id

regionCode: string
in path

An ISO-3166 or FIPS region code

minPopulation: integer (int32)
in query

Only cities having at least this population

asciiMode: boolean false
in query

Display results using ASCII characters

languageCode: string
in query

Display results in this language

limit: integer (int32) 10
in query

The maximum number of results to retrieve

offset: integer (int32) 0
in query

The zero-ary offset index into the results

sort: string
in query

How to sort the results. Format: ±SORT_FIELD,±SORT_FIELD where SORT_FIELD = elevation | name | population

includeDeleted: string NONE
in query

Whether to include any cities marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE

hateoasMode: boolean true
in query

Include HATEOAS-style links in results

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": [
    {
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "distance": "number (double)",
      "id": "integer (int32)",
      "latitude": "number (double)",
      "longitude": "number (double)",
      "region": "string",
      "regionCode": "string",
      "wikiDataId": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}

Locale

Locale Endpoints

Find currencies

GET /v1/locale/currencies

Find currencies, filtering by optional criteria. If no criteria are set, you will get back all known currencies.

countryId: string
in query

Only currencies supported by this country

limit: integer (int32) 10
in query

The maximum number of results to retrieve

offset: integer (int32) 0
in query

The zero-ary offset index into the results

hateoasMode: boolean true
in query

Include HATEOAS-style links in results

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": [
    {
      "code": "string",
      "countryCodes": [
        "string"
      ]
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}

Get languages

GET /v1/locale/languages

Get all supported languages

limit: integer (int32) 5
in query

The maximum number of results to retrieve

offset: integer (int32) 0
in query

The zero-ary offset index into the results

hateoasMode: boolean true
in query

Include HATEOAS-style links in results

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": [
    {
      "code": "string",
      "name": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}

Get locales

GET /v1/locale/locales

Get all known locales

limit: integer (int32) 10
in query

The maximum number of results to retrieve

offset: integer (int32) 0
in query

The zero-ary offset index into the results

hateoasMode: boolean true
in query

Include HATEOAS-style links in results

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": [
    {
      "code": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}

Get time-zones

GET /v1/locale/timezones

Get all known time-zones

limit: integer (int32) 10
in query

The maximum number of results to retrieve

offset: integer (int32) 0
in query

The zero-ary offset index into the results

hateoasMode: boolean true
in query

Include HATEOAS-style links in results

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": [
    {
      "id": "string",
      "name": "string",
      "rawUtcOffsetHours": "integer (int32)"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}

Get time-zone date-time

GET /v1/locale/timezones/{zoneId}/dateTime

Get time-zone date-time

zoneId: string
in path

The time-zone id

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": "string (date-time)",
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Get time-zone time

GET /v1/locale/timezones/{zoneId}/time

Get time-zone time

zoneId: string
in path

The time-zone id

200 OK

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "data": "string",
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Schema Definitions

CitiesResponse: object

data: CitySummary

A list of CitySummaries

CitySummary
errors: WftError

A list of WftErrors

WftError
links: Link

A list of Links

Link
metadata: Metadata
Example
{
  "data": [
    {
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "distance": "number (double)",
      "id": "integer (int32)",
      "latitude": "number (double)",
      "longitude": "number (double)",
      "region": "string",
      "regionCode": "string",
      "wikiDataId": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}

CityDetails: object

city: string

The city name (varies by languageCode)

country: string

The country name (varies by languageCode)

countryCode: string

The ISO-3166 country code

deleted: boolean

If this city has been soft-deleted

elevationMeters: integer (int32)

The city elevation (meters) above sea level

id: integer (int32)

The city GeoDB native id

latitude: number (double)

The city latittude (-90.0 to 90.0)

longitude: number (double)

The city longitude (-180.0 to 180.0)

population: integer (int32)

The city population

region: string

The region name (varies by languageCode)

regionCode: string

The ISO or FIPS region code

timezone: string

The city timezone id

wikiDataId: string

The city WikiData id

Example
{
  "city": "string",
  "country": "string",
  "countryCode": "string",
  "deleted": "boolean",
  "elevationMeters": "integer (int32)",
  "id": "integer (int32)",
  "latitude": "number (double)",
  "longitude": "number (double)",
  "population": "integer (int32)",
  "region": "string",
  "regionCode": "string",
  "timezone": "string",
  "wikiDataId": "string"
}

CityResponse: object

data: CityDetails
errors: WftError

A list of WftErrors

WftError
Example
{
  "data": {
    "city": "string",
    "country": "string",
    "countryCode": "string",
    "deleted": "boolean",
    "elevationMeters": "integer (int32)",
    "id": "integer (int32)",
    "latitude": "number (double)",
    "longitude": "number (double)",
    "population": "integer (int32)",
    "region": "string",
    "regionCode": "string",
    "timezone": "string",
    "wikiDataId": "string"
  },
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

CitySummary: object

city: string

The city name (varies by languageCode)

country: string

The country name (varies by languageCode)

countryCode: string

The ISO-3166 country code

distance: number (double)

Included if this is the result of a distance query

id: integer (int32)

The city GeoDB native id

latitude: number (double)

The city latittude (-90.0 to 90.0)

longitude: number (double)

The city longitude (-180.0 to 180.0)

region: string

The region name (varies by languageCode)

regionCode: string

The ISO or FIPS region code

wikiDataId: string

The city WikiData id

Example
{
  "city": "string",
  "country": "string",
  "countryCode": "string",
  "distance": "number (double)",
  "id": "integer (int32)",
  "latitude": "number (double)",
  "longitude": "number (double)",
  "region": "string",
  "regionCode": "string",
  "wikiDataId": "string"
}

CountriesResponse: object

data: CountrySummary

A list of CountrySummarys

CountrySummary
errors: WftError

A list of WftErrors

WftError
links: Link

A list of Links

Link
metadata: Metadata
Example
{
  "data": [
    {
      "code": "string",
      "currencyCodes": [
        "string"
      ],
      "name": "string",
      "wikiDataId": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}

CountrySummary: object

code: string

The ISO-3166 country code

currencyCodes: string[]

A list of supported ISO-4217 currency codes

string
name: string

The country name (varies by languageCode)

wikiDataId: string

The country WikiData id

Example
{
  "code": "string",
  "currencyCodes": [
    "string"
  ],
  "name": "string",
  "wikiDataId": "string"
}

CountryDetails: object

code: string

The ISO-3166 country code

currencyCodes: string[]

A list of supported ISO-4217 currency codes

string
flagImageUri: string

The country flag image

name: string

The country name (varies by languageCode)

numRegions: integer (int32)

The number of regions in this country

wikiDataId: string

The country WikiData id

Example
{
  "code": "string",
  "currencyCodes": [
    "string"
  ],
  "flagImageUri": "string",
  "name": "string",
  "numRegions": "integer (int32)",
  "wikiDataId": "string"
}

CountryResponse: object

data: CountryDetails
errors: WftError

A list of WftErrors

WftError
Example
{
  "data": {
    "code": "string",
    "currencyCodes": [
      "string"
    ],
    "flagImageUri": "string",
    "name": "string",
    "numRegions": "integer (int32)",
    "wikiDataId": "string"
  },
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

CurrenciesResponse: object

data: CurrencyDescriptor

A list of CurrencyDescriptors

CurrencyDescriptor
errors: WftError

A list of WftErrors

WftError
links: Link

A list of Links

Link
metadata: Metadata
Example
{
  "data": [
    {
      "code": "string",
      "countryCodes": [
        "string"
      ]
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}

CurrencyDescriptor: object

code: string

A ISO-4217 currency code

countryCodes: string[]

A list of ISO-3166 country codes

string
Example
{
  "code": "string",
  "countryCodes": [
    "string"
  ]
}

DateTimeResponse: object

data: string (date-time)

The date-time in ISO-6801 format: yyyyMMdd'T'HHmmssZ

errors: WftError
WftError
Example
{
  "data": "string (date-time)",
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

DistanceResponse: object

data: number (double)

The distance in units as set by the distanceUnit param (defaults to miles)

errors: WftError
WftError
Example
{
  "data": "number (double)",
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

LanguageDescriptor: object

code: string undefined, aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu
name: string
Example
{
  "code": "string",
  "name": "string"
}

LanguagesResponse: object

Example
{
  "data": [
    {
      "code": "string",
      "name": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}

LocaleDescriptor: object

code: string

The locale code

Example
{
  "code": "string"
}

LocalesResponse: object

data: LocaleDescriptor

A list of LocalDescriptors

LocaleDescriptor
errors: WftError

A list of WftErrors

WftError
links: Link

A list of Links

Link
metadata: Metadata
Example
{
  "data": [
    {
      "code": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}

Metadata: object

currentOffset: integer (int64)

The zero-ary offset into the results (0 is the first result)

totalCount: integer (int64)

The total number of results across pages

Example
{
  "currentOffset": "integer (int64)",
  "totalCount": "integer (int64)"
}

RegionDetails: object

capital: string

The region's capital city (varies by languageCode)

countryCode: string

An ISO-3166 country code

fipsCode: string

The FIPS 10-4 region code

isoCode: string

The ISO region code

name: string

The region name (varies by languageCode)

numCities: integer (int32)

The number of cities in this region

wikiDataId: string

The region WikiData id

Example
{
  "capital": "string",
  "countryCode": "string",
  "fipsCode": "string",
  "isoCode": "string",
  "name": "string",
  "numCities": "integer (int32)",
  "wikiDataId": "string"
}

RegionResponse: object

data: RegionDetails
errors: WftError

A list of WftErrors

WftError
Example
{
  "data": {
    "capital": "string",
    "countryCode": "string",
    "fipsCode": "string",
    "isoCode": "string",
    "name": "string",
    "numCities": "integer (int32)",
    "wikiDataId": "string"
  },
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

RegionSummary: object

countryCode: string

An ISO-3166 country code

fipsCode: string

The FIPS 10-4 region code

isoCode: string

The ISO region code

name: string

The region name (varies by languageCode)

wikiDataId: string

The region WikiData id

Example
{
  "countryCode": "string",
  "fipsCode": "string",
  "isoCode": "string",
  "name": "string",
  "wikiDataId": "string"
}

RegionsResponse: object

data: RegionSummary

A list of RegionSummaries

RegionSummary
errors: WftError

A list of WftErrors

WftError
links: Link

A list of Links

Link
metadata: Metadata
Example
{
  "data": [
    {
      "countryCode": "string",
      "fipsCode": "string",
      "isoCode": "string",
      "name": "string",
      "wikiDataId": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}

TimeResponse: object

data: string

The time in ISO-8601 format: HHmmss.SSSZ

errors: WftError
WftError
Example
{
  "data": "string",
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

TimeZoneDescriptor: object

id: string

The time-zone id

name: string

The time-zone name

rawUtcOffsetHours: integer (int32)

The number of hours this time-zone is offset from UTC

Example
{
  "id": "string",
  "name": "string",
  "rawUtcOffsetHours": "integer (int32)"
}

TimeZonesResponse: object

Example
{
  "data": [
    {
      "id": "string",
      "name": "string",
      "rawUtcOffsetHours": "integer (int32)"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ],
  "metadata": {
    "currentOffset": "integer (int64)",
    "totalCount": "integer (int64)"
  }
}

WftError: object

code: WftErrorCode
message: string
Example
{
  "code": "string",
  "message": "string"
}

WftErrorCode: string

string ACCESS_DENIED, ENTITY_NOT_FOUND, INCOMPATIBLE, PARAM_INVALID, PARAMS_MUTUALLY_EXCLUSIVE