Convert To Address

GET

https://api.woosmap.com/what3words/convert-to-address

This function converts a 3 word address to a list of address. It will return at most the 5 closest addresses to the what3words provided.

Rate limit: 20/1s

Ratelimit: 20/1s

Authorization

key

apiKey query

Public key of the project usually starts with woos-

private_key

apiKey query

Private key with or without write permission.

X-Api-Key

apiKey header

Private key with or without write permission.

Query Parameters

words

string required

A 3 word address as a string. It must be three words separated with dots or a japanese middle dot character (・). Words separated by spaces will be rejected. Optionally, the 3 word address can be prefixed with /// (which would be encoded as %2F%2F%2F)

Example: couch.spotted.amended

language

string Defaults to en

A supported address language as an ISO 639-1 2 letter code.

Response

200 application/json

Successful Response

results

object[] required

Results

Show 5 propertiesHide 5 properties

results. types

string[] required

Address Types

results. formatted_address

string required

Human readable address

results. public_id

string required

Public ID of the POI

results. status

string

Address Status

results. sub_buildings

array

list of specific addresses at that location

Errors

401

Unable to locate credentials.

application/json

detail

string required

402

Out of free quota.

application/json

detail

string required

403

Credentials found, but not matching.

application/json

detail

string required

422

Validation Error

application/json

detail

object[]

Show 3 propertiesHide 3 properties

detail. loc

any[] required

detail. msg

string required

detail. type

string required

429

Rate limit reached

application/json

details

string required

            curl -L -X GET 'https://api.woosmap.com/what3words/convert-to-address?words=couch.spotted.amended&key=YOUR_PUBLIC_API_KEY' \
-H 'Referer: http://localhost'

            import requests

url = "https://api.woosmap.com/what3words/convert-to-address?words=couch.spotted.amended&key=YOUR_PUBLIC_API_KEY"

payload={}
headers = {
    'Referer': 'http://localhost'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

            var requestOptions = {
  method: 'GET',
  redirect: 'follow'
};

fetch("https://api.woosmap.com/what3words/convert-to-address?words=couch.spotted.amended&key=YOUR_PUBLIC_API_KEY", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

            {
  "results": [
    {
      "description": "Radway House, Alfred Road, London, W2 5ER",
      "public_id": "",
      "sub_buildings": [
        {
          "description": "Flat 1, Radway House, Alfred Road, London, W2 5ER",
          "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ=="
        },
        {
          "description": "Flat 2, Radway House, Alfred Road, London, W2 5ER",
          "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fbTRoZVpxYkhBYVVXSytqek04UGtGQ1VLTVI0PQ=="
        }
      ],
      "types": [
        "address"
      ]
    },
    {
      "description": "Astley House, Alfred Road, London, W2 5EX",
      "public_id": "",
      "status": "not_yet_built",
      "sub_buildings": [
        {
          "description": "Flat 1, Astley House, Alfred Road, London, W2 5EX",
          "public_id": "N3VCclhUODduWjJxd2NCSUdFclJ6SnRseGxrPV9fSTBKM1YxOFBBWEJjRVNKb1J0T3hNTFNiLzhFPQ=="
        },
        {
          "description": "Flat 2, Astley House, Alfred Road, London, W2 5EX",
          "public_id": "N3VCclhUODduWjJxd2NCSUdFclJ6SnRseGxrPV9fN3VCclhUODduWjJxd2NCSUdFclJ6SnRseGxrPQ=="
        }
      ],
      "types": [
        "address"
      ]
    },
    {
      "description": "65 Alfred Road, London, W2 5EU",
      "public_id": "",
      "sub_buildings": [
        {
          "description": "Blaiz Ltd, 65 Alfred Road, London, W2 5EU",
          "public_id": "MUVBZWttTlo4OUYxL2dQWmJteDdFV2VidmVvPV9fMUVBZWttTlo4OUYxL2dQWmJteDdFV2VidmVvPQ=="
        },
        {
          "description": "Carnot Ltd, 65 Alfred Road, London, W2 5EU",
          "public_id": "MUVBZWttTlo4OUYxL2dQWmJteDdFV2VidmVvPV9fRDRPb0VLd0UvNEZYMlpLR21EMC9xRGQvMUZJPQ=="
        }
      ],
      "types": [
        "address"
      ]
    }
  ]
}

    