JavaScript

npm install @what3words/api

const what3words,
  { fetchTransport } = require('@what3words/api');

const apiKey = '<YOUR_API_KEY>';
const config = {
  host: 'https://api.what3words.com',
  apiVersion: 'v3',
};
const transport = fetchTransport(); // or you can import 'axiosTransport' instead
const w3wService = what3words(apiKey, config, { transport });

// you can uncomment the following lines to set your api key and config after instantiation of the w3w service
// w3wService.setApiKey(apiKey);
// w3wService.setConfig(config);

npm install cross-fetch
npm install axios

import what3words, { ClientRequest, TransportResponse } from '@what3words/api';
import superagent from 'superagent';

const API_KEY = '<YOUR_API_KEY>';
const config = {}; // This will ensure we do not override the defaults

function customTransport<ResponseType>(
  request: ClientRequest
): Promise<TransportResponse<ResponseType>> {
  const {
    method,
    host,
    url,
    query = {},
    headers = {},
    body = {},
    format,
  } = request;
  return new Promise(resolve =>
    superagent[method](`${host}${url}`)
      .query({ ...query, format })
      .send(body || {})
      .set(headers)
      .end((err, res) => {
        if (err || !res)
          return resolve({
            status: err.status || 500,
            statusText: err.response.text || 'Internal Server Error',
            headers: err.headers || {},
            body: err.response.text || null,
          });
        const response: TransportResponse<ResponseType> = {
          status: res.status,
          statusText: res.text,
          headers: res.headers,
          body: res.body,
        };
        resolve(response);
      })
  );
}

const service = what3words(API_KEY, config, { transport: customTransport });
service
  .availableLanguages()
  .then(({ languages }) => console.log('Available languages', languages));

npm install -S @what3words/api axios cross-fetch

import what3words, {
  axiosTransport,
  ApiVersion
} from "@what3words/api";

const W3W_API_KEY = "<YOUR_API_KEY>"; //TODO: Add your what3words API key here

// Instantiate what3words instance
window.what3words = what3words(
    "",
    { apiVersion: ApiVersion.Version3 },
    { transport: axiosTransport() },
  );

// Configure what3words JS wrapper
window.what3words.setApiKey(W3W_API_KEY);

// Convert a coordinate to a three word address and retrieve the JSON response from our API
window.what3words
	.convertTo3wa({ 
		coordinates: { lat: 51.520847, lng: -0.195521 },
    language: 'en',
    format: 'json'
	})
	.then((response) => {
    word = response.words;
    console.log(word);
	})

// Convert a coordinate to a three word address and retrieve the GEOJSON response from our API
window.what3words
	.convertTo3wa({ 
		coordinates: { lat: 51.520847, lng: -0.195521 },
    language: 'en',
    format: 'geojson'
	})
	.then((response) => {
    console.log(response);
	})

import what3words, {
  axiosTransport,
  ApiVersion,
  W3W_REGEX,
} from "@what3words/api";

const W3W_API_KEY = "<YOUR_API_KEY>"; //TODO: Add your what3words API key here

// Instantiate what3words instance
window.what3words = what3words(
    "",
    { apiVersion: ApiVersion.Version3 },
    { transport: axiosTransport() },
  );

// Configure what3words JS wrapper
window.what3words.setApiKey(W3W_API_KEY);

const THREE_WORD_ADDRESS = "filled.count.soap";

// Retrieve coordinates for initial three word address in JSON
window.what3words
 .convertToCoordinates({ 
		words: THREE_WORD_ADDRESS,
		format: 'json' // or format: 'geojson' 
	})
 .then((res) => {
      coordinates = res.coordinates;
      console.log(coordinates);
	})

// Retrieve coordinates for initial three word address in GEOJSON
window.what3words
 .convertToCoordinates({ 
		words: THREE_WORD_ADDRESS,
		format: 'geojson' // or format: json' 
	})
 .then((res) => {
      console.log(response);
	})

import what3words, {
  axiosTransport,
  ApiVersion
} from "@what3words/api";

const W3W_API_KEY = "<YOUR_API_KEY>"; //TODO: Add your what3words API key here

// Instantiate what3words instance
window.what3words = what3words(
    "",
    { apiVersion: ApiVersion.Version3 },
    { transport: axiosTransport() },
  );

// Configure what3words JS wrapper
window.what3words.setApiKey(W3W_API_KEY);

window.what3words
	.autosuggest({
	  input: 'freshen.overlook.clo',
    language: 'en'
	})
	.then(function (response) {
  	  console.log(`suggestions for: ${response}`);
  });

import what3words, {
  axiosTransport,
  ApiVersion
} from "@what3words/api";

const W3W_API_KEY = "<YOUR_API_KEY>"; //TODO: Add your what3words API key here

// Instantiate what3words instance
window.what3words = what3words(
    "",
    { apiVersion: ApiVersion.Version3 },
    { transport: axiosTransport() },
  );

// Configure what3words JS wrapper
window.what3words.setApiKey(W3W_API_KEY);

// Call the what3words Grid API to obtain the grid squares within the current visible bounding box
window.what3words.
  .gridSection({
	  boundingBox: {
  	    southwest: {
    	      lat: sw.lat(), // replace with SouthWest Latitude coordinates
    	      lng: sw.lng() // replace with SouthWest Longitude coordinates
  	    },
  	    northeast: {
    	      lat: ne.lat(), // replace with NorthEast Latitude coordinates
    	      lng: ne.lng() // replace with NorthEast Longitude coordinates
  	    }
	   },
	format: "json"
  })
  .then(function (data) {
		console.log(data)
  })
  .catch(console.error);

import what3words, {
  axiosTransport,
  ApiVersion
} from "@what3words/api";

const W3W_API_KEY = "<YOUR_API_KEY>"; //TODO: Add your what3words API key here

// Instantiate what3words instance
window.what3words = what3words(
    "",
    { apiVersion: ApiVersion.Version3 },
    { transport: axiosTransport() },
  );

// Configure what3words JS wrapper
window.what3words.setApiKey(W3W_API_KEY)

// Retrieve and print out supported languages
window.what3words.availableLanguages().then((res) => {
  languages = res.languages;
  console.log(languages);
});

import {
  ConvertTo3waClient,
  ConvertTo3waOptions,
  FeatureCollectionResponse,
  LocationGeoJsonResponse,
  LocationJsonResponse,
} from '@what3words/api';

const API_KEY = '<YOUR_API_KEY>';
const client: ConvertTo3waClient = ConvertTo3waClient.init(API_KEY);
const options: ConvertTo3waOptions = {
  coordinates: { lat: 51.520847, lng: -0.195521 },
};

// If you want to retrieve the JSON response from our API
client
  .run({ ...options, format: 'json' }) // { format: 'json' } is the default response
  .then((res: LocationJsonResponse) => console.log('Convert to 3wa', res));

// If you want to retrieve the GeoJsonResponse from our API
client
  .run({ ...options, format: 'geojson' })
  .then((res: FeatureCollectionResponse<LocationGeoJsonResponse>) =>
    console.log('Convert to 3wa', res)
  );

import {
  ConvertToCoordinatesClient,
  ConvertToCoordinatesOptions,
  FeatureCollectionResponse,
  LocationGeoJsonResponse,
  LocationJsonResponse,
} from '@what3words/api';

const API_KEY = '<YOUR_API_KEY>';
const client: ConvertToCoordinatesClient =
  ConvertToCoordinatesClient.init(API_KEY);
const options: ConvertToCoordinatesOptions = { words: 'filled.count.soap' };

// If you want to retrieve the JSON response from our API
client
  .run({ ...options, format: 'json' }) // { format: 'json' } is the default response
  .then((res: LocationJsonResponse) =>
    console.log('Convert to coordinates', res)
  );

// If you want to retrieve the GeoJsonResponse from our API
client
  .run({ ...options, format: 'geojson' })
  .then((res: FeatureCollectionResponse<LocationGeoJsonResponse>) =>
    console.log('Convert to coordinates', res)
  );

import {
  AutosuggestClient,
  AutosuggestOptions,
  AutosuggestResponse,
} from '@what3words/api';

const API_KEY = '<YOUR_API_KEY>';
const client: AutosuggestClient = AutosuggestClient.init(API_KEY);
const options: AutosuggestOptions = {
  input: 'filled.count.s',
};
client
  .run(options)
  .then((res: AutosuggestResponse) =>
    console.log(`suggestions for "${options.input}"`, res)
  );

import {
  GridSectionClient,
  GridSectionOptions,
  FeatureCollectionResponse,
  GridSectionGeoJsonResponse,
  GridSectionJsonResponse,
} from '../src';

const API_KEY = '<YOUR_API_KEY>';
const client: GridSectionClient = GridSectionClient.init(API_KEY);
const options: GridSectionOptions = {
  boundingBox: {
    southwest: { lat: 52.208867, lng: 0.11754 },
    northeast: { lat: 52.207988, lng: 0.116126 },
  },
};

// If you want to retrieve the JSON response from our API
client
  .run({ ...options, format: 'json' }) // { format: 'json' } is the default response
  .then((res: GridSectionJsonResponse) => console.log('Grid Section', res));

// If you want to retrieve the JSON response from our API
client
  .run({ ...options, format: 'geojson' }) // { format: 'json' } is the default response
  .then((res: FeatureCollectionResponse<GridSectionGeoJsonResponse>) =>
    console.log('Grid Section', res)
  );

import {
  AvailableLanguagesClient,
  AvailableLanguagesResponse,
} from '@what3words/api';

const API_KEY = '<YOUR_API_KEY>';
const client: AvailableLanguagesClient = AvailableLanguagesClient.init(API_KEY);
client
  .run()
  .then((res: AvailableLanguagesResponse) =>
    console.log('Available Languages', res)
  );

import { AutosuggestClient } from "@what3words/api";

// Initialise the What3Words API with your API key
const API_KEY = 'YOUR_API_KEY';
const client = AutosuggestClient.init(API_KEY);

// Example what3words addresses
const addresses = ["filled.count.soap", "not a 3wa", "not.3wa address"];

// Function to check if the address is a possible what3words address
const checkPossible3wa = (address) => {
  const isPossible = client.isPossible3wa(address);
  console.log(`Is '${address}' a possible what3words address? ${isPossible}`);
};

// Check each address
addresses.forEach(checkPossible3wa);

import { AutosuggestClient } from "@what3words/api";

const API_KEY = 'YOUR_API_KEY';
const client = AutosuggestClient.init(API_KEY);

// Example addresses
const addresses = [
    "filled.count.soap",
    "filled.count.",
    "coding.is.cool"
];

// Function to check if the address is valid
const checkIsValid3wa = async (address) => {
    try {
        const isValid = await client.isValid3wa(address);
        console.log(`Is '${address}' a valid what3words address? ${isValid}`);
    } catch (error) {
        console.error(`Error validating address '${address}':`, error);
    }
};

// Check each address for validity
addresses.forEach(checkIsValid3wa);

{
    "error": {
        "code": "QuotaExceeded",
        "message": "Quota exceeded or API plan does not have access to this feature. Please change your plan at https://accounts.what3words.com/select-plan, or contact support@what3words.com"
    }
}