Geocoding (0.2.2)

Download OpenAPI specification:Download

License: MIT

MapColonies Vector Geocoding api provides custom geodata search engine uniting multiple sources of data, query tiles, routes, items; Convertion functions - tile to/from WGS84 lat lng, WGS84 to/from US Army MGRS, WGS84 to/from UTM.

Location Name Based Search

Search engine

Search for geo-data. It serves data from multiple diverse mapcolonies vector sources and partners.

query Parameters

token	string JWT authentication token provided by our team
query required	string (Query) [ 3 .. 100 ] characters Text to search
source	Array of strings (Source) Sources to include (if not specified, all sources will be queried)
region	Array of strings (Region) Regions to include (if not specified, all Regions will be queried)
	object or WGS84Circle (object) or UTMCircle (object) (geo_context) Geo context of search. Supported queries: bounding box: {"bbox":[minX,minY,maxX,maxY]} By point and radius (WGS84 and UTM are supported) {"lon":value,"lat":value,"radius":value} {"x":value,"y":value,"zone": number, "radius":value}
geo_context_mode	string (geo_context_mode) Enum: "filter" "bias" Choose whether geo_context query parameter will be a filter or a bias value
limit	number [ 1 .. 15 ] Default: 5 Maximum number of results
disable_fuzziness	boolean (disable_fuzziness) Default: false If an accurate result is obtained, only it will be returned

header Parameters

x-api-key

string

JWT authentication token provided by our team

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"type": "FeatureCollection",
"geocoding": {"version": "1.5.3",
"query": {"limit": 1,
"geo_context": {"bbox": "[-74.382527,40.477003,-73.322346,40.916383]"
},
"geo_context_mode": "filter",
"disable_fuzziness": false
},
"response": {"max_score": 100,
"results_count": 10,
"match_latency_ms": 5000
}
},
"bbox": "[-74.382527,40.477003,-73.322346,40.916383]",
"features": [{"geometry": {"type": "Point",
"coordinates": [0,
0
]
},
"properties": {"score": 100,
"matches": [{"layer": "string",
"source": "string",
"source_id": ["string"
]
}
],
"names": {"display": "string",
"default": ["string"
],
"property1": ["string"
],
"property2": ["string"
]
},
"regions": [{"name": "string",
"sub_regions_names": ["string"
]
}
],
"placetype": "string",
"sub_placetype": "string"
}
}
]
}

Get all available regions to filter on using location query

query Parameters

token

string

JWT authentication token provided by our team

header Parameters

x-api-key

string

JWT authentication token provided by our team

Responses

Response samples

200
400
401
403
500

Content type

application/json

["string"
]

Get all available sources to filter on using location query

query Parameters

token

string

JWT authentication token provided by our team

header Parameters

x-api-key

string

JWT authentication token provided by our team

Responses

Response samples

200
400
401
403
500

Content type

application/json

["string"
]

Control

Search tiles and sub tiles

Tiles are consisted of 3 characters.
You can query and get results from 2 characters.

If you define a tile (full name of it) you can query the sub tile associated with it.
You may also search tile based on 1 meter precision MGRS tile.

query Parameters

token	string JWT authentication token provided by our team
tile	string [ 2 .. 3 ] characters Tile name
sub_tile	string^[1-9][0-9]*$ Sub tile number
mgrs	string Example: mgrs=18SUJ2338907395 1 meters MGRS Tile
	object or WGS84Circle (object) or UTMCircle (object) (geo_context) Geo context of search. Supported queries: bounding box: {"bbox":[minX,minY,maxX,maxY]} By point and radius (WGS84 and UTM are supported) {"lon":value,"lat":value,"radius":value} {"x":value,"y":value,"zone": number, "radius":value}
geo_context_mode	string (geo_context_mode) Enum: "filter" "bias" Choose whether geo_context query parameter will be a filter or a bias value
limit	number [ 1 .. 15 ] Default: 5 Maximum number of results
disable_fuzziness	boolean (disable_fuzziness) Default: false If an accurate result is obtained, only it will be returned

header Parameters

x-api-key

string

JWT authentication token provided by our team

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"type": "FeatureCollection",
"geocoding": {"version": "1.5.3",
"query": {"limit": 1,
"geo_context": {"bbox": "[-74.382527,40.477003,-73.322346,40.916383]"
},
"geo_context_mode": "filter",
"disable_fuzziness": false
},
"response": {"max_score": 100,
"results_count": 10,
"match_latency_ms": 5000
}
},
"bbox": "[-74.382527,40.477003,-73.322346,40.916383]",
"features": [{"geometry": {"type": "Point",
"coordinates": [[[0,
0
]
]
]
},
"properties": {"score": 100,
"matches": [{"layer": "string",
"source": "string",
"source_id": ["string"
]
}
],
"names": {"display": "string",
"default": ["string"
],
"property1": ["string"
],
"property2": ["string"
]
},
"regions": [{"name": "string",
"sub_regions_names": ["string"
]
}
],
"TYPE": "string",
"TILE_NAME": "string",
"SUB_TILE_ID": "string",
"SUB_TILE_NUMBER": [100,
100,
100
]
},
"type": "Feature"
}
]
}

Search control items

query Parameters

token	string JWT authentication token provided by our team
command_name required	string Object command name of the item
tile	string = 3 characters The tile the item in it (full name of it)
sub_tile	string^[1-9][0-9]*$ Example: sub_tile=66 The sub tile the item in it (required if tile is defined)
	object or WGS84Circle (object) or UTMCircle (object) (geo_context) Geo context of search. Supported queries: bounding box: {"bbox":[minX,minY,maxX,maxY]} By point and radius (WGS84 and UTM are supported) {"lon":value,"lat":value,"radius":value} {"x":value,"y":value,"zone": number, "radius":value}
geo_context_mode	string (geo_context_mode) Enum: "filter" "bias" Choose whether geo_context query parameter will be a filter or a bias value
limit	number [ 1 .. 15 ] Default: 5 Maximum number of results
disable_fuzziness	boolean (disable_fuzziness) Default: false If an accurate result is obtained, only it will be returned

header Parameters

x-api-key

string

JWT authentication token provided by our team

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"type": "FeatureCollection",
"geocoding": {"version": "1.5.3",
"query": {"limit": 1,
"geo_context": {"bbox": "[-74.382527,40.477003,-73.322346,40.916383]"
},
"geo_context_mode": "filter",
"disable_fuzziness": false
},
"response": {"max_score": 100,
"results_count": 10,
"match_latency_ms": 5000
}
},
"bbox": "[-74.382527,40.477003,-73.322346,40.916383]",
"features": [{"geometry": {"type": "Point",
"coordinates": [0,
0
]
},
"properties": {"score": 100,
"matches": [{"layer": "string",
"source": "string",
"source_id": ["string"
]
}
],
"names": {"display": "string",
"default": ["string"
],
"property1": ["string"
],
"property2": ["string"
]
},
"regions": [{"name": "string",
"sub_regions_names": ["string"
]
}
],
"TYPE": "string",
"OBJECT_COMMAND_NAME": "string",
"ENTITY_HEB": "string",
"TILE_NAME": "string",
"SUB_TILE_ID": "string"
}
}
]
}

Search routes and report control points

You can query and get control routes.

If you define a route (full name of it) you can query the control points associated with it.

query Parameters

token	string JWT authentication token provided by our team
command_name required	string Object command name of the item
control_point	string^[1-9][0-9]*$ The associated report control point of the route
	object or WGS84Circle (object) or UTMCircle (object) (geo_context) Geo context of search. Supported queries: bounding box: {"bbox":[minX,minY,maxX,maxY]} By point and radius (WGS84 and UTM are supported) {"lon":value,"lat":value,"radius":value} {"x":value,"y":value,"zone": number, "radius":value}
geo_context_mode	string (geo_context_mode) Enum: "filter" "bias" Choose whether geo_context query parameter will be a filter or a bias value
limit	number [ 1 .. 15 ] Default: 5 Maximum number of results
disable_fuzziness	boolean (disable_fuzziness) Default: false If an accurate result is obtained, only it will be returned

header Parameters

x-api-key

string

JWT authentication token provided by our team

Responses

Response samples

200
400
401
403
500

Content type

application/json

Example

routesSchema

{"type": "FeatureCollection",
"geocoding": {"version": "1.5.3",
"query": {"limit": 1,
"geo_context": {"bbox": "[-74.382527,40.477003,-73.322346,40.916383]"
},
"geo_context_mode": "filter",
"disable_fuzziness": false
},
"response": {"max_score": 100,
"results_count": 10,
"match_latency_ms": 5000
}
},
"bbox": "[-74.382527,40.477003,-73.322346,40.916383]",
"features": [{"geometry": {"type": "Point",
"coordinates": [[0,
0
]
]
},
"properties": {"score": 100,
"matches": [{"layer": "string",
"source": "string",
"source_id": ["string"
]
}
],
"names": {"display": "string",
"default": ["string"
],
"property1": ["string"
],
"property2": ["string"
]
},
"regions": [{"name": "string",
"sub_regions_names": ["string"
]
}
],
"TYPE": "string",
"OBJECT_COMMAND_NAME": "string",
"ENTITY_HEB": "string",
"SECTION": "string"
}
}
]
}

Convertions

Convert a WGS84 coordinate to US Army MGRS / Control Grid

query Parameters

token	string JWT authentication token provided by our team
lat required	number [ -90 .. 90 ] Latitude of the coordinate
lon required	number [ -180 .. 180 ] Longitude of the coordinate
target_grid required	string Enum: "control" "MGRS" Choose target grid

header Parameters

x-api-key

string

JWT authentication token provided by our team

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"type": "Feature",
"geocoding": {"version": "1.5.3",
"query": {"lat": 0,
"lon": 0,
"target_grid": "control"
},
"response": {"max_score": 1,
"results_count": 1,
"match_latency_ms": 0
}
},
"bbox": "[-74.382527,40.477003,-73.322346,40.916383]",
"geometry": {"type": "Point",
"coordinates": [0,
0
]
},
"properties": {"score": 1,
"matches": [{"layer": "MGRS",
"source": "npm/mgrs",
"source_id": ["string"
]
}
],
"names": {"default": ["string"
],
"display": "string",
"additionalProperty1": { }
},
"additionalProperty1": { }
}
}

Search anything

This is for general queries. the services will make a sophisticated guess.

query Parameters

token	string JWT authentication token provided by our team
query required	string (Query) [ 3 .. 100 ] characters Text to search
	object or WGS84Circle (object) or UTMCircle (object) (geo_context) Geo context of search. Supported queries: bounding box: {"bbox":[minX,minY,maxX,maxY]} By point and radius (WGS84 and UTM are supported) {"lon":value,"lat":value,"radius":value} {"x":value,"y":value,"zone": number, "radius":value}
geo_context_mode	string (geo_context_mode) Enum: "filter" "bias" Choose whether geo_context query parameter will be a filter or a bias value
limit	number [ 1 .. 15 ] Default: 5 Maximum number of results
disable_fuzziness	boolean (disable_fuzziness) Default: false If an accurate result is obtained, only it will be returned

header Parameters

x-api-key

string

JWT authentication token provided by our team

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"type": "FeatureCollection",
"geocoding": {"version": "1.5.3",
"query": {"limit": 1,
"geo_context": {"bbox": "[-74.382527,40.477003,-73.322346,40.916383]"
},
"geo_context_mode": "filter",
"disable_fuzziness": false
},
"response": {"max_score": 100,
"results_count": 10,
"match_latency_ms": 5000
}
},
"bbox": "[-74.382527,40.477003,-73.322346,40.916383]",
"features": [{"geometry": {"type": "Point"
},
"properties": {"score": 100,
"matches": [{"layer": "string",
"source": "string",
"source_id": ["string"
]
}
],
"names": {"display": "string",
"default": ["string"
],
"property1": ["string"
],
"property2": ["string"
]
},
"regions": [{"name": "string",
"sub_regions_names": ["string"
]
}
]
}
}
]
}

MGRS

Convert a MGRS string to Geometry in GeoJSON

query Parameters

token	string JWT authentication token provided by our team
tile required	string MGRS tile string

header Parameters

x-api-key

string

JWT authentication token provided by our team

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"type": "Feature",
"geocoding": {"version": "1.5.3",
"query": {"tile": "18SUJ2339007393"
},
"response": {"max_score": 1,
"results_count": 1,
"match_latency_ms": 0
}
},
"bbox": "[-74.382527,40.477003,-73.322346,40.916383]",
"geometry": {"type": "Point",
"coordinates": [0,
0
]
},
"properties": {"matches": [{"layer": "MGRS",
"source": "npm/mgrs",
"source_id": ["string"
]
}
],
"names": {"default": ["string"
],
"display": "string"
},
"score": 1
}
}