Skip to content
BC Government LogoBC Address Geocoder

Find the occupant nearest to a point

GET
/occupants/nearest
curl --request GET \
  --url 'https://geocoder.api.gov.bc.ca/occupants/nearest?minDegree=2&maxDegree=100&point=-122.377%2C50.121&bbox=-119.51%2C49.48%2C-119.53%2C49.50&excludeUnits=false&onlyCivic=false&callback=jsonp&outputSRS=4326&asAttachment=false&brief=false&maxResults=1&setBack=0&locationDescriptor=any' \
  --header 'apikey: <apikey>'

Finds the single occupant (business) nearest to the specified point. Optionally filter by tags and location descriptor. Returns a GeoJSON FeatureCollection containing the nearest occupant as a Point, with properties including the business name, civic address, and location metadata.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
minDegree
string
default: 2

The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1.

maxDegree
string
default: 100

The maximum degree an intersection can have to be included in results. A four-way stop has a degree of 4.

point
required

The X (longitude) and Y (latitude) coordinate of the search point, in the format ‘x,y’. Must be in the same SRS as the outputSRS parameter.

object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
Example
-122.377,50.121
bbox
required

A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. Must be in the same SRS as the outputSRS parameter.

object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
interiorPoint
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
exteriorRing
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
interiorPoint
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
closed
boolean
geometryType
string
boundaryDimension
integer format: int32
length
number format: double
empty
boolean
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
interiorPoint
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
startPoint
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
endPoint
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
ring
boolean
valid
boolean
simple
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
interiorPoint
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
numInteriorRing
integer format: int32
numPoints
integer format: int32
rectangle
boolean
area
number format: double
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
interiorPoint
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
valid
boolean
simple
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
centroid
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
interiorPoint
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
Example
-119.51,49.48,-119.53,49.50
maxDistance
integer format: int32

The maximum distance (in metres) to search from the given point.

excludeUnits
boolean

If true, address results that are identified as ‘access points’ are excluded.

onlyCivic
boolean

If true, only civic addresses are returned.

callback
string

If provided the JSON result will be wrapped in a function call of the given name (for JSONP support).

Example
jsonp
outputSRS
string
default: 4326

The EPSG code of the spatial reference system (SRS) to use for output geometries.

Example
4326
asAttachment
boolean

If true the result is returned as a file attachment.

tags
string

A set of user-defined tags to apply to the query results.

brief
boolean

If true the results are returned in brief format, omitting detailed address and location properties.

maxResults
string
default: 1

The maximum number of results to return.

setBack
string
default: 0

The setback distance in metres from the street segment. A value of -1 indicates the centroid of the address range.

locationDescriptor
string
default: any

Describes the nature of the address location.

Responses

Section titled “Responses”

200

Section titled “200”

The nearest occupant in Site Address Representation plus Occupant Representation. See https://github.com/bcgov/ols-geocoder/blob/gh-pages/geocoder-developer-guide.md#occupant-representation

Media type*/*

The standard response envelope for all geocoder API responses. Contains the response object (which may be a single result, an array of results, or a search results object), along with metadata about the query parameters and output settings.

object
responseObj
One of:

The complete search results for a geocode query, including match information, scoring, metadata, and the list of matching addresses.

object
queryAddress

The original query address that was geocoded.

string
matches

The list of matching addresses, sorted by score (highest first). Each match includes the full address, location, and scoring details.

Array<object>
object
score
integer format: int32
yourId
string
faults
Array<object>
object
value
string
element
string
Allowed values: OCCUPANT_NAME SITE_NAME UNIT_NUMBER UNIT_NUMBER_SUFFIX UNIT_DESIGNATOR CIVIC_NUMBER CIVIC_NUMBER_SUFFIX STREET STREET_NAME STREET_TYPE STREET_DIRECTION STREET_QUALIFIER LOCALITY PROVINCE POSTAL_ADDRESS_ELEMENT MAX_RESULTS ADDRESS INITIAL_GARBAGE LOCALITY_INITIAL_GARBAGE LOCALITY_GARBAGE PROVINCE_GARBAGE UNRECOGNIZED FAULTS
fault
string
penalty
integer format: int32
precision
string
Allowed values: OCCUPANT UNIT SITE CIVIC_NUMBER INTERSECTION BLOCK STREET LOCALITY PROVINCE NONE
precisionPoints
integer format: int32
location
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
address

Base class for all geocoder address results, containing the shared properties for both site addresses and intersection addresses.

object
location
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
localityName

The full name of the locality (neighbourhood, city, province) for the address.

string
Example
Victoria, BC
localityType

The type of locality.

string
Allowed values: City Community District Municipality First Nation Village Indian Reserve Landing Locality Mountain Resort Municipality Ranch Recreational Community Regional Municipality Resort Municipality Subdivision Town Unknown Urban Community Village
Example
Municipality
electoralArea

The electoral area, if applicable.

string
stateProvTerr

The province or territory abbreviation.

string
Example
BC
locationPositionalAccuracy

The positional accuracy classification of the location point.

string
Allowed values: low medium coarse high
locationDescriptor

Describes what the location point actually refers to (e.g. intersectionPoint, rooftopPoint, accessPoint).

string
Allowed values: any streetPoint localityPoint provincePoint intersectionPoint accessPoint routingPoint blockFacePoint rooftopPoint frontDoorPoint parcelPoint
locality
object
id
integer format: int32
name
string
qualifier
string
type
string
Allowed values: City Community District Municipality First Nation Village Indian Reserve Landing Locality Mountain Resort Municipality Ranch Recreational Community Regional Municipality Resort Municipality Subdivision Town Unknown Urban Community Village
electoralArea
string
stateProvTerr
object
id
integer format: int32
name
string
countryCode
string
location
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
location
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
fullyQualifiedName
string
localityName
string
localityType
string
Allowed values: City Community District Municipality First Nation Village Indian Reserve Landing Locality Mountain Resort Municipality Ranch Recreational Community Regional Municipality Resort Municipality Subdivision Town Unknown Urban Community Village
stateProvTerr
string
locationPositionalAccuracy
string
Allowed values: low medium coarse high
locationDescriptor
string
Allowed values: any streetPoint localityPoint provincePoint intersectionPoint accessPoint routingPoint blockFacePoint rooftopPoint frontDoorPoint parcelPoint
addressString
string
nearPerfect
boolean
srsCode

The EPSG code of the spatial reference system used for the output geometries.

integer format: int32
maxResults

The maximum number of search results returned.

integer format: int32
minScore

The minimum score required for a match to be returned.

integer format: int32
setBack

The distance (in metres) to move the access point away from the curb towards the inside of the parcel.

integer format: int32
tags

A semicolon-separated list of tags associated with the results.

string
isEcho

Whether unmatched address details are included in the results.

boolean
searchTimeStamp

The timestamp when the search was executed.

string format: date-time
executionTime

The execution time of the search in seconds.

number
processingDate

The date and time when the underlying geocoder data was last processed.

string format: date-time
disclaimer

A legal disclaimer for the geocoder service.

string
interpolation

The interpolation method used for address matching.

string
Allowed values: adaptive linear none
privacyStatement

The privacy statement for the geocoder service.

string
copyrightNotice

The copyright notice for the geocoder data.

string
copyrightLicense

The copyright license for the geocoder data.

string
locationDescriptor

The location descriptor used for the output addresses.

string
Allowed values: any streetPoint localityPoint provincePoint intersectionPoint accessPoint routingPoint blockFacePoint rooftopPoint frontDoorPoint parcelPoint
encoding

The character encoding of the output. Defaults to ‘ascii’.

string
bestMatch
object
score
integer format: int32
yourId
string
faults
Array<object>
object
value
string
element
string
Allowed values: OCCUPANT_NAME SITE_NAME UNIT_NUMBER UNIT_NUMBER_SUFFIX UNIT_DESIGNATOR CIVIC_NUMBER CIVIC_NUMBER_SUFFIX STREET STREET_NAME STREET_TYPE STREET_DIRECTION STREET_QUALIFIER LOCALITY PROVINCE POSTAL_ADDRESS_ELEMENT MAX_RESULTS ADDRESS INITIAL_GARBAGE LOCALITY_INITIAL_GARBAGE LOCALITY_GARBAGE PROVINCE_GARBAGE UNRECOGNIZED FAULTS
fault
string
penalty
integer format: int32
precision
string
Allowed values: OCCUPANT UNIT SITE CIVIC_NUMBER INTERSECTION BLOCK STREET LOCALITY PROVINCE NONE
precisionPoints
integer format: int32
location
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
address

Base class for all geocoder address results, containing the shared properties for both site addresses and intersection addresses.

object
location
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
localityName

The full name of the locality (neighbourhood, city, province) for the address.

string
Example
Victoria, BC
localityType

The type of locality.

string
Allowed values: City Community District Municipality First Nation Village Indian Reserve Landing Locality Mountain Resort Municipality Ranch Recreational Community Regional Municipality Resort Municipality Subdivision Town Unknown Urban Community Village
Example
Municipality
electoralArea

The electoral area, if applicable.

string
stateProvTerr

The province or territory abbreviation.

string
Example
BC
locationPositionalAccuracy

The positional accuracy classification of the location point.

string
Allowed values: low medium coarse high
locationDescriptor

Describes what the location point actually refers to (e.g. intersectionPoint, rooftopPoint, accessPoint).

string
Allowed values: any streetPoint localityPoint provincePoint intersectionPoint accessPoint routingPoint blockFacePoint rooftopPoint frontDoorPoint parcelPoint
locality
object
id
integer format: int32
name
string
qualifier
string
type
string
Allowed values: City Community District Municipality First Nation Village Indian Reserve Landing Locality Mountain Resort Municipality Ranch Recreational Community Regional Municipality Resort Municipality Subdivision Town Unknown Urban Community Village
electoralArea
string
stateProvTerr
object
id
integer format: int32
name
string
countryCode
string
location
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
location
object
envelope
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
empty
boolean
simple
boolean
x
number format: double
y
number format: double
geometryType
string
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
dimension
integer format: int32
boundary
object
envelope
object recursive
factory
object
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinateSequenceFactory
object
srid
integer format: int32
userData
object
length
number format: double
empty
boolean
valid
boolean
simple
boolean
geometryType
string
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
coordinate
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
coordinates
Array<object>
object
x
number format: double
y
number format: double
z
number format: double
valid
boolean
m
number format: double
coordinate
object recursive
numPoints
integer format: int32
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
dimension
integer format: int32
boundary
object recursive
boundaryDimension
integer format: int32
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
boundaryDimension
integer format: int32
coordinateSequence
object
dimension
integer format: int32
measures
integer format: int32
length
number format: double
valid
boolean
srid
integer format: int32
numGeometries
integer format: int32
precisionModel
object
scale
number format: double
type
object
floating
boolean
maximumSignificantDigits
integer format: int32
offsetX
number format: double
offsetY
number format: double
rectangle
boolean
area
number format: double
centroid
object recursive
interiorPoint
object recursive
envelopeInternal
object
null
boolean
area
number format: double
minX
number format: double
maxX
number format: double
minY
number format: double
maxY
number format: double
width
number format: double
height
number format: double
diameter
number format: double
fullyQualifiedName
string
localityName
string
localityType
string
Allowed values: City Community District Municipality First Nation Village Indian Reserve Landing Locality Mountain Resort Municipality Ranch Recreational Community Regional Municipality Resort Municipality Subdivision Town Unknown Urban Community Village
stateProvTerr
string
locationPositionalAccuracy
string
Allowed values: low medium coarse high
locationDescriptor
string
Allowed values: any streetPoint localityPoint provincePoint intersectionPoint accessPoint routingPoint blockFacePoint rooftopPoint frontDoorPoint parcelPoint
addressString
string
nearPerfect
boolean
bestScore
integer format: int32
outputSRS

The EPSG code of the spatial reference system used for the output geometries.

integer format: int32
Example
4326
callback

The JSONP callback function name, if one was requested.

string
brief

Whether the results are in brief format, omitting detailed properties.

boolean
errorMsg

An error message, if the request resulted in an error. Null if the request was successful.

string
error
boolean
params
object
callback
string
outputSRS
integer format: int32
asAttachment
boolean
tags
string
brief
boolean
maxResults
integer format: int32
setBack
integer format: int32
locationDescriptor
string
Allowed values: any streetPoint localityPoint provincePoint intersectionPoint accessPoint routingPoint blockFacePoint rooftopPoint frontDoorPoint parcelPoint
maxFeatures
integer format: int32