Get User Locale

v1.0.0

Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.

()

Output

{
  "type": "object",
  "description": "Locale",
  "required": [
    "continent",
    "continentCode",
    "country",
    "countryCode",
    "currency",
    "eu",
    "ip"
  ],
  "properties": {
    "continent": {
      "type": "string",
      "description": "Continent name. This field support localization."
    },
    "continentCode": {
      "type": "string",
      "description": "Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America."
    },
    "country": {
      "type": "string",
      "description": "Country name. This field support localization."
    },
    "countryCode": {
      "type": "string",
      "description": "Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format"
    },
    "currency": {
      "type": "string",
      "description": "Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format"
    },
    "eu": {
      "type": "boolean",
      "description": "True if country is part of the Europian Union."
    },
    "ip": {
      "type": "string",
      "description": "User IP address."
    }
  }
}