Skip to main content
GET
/
address
Autocomplete an address
curl --request GET \
  --url https://api.streetline.io/v1/address \
  --header 'Authorization: Bearer <token>'
{
  "hits": [
    {
      "components": [
        {
          "type": "NLD_PUBLIC_SPACE",
          "value": "Hoofdstraat"
        },
        {
          "type": "NLD_HOUSE_NUMBER",
          "value": 2
        },
        {
          "type": "NLD_HOUSE_LETTER",
          "value": "A"
        },
        {
          "type": "NLD_POSTAL_CODE",
          "value": "7311 KA"
        },
        {
          "type": "NLD_LOCALITY",
          "value": "Apeldoorn"
        },
        {
          "type": "NLD_MUNICIPALITY",
          "value": "Apeldoorn"
        },
        {
          "type": "NLD_PROVINCE",
          "value": "Gelderland"
        },
        {
          "type": "NLD_COUNTRY",
          "value": "Nederland"
        }
      ],
      "country": "NLD",
      "lines": [
        "Hoofdstraat 2A",
        "7311 KA Apeldoorn",
        "Nederland"
      ],
      "location": {
        "latitude": 52.209884,
        "longitude": 5.967036
      }
    },
    {
      "components": [
        {
          "type": "NLD_PUBLIC_SPACE",
          "value": "Hoofdstraat"
        },
        {
          "type": "NLD_HOUSE_NUMBER",
          "value": 7
        },
        {
          "type": "NLD_POSTAL_CODE",
          "value": "5706 AJ"
        },
        {
          "type": "NLD_LOCALITY",
          "value": "Helmond"
        },
        {
          "type": "NLD_MUNICIPALITY",
          "value": "Helmond"
        },
        {
          "type": "NLD_PROVINCE",
          "value": "Noord-Brabant"
        },
        {
          "type": "NLD_COUNTRY",
          "value": "Nederland"
        }
      ],
      "country": "NLD",
      "lines": [
        "Hoofdstraat 7",
        "5706 AJ Helmond",
        "Nederland"
      ],
      "location": {
        "latitude": 51.460438,
        "longitude": 5.631037
      }
    },
    {
      "components": [
        {
          "type": "NLD_PUBLIC_SPACE",
          "value": "Hoofdstraat"
        },
        {
          "type": "NLD_HOUSE_NUMBER",
          "value": 1
        },
        {
          "type": "NLD_POSTAL_CODE",
          "value": "6372 CN"
        },
        {
          "type": "NLD_LOCALITY",
          "value": "Landgraaf"
        },
        {
          "type": "NLD_MUNICIPALITY",
          "value": "Landgraaf"
        },
        {
          "type": "NLD_PROVINCE",
          "value": "Limburg"
        },
        {
          "type": "NLD_COUNTRY",
          "value": "Nederland"
        }
      ],
      "country": "NLD",
      "lines": [
        "Hoofdstraat 1",
        "6372 CN Landgraaf",
        "Nederland"
      ],
      "location": {
        "latitude": 50.895412,
        "longitude": 6.015682
      }
    },
    {
      "components": [
        {
          "type": "NLD_PUBLIC_SPACE",
          "value": "Hoofdstraat"
        },
        {
          "type": "NLD_HOUSE_NUMBER",
          "value": 1
        },
        {
          "type": "NLD_POSTAL_CODE",
          "value": "7811 EA"
        },
        {
          "type": "NLD_LOCALITY",
          "value": "Emmen"
        },
        {
          "type": "NLD_MUNICIPALITY",
          "value": "Emmen"
        },
        {
          "type": "NLD_PROVINCE",
          "value": "Drenthe"
        },
        {
          "type": "NLD_COUNTRY",
          "value": "Nederland"
        }
      ],
      "country": "NLD",
      "lines": [
        "Hoofdstraat 1",
        "7811 EA Emmen",
        "Nederland"
      ],
      "location": {
        "latitude": 52.783572,
        "longitude": 6.89627
      }
    },
    {
      "components": [
        {
          "type": "NLD_PUBLIC_SPACE",
          "value": "Hoofdstraat"
        },
        {
          "type": "NLD_HOUSE_NUMBER",
          "value": 1
        },
        {
          "type": "NLD_POSTAL_CODE",
          "value": "7902 EA"
        },
        {
          "type": "NLD_LOCALITY",
          "value": "Hoogeveen"
        },
        {
          "type": "NLD_MUNICIPALITY",
          "value": "Hoogeveen"
        },
        {
          "type": "NLD_PROVINCE",
          "value": "Drenthe"
        },
        {
          "type": "NLD_COUNTRY",
          "value": "Nederland"
        }
      ],
      "country": "NLD",
      "lines": [
        "Hoofdstraat 1",
        "7902 EA Hoogeveen",
        "Nederland"
      ],
      "location": {
        "latitude": 52.728929,
        "longitude": 6.477778
      }
    }
  ],
  "limit": 5
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
country
enum<string>
required

Three-letter country code (ISO 3166-1 alpha-3).

Available options:
NLD
​
q
string
required

Partial address input.

Maximum string length: 128
​
limit
integer
default:5

Maximum number of suggestions to return.

Note: Results are ranked for the requested limit. Requesting a higher limit and then truncating the result list client-side may lead to suboptimal ranking of the remaining results.

Required range: 1 <= x <= 10

Response

Autocomplete suggestions returned successfully.

Address autocomplete result set.

​
hits
object[]
required
​
limit
integer
required

Maximum number of results requested.