Skip to content
Scrappa Get API key
Vuokraovi API 1 credit/request

Vuokraovi Location Autocomplete API Documentation

GET https://scrappa.co/api/vuokraovi/location-autocomplete?q=Tampere

Scrappa's GET /api/vuokraovi/location-autocomplete finds the cities, districts, subdistricts, municipalities, post codes and streets that GET /api/vuokraovi/search accepts, from the start of a name.

What you get

Each location has code, type, name, full_name, the parent region and municipality, country_code, latitude, longitude and search_params. Pass search_params to the search endpoint as they are.

Notes

The same name can exist in several regions: Kallio is a district in four of them. Tell them apart with code and parent_region_code. Names may be Swedish, for example Helsingfors. One call returns up to 100 locations. Use type to narrow the result.

Vuokraovi Location Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/vuokraovi/location-autocomplete?q=Tampere
Auth header
x-api-key
Cost
1 credit/request
q = Tampere
Response preview
200 OK
{
    "success": true,
    "query": "Tampere",
    "page": 1,
    "total": 1,
    "locations": [
        {
            "code": "FI_PIRKANMAA_TAMPERE",
            "type": "CITY",
            "name": "Tampere",
            "full_name": "Tampere",
            "parent_region_code": "FI_PIRKANMAA",
            "parent_region_name": "Pirkanmaa",
            "country_code": "FI",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

2 optional filters available.

q string Required

Start of a place name, at least 2 characters.

Example value Tampere
type string Optional

CITY, DISTRICT, SUBDISTRICT, MUNICIPALITY, POST_CODE or STREET. Omit for all types.

Example value example
page integer Optional

Result page, 1-based.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/vuokraovi/location-autocomplete?q=Tampere",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/vuokraovi/location-autocomplete?q=Tampere');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/vuokraovi/location-autocomplete?q=Tampere', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/vuokraovi/location-autocomplete?q=Tampere',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/vuokraovi/location-autocomplete?q=Tampere")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/vuokraovi/location-autocomplete?q=Tampere", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/vuokraovi/location-autocomplete?q=Tampere', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/vuokraovi/location-autocomplete?q=Tampere")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/vuokraovi/location-autocomplete?q=Tampere", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/vuokraovi/location-autocomplete?q=Tampere"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/vuokraovi/location-autocomplete?q=Tampere"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/vuokraovi/location-autocomplete?q=Tampere',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/vuokraovi/location-autocomplete?q=Tampere")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success query page total locations meta

Common locations fields

code type name full_name
JSON Response
200 OK
{
    "success": true,
    "query": "Tampere",
    "page": 1,
    "total": 1,
    "locations": [
        {
            "code": "FI_PIRKANMAA_TAMPERE",
            "type": "CITY",
            "name": "Tampere",
            "full_name": "Tampere",
            "parent_region_code": "FI_PIRKANMAA",
            "parent_region_name": "Pirkanmaa",
            "country_code": "FI",
            "latitude": 61.498336,
            "longitude": 23.769304,
            "search_params": {
                "location_code": "FI_PIRKANMAA_TAMPERE",
                "location_type": "CITY",
                "parent_region_code": "FI_PIRKANMAA"
            }
        }
    ],
    "meta": {
        "endpoint_family": "location_autocomplete",
        "billable": true,
        "attempts": 1
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A query parameter is missing, unknown or unusable. Unknown parameters and unknown values are rejected, never ignored. Non-billable.

{
    "errors": {
        "lessor_type": [
            "The selected lessor type is invalid."
        ]
    },
    "message": "The selected lessor type is invalid."
}
503

Upstream Unavailable

Vuokraovi could not be reached after retries, answered with an error or changed its format (`upstream_unavailable`, `upstream_blocked`, `parser_drift`). Retryable and never billed. Clients are never rate limited.

{
    "meta": {
        "attempts": 3,
        "billable": false,
        "retryable": true,
        "endpoint_family": "location_autocomplete"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "Vuokraovi is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.