CTRL+K

Forward Geocoding API

GET

https://api.apifreaks.com/v1.0/geocoder/search

Swagger Docs Documentation

format

Format of the Response

queryStringrequired

Free form search query. Accepts addresses, place names, business names, landmarks.

limitInteger

Maximum number of results to return. Min 1, max 40.

min_latFloat

Minimum latitude of the viewbox. Between -90 and 90, must be less than or equal to max_lat. All four viewbox parameters must be provided together.

max_latFloat

Maximum latitude of the viewbox. Between -90 and 90, must be greater than or equal to min_lat. All four viewbox parameters must be provided together.

min_lonFloat

Minimum longitude of the viewbox. Between -180 and 180, must be less than or equal to max_lon. All four viewbox parameters must be provided together.

max_lonFloat

Maximum longitude of the viewbox. Between -180 and 180, must be greater than or equal to min_lon. All four viewbox parameters must be provided together.

Sample Responses

400

404

504

LANGUAGE

Python

PHP

Java

Node

Ruby


$ pip install requests
import requests 

url = "https://api.apifreaks.com/v1.0/geocoder/search"

payload = {}
headers = {
	'X-apiKey': ''
}

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

print(response.text)

RESPONSE

Click Test it to start the request and see the response here!

API Response

Returns a JSON array. The number of objects depends on the limit value and the number of matches found.

Field	Type	Requirement	Description
lat	Float	Mandatory	Latitude of the matched location.
lon	Float	Mandatory	Longitude of the matched location.
name	String	Optional	Name of the matched place.
category	String	Optional	High-level category, e.g. amenity, place, natural, building, highway.
type	String	Optional	Specific type within the category, e.g. fast_food, city, park, house_number.
poi	Array	Optional	Points of interest at or near the location.
street	String	Optional	Street or road name.
area	String	Optional	Neighbourhood, suburb, district, or similar sub-city area.
postcode	String	Optional	Postal code.
city	String	Optional	City, town, or municipality.
county	String	Optional	County, district, shire, or prefecture.
state_code	String	Optional	ISO 3166-2 subdivision code, e.g. US-TX.
state	String	Optional	State, region, province, or division.
country_code	String	Mandatory	ISO 3166-1 alpha-2 country code in uppercase.
country	String	Mandatory	Country name.
full_address	String	Mandatory	Full address as a single readable line.
bounding_box	Array<String>	Mandatory	Spatial extent of the feature: [lat_min, lat_max, lon_min, lon_max].

Each object in the poi array contains the following fields.

Field	Type	Requirement	Description
poi[].name	String	Optional	Name of the point of interest.
poi[].category	String	Optional	POI category.
poi[].type	String	Optional	Specific type within the POI category.

$ pip install requests

import requests 

url = "https://api.apifreaks.com/v1.0/geocoder/search"

payload = {}
headers = {
	'X-apiKey': ''
}

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

print(response.text)

Field

Type

Requirement

Description

lat

Float

Mandatory

Latitude of the matched location.

lon

Float

Mandatory

Longitude of the matched location.

name

String

Optional

Name of the matched place.