Getting started

Our public API allows you to use this site's conversion service in your own software. Getting started is easy:

  1. Sign up for an account here.
  2. Sign in.
  3. Visit your Account page.
  4. Note your API key.
  5. Start using our API!

How it works

Our API is RESTful and works from simple URLs. You provide one kind of coordinate:

Your app 55.417713
-120.130005
API

Our API returns the equivalent street address, UTM coordinates, LSD and NTS addresses (where applicable):

Your app 55.417713
-120.130005

Address One Island Lake Rd,
Tupper, BC, Canada
UTM 10N 681650E 6145023N
LSD 1-19-74-14 W6
NTS A 1-J / 093 P 08
API


Examples

Converting a location

Each request includes your API key, the kind of coordinates you are submitting (NTS, LSD, UTM, UWI or Latitude Longitude), and the location itself.

Request

https://www.lsdfinder.com/api/v1/yoursecretapikey/lsd/14-22-25-2 W5

The API will return a JSON object containing an array of a single query/response object. In this example, you'll notice that the response object includes all available coordinate system equivalents:

Response

[
  {
    "query": "14-22-25-2 W5",
    "response": {
      "status": "ok",
      "err": [],
      "lat": 51.152259,
      "lng": -114.202199,
      "country": "Canada",
      "province": "AB",
      "city": "Calgary",
      "street": "49 Royal Vista Drive NW",
      "street_prox": 78,
      "address": "49 Royal Vista Drive NW, Calgary, AB",
      "lsd": "14-22-25-2 W5",
      "lsd_border": [
        [
          51.150459,
          -114.199327
        ],
        [
          51.150447,
          -114.205067
        ],
        [
          51.154059,
          -114.205071
        ],
        [
          51.154072,
          -114.199332
        ],
        [
          51.150459,
          -114.199327
        ]
      ],
      "uwi": "",
      "nts": "",
      "nts_border": [],
      "utm": "11N 695661E 5670479N",
      "utm_v": "Zone 11, 695661 meters easting, 5670479 meters northing (Northern Hemisphere)"
    }
  }
]
PropertyValue
statusIf the API can successfully return at least one equivalent address, the status will be "ok", otherwise it will be "fail". (Failed queries are not charged a lookup.)
errIf the API encountered any errors in attempting to process the query, they will be listed in this array.
latitudeThe latitude in decimal degrees.
longitudeThe longitude in decimal degrees.
countryThe country of the location. Currently, the API supports Canada and USA.
provinceThe province or state of the location.
cityThe city or town of the location (if applicable).
streetThe street address of the location (if applicable).
street_proxThe proximity (or distance) in meters from the latitude longitude location to the street address.
lsdThe LSD address of the location. Alberta, Saskatchewan or a small part of BC.
lsd_borderAn array describing a closed polygon of the corners of the LSD rectangle (in latitude, longitude format).
ntsThe NTS BC grid address of the location.
nts_borderAn array describing a closed polygon of the NTS quarter rectangle (in latitude, longitude format).
uwiThe UWI (unique well identifier) of the location. Support for BC (BC NTS grid format), Alberta and Saskatchewan (LSD format).
utmThe universal transverse mercator location. Supported globally.
utm_vA verbose format of the universal transverse mercator location. Supported globally.

Converting multiple locations

To convert multiple locations in a single request, just separate them with a pipe ( | ) symbol:

https://www.lsdfinder.com/api/v1/yoursecretapikey/lsd/6-19-89-9 W4|6-33-36-18 W2|14-29-73-14 W6
		

The API will return a JSON object containing an array of three query/response objects:

[
  {
    "query": "6-19-89-9 W4",
    "response": {
      "status": "ok",
      "err": [],
      "lat": 56.731574,
      "lng": -111.430673,
      "country": "Canada",
      "province": "AB",
      "city": "Fort McMurray",
      "street": "105 400 Silin Forest Road",
      "street_prox": 12,
      "address": "105 400 Silin Forest Road, Fort McMurray, AB",
      "lsd": "6-19-89-9 W4",
      "lsd_border": [
        [
          56.729772,
          -111.427397
        ],
        [
          56.729771,
          -111.433959
        ],
        [
          56.733379,
          -111.433949
        ],
        [
          56.733375,
          -111.427386
        ],
        [
          56.729772,
          -111.427397
        ]
      ],
      "uwi": "",
      "nts": "",
      "nts_border": [],
      "utm": "12S 473650E 16287589N",
      "utm_v": "Zone 12, 473650 meters easting, 16287589 meters northing (Southern Hemisphere)"
    }
  },
  {
    "query": "6-33-36-18 W2",
    "response": {
      "status": "ok",
      "err": [],
      "lat": 52.134843,
      "lng": -104.521216,
      "country": "Canada",
      "province": "SK",
      "city": "Watson",
      "street": "6 Ave",
      "street_prox": 129,
      "address": "6 Ave, Watson, SK",
      "lsd": "6-33-36-18 W2",
      "lsd_border": [
        [
          52.133034,
          -104.518271
        ],
        [
          52.133035,
          -104.52415
        ],
        [
          52.136652,
          -104.52416
        ],
        [
          52.136652,
          -104.523736
        ],
        [
          52.136651,
          -104.523198
        ],
        [
          52.13665,
          -104.518282
        ],
        [
          52.133034,
          -104.518271
        ]
      ],
      "uwi": "",
      "nts": "",
      "nts_border": [],
      "utm": "13S 532770E 15776144N",
      "utm_v": "Zone 13, 532770 meters easting, 15776144 meters northing (Southern Hemisphere)"
    }
  },
  {
    "query": "14-29-73-14 W6",
    "response": {
      "status": "ok",
      "err": [],
      "lat": 55.357797,
      "lng": -120.118531,
      "country": "Canada",
      "province": "BC",
      "city": "Kelly Lake",
      "street": "*Near* 52 HWY (0.7 km ENE)",
      "street_prox": 720,
      "address": "*Near* 52 HWY (0.7 km ENE), Kelly Lake, BC",
      "lsd": "14-29-73-14 W6",
      "lsd_border": [
        [
          55.359603,
          -120.115375
        ],
        [
          55.355989,
          -120.115375
        ],
        [
          55.355987,
          -120.121667
        ],
        [
          55.3596,
          -120.121706
        ],
        [
          55.359603,
          -120.115375
        ]
      ],
      "uwi": "",
      "nts": "",
      "nts_border": [],
      "utm": "10S 682652E 16138388N",
      "utm_v": "Zone 10, 682652 meters easting, 16138388 meters northing (Southern Hemisphere)"
    }
  }
]

Checking subscription status

https://www.lsdfinder.com/api/v1/yoursecretapikey/quota

The API will return a JSON object displaying the remaining days and lookups in your subscription:

{
  "ymd": "2013-10-4",
  "ip": "127.0.0.1",
  "days_remaining": 29,
  "kind": "api",
  "account": "youraccount",
  "api_user": 68574,
  "expiry": "2013-11-02T22:30:39.253Z",
  "lookups": 1845
}

Example requests

CURL

curl https://www.lsdfinder.com/api/v1/test/latlng/55.417713,-120.130005

PHP

file_get_contents("https://www.lsdfinder.com/api/v1/test/latlng/55.417713,-120.130005");

RUBY

Net::HTTP.get_response("https://www.lsdfinder.com/api/v1/test/latlng/55.417713,-120.130005"","")


Additional examples

https://www.lsdfinder.com/api/v1/yoursecretapikey/lsd/1-6-67-13 W4

https://www.lsdfinder.com/api/v1/yoursecretapikey/nts/D 62-L %2F 092 I 15 Encode special characters (e.g., forward slash as %2F)

https://www.lsdfinder.com/api/v1/yoursecretapikey/uwi/158 10-28-35-17 W2 00

https://www.lsdfinder.com/api/v1/yoursecretapikey/utm/14N 630591E 5535227N

https://www.lsdfinder.com/api/v1/yoursecretapikey/latlng/40.722391 -73.987362

latlng Latitude, Longitude. The most common geographic coordinates used by GPS navigation systems, used globally. Details.

lsd LSD. Also known as legal subdivision coordinates, Dominion Land Survey (DLS) or Alberta Township System — commonly used in Alberta and Saskatchewan for oil and gas and surveying applications. Details.

nts NTS BC grid system. NTS BC grid is a coordinate system used in the province of British Columbia that extends NTS (National Topographic System) to provide additional precision. Details.

uwi UWI. UWI, or unique well identifier, is a 16-character code used to define well locations in BC, Alberta and Saskatchewan. In BC, the UWI is based on the NTS BC grid system. In Alberta and Saskatchewan, it uses Dominion Land Survey. Details.

utm UTM. Universal Transverse Mercator coordinate system is used globally for geographic applications. Details.