Search Locations


About this API

To get the ins and outs of this API, please refer to our documentation page here


Service limitations

To ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.


How to use this page?

  1. Pick a preferred language on the right.
  2. Enter your API key in the header field. Don't have one yet or don't know what that is? Please refer to the following page here.
  3. Enter the required parameters below or try something yourself!
  4. Click the Try It! button!
📘

You can also press one of the HTTP response codes on the right to see an example of that specific response!

Query Params
string

Searches an address based on given parameters. Will use all of the values given and return results based on the best match.

Minimum amount of characters is 2."

filter
object

Filter is used for an exact match. So if the given input doesn't 100% match, no results are given.

The example below contains all the possible filters"

match
object

Match will search with the given parameters and returns a list based on the highest score. Doesn't have to be an exact match and can contain non complete values.

The example below contains all the possible matches"

string

Sort field can be used to sort the result of the search.

The order of the sort can be either descending or ascending.

By default, we sort the results based on id and descending.

It's been implemented based on the JSONAPI conventions, so to have multiple
sorting orders you must separate it by commas. Also, by default the sort
order is ascending, to change it to descending you must use a - before the field name

supported fields: id,city,street

page
object

size defines the number of records to return in each page.
default value: 10, maximum value: 20.

number specifies the page number."

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json