Docs
Skip to content
get

Get user locale

Endpoint

gethttps://<REGION>.cloud.appwrite.io/v1/locale

Description

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.

(IP Geolocation by DB-IP)

Required scopes

locale.read

Authentication

Initialize the Appwrite client with setProject() and authenticate with either a server API key (setKey()) or a signed-in user (setSession() or setJWT()). For direct REST calls, send X-Appwrite-Project with either X-Appwrite-Key or session/JWT headers.
Status
Content type
200
application/json

Locale

Name
Type
Description
string

User IP address.

string

Country code in ISO 3166-1 two-character format

string

Country name. This field support localization.

string

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.

string

Continent name. This field support localization.

boolean

True if country is part of the European Union.

string

Currency code in ISO 4217-1 three-character format

string

City

string

Name of timezone

string

Postal code

number

Latitude

number

Longitude

string

Autonomous System Number (ASN) of the IP

string

Organization that owns the ASN

string

Internet service provider of the IP

string

Connection type of the IP (e.g. cable, cellular, corporate)

string

User type classification of the IP (e.g. residential, business, hosting)

string

Registered organization of the IP

JavaScript
const sdk = require('node-appwrite');


const client = new sdk.Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>') // Your project ID
    .setSession(''); // The user session to authenticate with


const locale = new sdk.Locale(client);


const result = await locale.get();