Countries

URL Path

https://data.api.xweather.com/countries/

Data Coverage

Global

Update Interval

Variable

Time Range

N/A

The countries dataset provides the core data for countries, returning the full name, abbreviations, capital, population area, and neighboring countries.

Requests

Every request to the endpoint must include one of the supported actions in the url.

https://data.api.xweather.com/countries/{action}?client_id={client_id}&client_secret={client_secret}&{params}

Supported Actions

The following actions are supported with the /countries endpoint:

Action	Description
:id	Type: stringTypically used for passing a geographical location name or identifier such as city name, lat/long, or even US and Canadian postal codes. Learn more.
search	Type: stringA generalized action that is determined with the endpoints query parameters. Learn more.

Response

The following is an example of what each object in the response will consist of. Depending on your requested action, the response may contain multiple instances of this object within an array.

Properties

place (object)

Object containing place information.

place.name (string)

The country name

place.iso (string)

The two letter ISO 3166-1 alpha-2 code

place.iso3 (string)

The three letter ISO 3166-1 alpha-3 code

place.isoNum (string)

The three digit ISO 3166-1 numeric code

place.fips (string)

The three digit FIPS 10-4 code

place.continent (string)

The continent abbreviation that the country primarily resides.

place.continentFull (string)

The full continent name that the country primarily resides.

profile (object)

Object containing profile information.

profile.capital (string)

The capital city of the country.

profile.areaKM (number)

The approximate area in square kilometers. NOTE: Area values are not guaranteed to be accurate and are for general use in limiting results.

profile.areaMI (number)

The approximate area in square miles. NOTE: Area values are not guaranteed to be accurate and are for general use in limiting results.

profile.pop (number)

The approximate population of the country. NOTE: Population values are not guaranteed to be accurate and are for general use in limiting results

profile.neighbors (array)

An array of 2-letter ISO abbreviations for the neighboring countries.

{
  "place": {
    "name": "united states",
    "iso": "us",
    "iso3": "usa",
    "isoNum": "840",
    "fips": "us",
    "continent": "na",
    "continentFull": "north america"
  },
  "profile": {
    "capital": "washington",
    "areaKM": 9629091,
    "areaMI": 5983239.75,
    "pop": 310232863,
    "neighbors": [
      "ca",
      "mx",
      "cu"
    ]
  }
}

Endpoints