Forward

Forward geocoding involves translating addresses or place names into geographical coordinates, specifically latitude and longitude. This technique is commonly utilized in mapping and navigation software to accurately determine and display the precise location of a given address on a map.

SecurityApiKeyAuth
Request
query Parameters
q
string

Free-form query string to search for. Commas are optional, but improve performance by reducing the complexity of the search. Don't use it if you request coordinates by country, city, street, county, postalcode, state.

Examples:
q=Au Cap, Mahe
q=Great Russell St, London WC1B 3DG, United Kingdom
street
string

Street

Example: street=131 Forest Ave
city
string

City

Example: city=New York
county
string

County

Example: county=Staten Island
state
string

State

Example: state=NY
country
string

Country

Example: country=USA
postalcode
string

Postal Code

Example: postalcode=10301
addressdetails
number

Include a breakdown of the address into elements.

Enum: 0 1
extratags
number

Include additional information in the result if available, e.g. wikipedia link, opening hours.

Enum: 0 1
namedetails
number

Include a list of alternative names in the results. These may include language variants, references, operator and brand.

Enum: 0 1
accept-language
string

The preferred language order for displaying search results can be set to override the language specified in the Accept-Language HTTP header. This can be achieved either by using a standard RFC2616 accept-language string or by providing a straightforward comma-separated list of language codes.

Example: accept-language=en
countrycodes
Array of strings

To restrict search results to specific countries, use the parameter, which should correspond to the ISO 3166-1 alpha-2 code. For example, use gb for the United Kingdom or de for Germany. Each location is associated with a country code based on the country boundaries defined in OpenStreetMap (OSM). However, in rare instances, a place might not fall within any country's boundaries, such as locations in international waters.

Example: countrycodes=gb,us,ca
exclude_place_ids
Array of numbers

To exclude specific OSM objects from your search results, provide a comma-separated list of the place_ids you wish to omit. This approach can be useful for obtaining additional search results. For instance, if an initial query yielded only a limited number of results, including those place_ids in the exclusion list will prompt the search to return alternative matches, which may be less precise, if available.

Example: exclude_place_ids=186219712,117953627
limit
number [ 10 .. 50 ]

Limit the number of returned results

Example: limit=10
viewbox
Array of numbers = 4 items

The preferred area to find search results. Any two corner points of the box are accepted as long as they span a real box. x is longitude, y is latitude. Format: <x1>,<y1>,<x2>,<y2>

Example: viewbox=0.0,52.0,1.0,53.0
bounded
number

When a 'viewbox' parameter is specified, the search results are limited to items located within the defined viewbox area. If both 'viewbox' and 'bounded'=1 parameters are set, the search is restricted exclusively to amenities. To search for a specific type of amenity, use the corresponding keyword enclosed in square brackets, such as [pharmacy]. This will return a range of objects of that particular type. However, it should be noted that there is no assurance of the completeness of the results.

Enum: 0 1
polygon_geojson
number

Output geometry of results as a GeoJSON. Only one of polygon_ options can be used at a time.

Enum: 0 1
polygon_kml
number

Output geometry of results as a KML. Only one of polygon_ options can be used at a time.

Enum: 0 1
polygon_svg
number

Output geometry of results as a SVG. Only one of polygon_ options can be used at a time.

Enum: 0 1
polygon_text
number

Output geometry of results as a WKT. Only one of polygon_ options can be used at a time.

Enum: 0 1
polygon_threshold
number

Return a simplified version of the output geometry. The parameter is the tolerance in degrees with which the geometry may differ from the original geometry. Topology is preserved in the result.

Responses
200

Forward geocoding result.

400

Incorrect request parameters.

401

API key is incorrect or not provided.

402

Subscription daily limit exceeded.

403

Subscription suspended.

get/geocode/forward
Request samples 
Response samples 
application/json
[
  • {
    • "place_id": 0,
    • "licence": "string",
    • "osm_type": "string",
    • "osm_id": 0,
    • "lat": "string",
    • "lon": "string",
    • "display_name": "string",
    • "class": "string",
    • "type": "string",
    • "importance": "string",
    • "boundingbox": [
      • "string",
      • "string",
      • "string",
      • "string"
      ],
    • "address": {
      • "house_number": "string",
      • "road": "string",
      • "city": "string",
      • "county": "string",
      • "state": "string",
      • "postcode": "string",
      • "country": "string",
      • "country_code": "string"
      }
    }
]
Copyright © Pickpointio LLC  2023. All rights reserved.