Skip to content
Scrappa Get API key
99.co API 1 credit/request

99.co Location Autocomplete API Documentation

GET https://scrappa.co/api/99co/v1/autocomplete?query=orchard

Resolve free text into 99.co locations: MRT and LRT stations, districts, areas, streets and developments. Each suggestion returns its id, type, title, subtitle, coordinates and (for stations) the line colours. Districts, areas, stations, regions and subzones come with ready location_type and location_id values for /search. Developments come with a development_id for /transactions. Streets and developments cannot filter a search, so their location_type and location_id are null. A query without a match is a successful response with an empty list.

99.co Location Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/99co/v1/autocomplete?query=orchard
Auth header
x-api-key
Cost
1 credit/request
query = orchard
Response preview
200 OK
{
    "success": true,
    "data": {
        "query": "orchard",
        "items": [
            {
                "id": "sg-mrt-orchard",
                "type": "subway_station",
                "title": "Orchard",
                "subtitle": "MRT",
                "section": "MRT/LRT",
                "coordinates": {
                    "lat": 1.304292,
                    "lng": 103.832494
...

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.

query string Required

Free text, 2 to 80 characters. Example: orchard.

Example value orchard
listing_type string Optional

sale or rent. Defaults to rent.

Example value example
property_segments string Optional

residential or commercial. Defaults to residential.

Example value example

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/99co/v1/autocomplete?query=orchard",
    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/99co/v1/autocomplete?query=orchard');

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/99co/v1/autocomplete?query=orchard', 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/99co/v1/autocomplete?query=orchard',
    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/99co/v1/autocomplete?query=orchard")
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/99co/v1/autocomplete?query=orchard", 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/99co/v1/autocomplete?query=orchard', 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/99co/v1/autocomplete?query=orchard")
        .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/99co/v1/autocomplete?query=orchard", 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/99co/v1/autocomplete?query=orchard"
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/99co/v1/autocomplete?query=orchard"));
            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/99co/v1/autocomplete?query=orchard',
            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/99co/v1/autocomplete?query=orchard")
        .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 data meta
JSON Response
200 OK
{
    "success": true,
    "data": {
        "query": "orchard",
        "items": [
            {
                "id": "sg-mrt-orchard",
                "type": "subway_station",
                "title": "Orchard",
                "subtitle": "MRT",
                "section": "MRT/LRT",
                "coordinates": {
                    "lat": 1.304292,
                    "lng": 103.832494
                },
                "line_colors": [
                    "#9C5924",
                    "#E55244"
                ],
                "main_categories": [],
                "is_new_launch": null,
                "location_type": "subway_station",
                "location_id": "sg-mrt-orchard",
                "development_id": null
            },
            {
                "id": "dtdistrict09",
                "type": "district",
                "title": "D9 - Orchard / River Valley",
                "subtitle": "District",
                "section": "District",
                "coordinates": {
                    "lat": 1.302458,
                    "lng": 103.839109
                },
                "line_colors": [],
                "main_categories": [],
                "is_new_launch": null,
                "location_type": "district",
                "location_id": "dtdistrict09",
                "development_id": null
            },
            {
                "id": "derMAQynz2P9eXeXmJV9He6A",
                "type": "cluster",
                "title": "Orchard Bel Air",
                "subtitle": "Condo",
                "section": "Project",
                "coordinates": {
                    "lat": 1.302318,
                    "lng": 103.824973
                },
                "line_colors": [],
                "main_categories": [
                    "condo"
                ],
                "is_new_launch": false,
                "location_type": null,
                "location_id": null,
                "development_id": "derMAQynz2P9eXeXmJV9He6A"
            }
        ]
    },
    "meta": {
        "endpoint_family": "autocomplete",
        "billable": true
    }
}

Errors

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

422

Validation Error

A public parameter is missing or invalid. No upstream call is made and the response is not billable.

{
    "errors": {
        "listing_type": [
            "The listing type field is required."
        ]
    },
    "message": "The request validation failed"
}
502

Unexpected Upstream Response

99.co answered with a body that is not the documented shape. The response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "autocomplete"
    },
    "error": {
        "code": "PARSER_DRIFT",
        "message": "99.co returned an unexpected response."
    },
    "success": false
}
503

Upstream Unavailable

99.co was temporarily unavailable or blocked the request. The response is not billable and the request never answers 429.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "autocomplete"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The 99.co API 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.