Suggest Range

get

https://app-api.geposit.se/v2.0/suggest/range/{region}

This endpoint provides range of address suggestions, considering defined search parameters. Typically used for search functionality, it assists users to retrieve a valid range of addresses based on the provided criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

region

string

enum

required

Defaults to se

Region

Allowed:

Query Params

sort_by

string

enum

Defaults to none

Sort By

Allowed:

query

string

required

Defaults to skeppargatan 65

The query string that will be used to filter what address suggestions to fetch.

response_format

string

enum

Defaults to json

Sets the format for the API response.

Allowed:

max_rows

integer

1 to 100

Defaults to 15

The maximum number of suggestions that should be returned. Possible values are 1 to 100. Default value is 15.

street_number

string

length between 0 and 10

Filter results to only return addresses with a certain street number.

letter

string

Filter results to only return addresses with a certain letter.

extra_number

string

Filter results to only return addresses with a certain secondary street number.

postcode

string

length between 0 and 5

Filter results to only return addresses with a certain postcode or where the postcode begins with a pattern.

locality

string

Filter results to only return addresses with a certain locality or where the locality begins with a pattern.

administrative

boolean

enum

Defaults to false

Includes the administrative division relations for the address in the response. (API key permission required)

Allowed:

coordinate

boolean

enum

Defaults to false

Includes the coordinate for the address in the response. (API key permission required)

Allowed:

property_designation

boolean

enum

Defaults to false

Includes property designation for Swedish addresses (Fastighetsbeteckning). (API key permission required)

Allowed:

deso

boolean

enum

Defaults to false

Demographic statistical areas. (API key permission required)

Allowed:

regso

boolean

enum

Defaults to false

Regional statistical areas. (API key permission required)

Allowed:

Response

200OK