The Locale service allows you to customize your app based on your users' location. Using this service, you can get your users' location, IP address, list of countries and continents names, phone codes, currencies, and more. Country codes returned follow the ISO 3166-1 standard.
The user service supports multiple locales. This feature allows you to fetch countries and continents information in your app language. To switch locales, all you need to do is pass the 'X-Appwrite-Locale' header or set the 'setLocale' method using any of our available SDKs. View here the list of available locales.
https://cloud.appwrite.io/v1
Get user locale
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.
Response
200
GET /locale
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://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();
GET /locale/codes
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://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.listCodes();
List continents
List of all continents. You can use the locale header to get the data in a supported language.
Response
200
GET /locale/continents
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://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.listContinents();
List countries
List of all countries. You can use the locale header to get the data in a supported language.
Response
200
GET /locale/countries
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://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.listCountries();
List EU countries
List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.
Response
200
GET /locale/countries/eu
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://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.listCountriesEU();
List countries phone codes
List of all countries phone codes. You can use the locale header to get the data in a supported language.
Response
200
GET /locale/countries/phones
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://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.listCountriesPhones();
List currencies
List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.
Response
200
GET /locale/currencies
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://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.listCurrencies();
List languages
List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.
Response
200
GET /locale/languages
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://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.listLanguages();