Skip to content
Scrappa Get API key
Metros Cubicos API 1 credit/request

Metros Cubicos Location Autocomplete API Documentation

GET https://scrappa.co/api/metroscubicos/locations?state=jalisco

Scrappa's GET /api/metroscubicos/locations returns the places the search accepts. Metros Cubicos has no place tree, so the endpoint works in three modes.

Modes

  • No parameter: the 32 Mexican states with their slug. This answer is fixed and makes no lookup on the site.
  • state: the cities and boroughs of that state with the number of listings, taken from the filters of the state's result page. The site shows only the nine places with the most listings; any other city slug (the lowercase name with hyphens) still works in the search. Each slug works in the search city parameter. operation and type choose which listings the counts describe (sale and apartment by default).
  • q: search suggestions for a text, such as casa polanco. Suggestions are text queries, not ids. Use them as ideas for your own search.

Use either q or state, not both. An unknown state returns a non-billable 422 (unknown_location).

Response

mode is states, cities or suggestions. locations holds objects with type, slug, name and listings (null where the site gives no count). state names the state in cities mode.

Metros Cubicos Location Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/metroscubicos/locations?state=jalisco
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "mode": "cities",
    "state": {
        "slug": "jalisco",
        "name": "Jalisco"
    },
    "count": 1,
    "locations": [
        {
            "type": "city",
            "slug": "zapopan",
            "name": "Zapopan",
            "listings": 9100
...

Parameters

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

Runnable path

This endpoint has no required query parameters.

4 optional filters available.

q string Optional

Search text, at least 2 characters. Returns suggestions.

Example value coffee shops
state string Optional

State slug, for example jalisco. Returns its cities.

Example value jalisco
operation string Optional

sale (default) or rent. Chooses the listings the city counts describe.

Example value example
type string Optional

Property type for the city counts: apartment (default), house, land, office, commercial, warehouse, building, room, ranch or hacienda.

Example value example

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/metroscubicos/locations?state=jalisco",
    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/metroscubicos/locations?state=jalisco');

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/metroscubicos/locations?state=jalisco', 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/metroscubicos/locations?state=jalisco',
    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/metroscubicos/locations?state=jalisco")
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/metroscubicos/locations?state=jalisco", 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/metroscubicos/locations?state=jalisco', 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/metroscubicos/locations?state=jalisco")
        .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/metroscubicos/locations?state=jalisco", 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/metroscubicos/locations?state=jalisco"
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/metroscubicos/locations?state=jalisco"));
            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/metroscubicos/locations?state=jalisco',
            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/metroscubicos/locations?state=jalisco")
        .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 mode state count locations meta

Common locations fields

type slug name listings
JSON Response
200 OK
{
    "success": true,
    "mode": "cities",
    "state": {
        "slug": "jalisco",
        "name": "Jalisco"
    },
    "count": 1,
    "locations": [
        {
            "type": "city",
            "slug": "zapopan",
            "name": "Zapopan",
            "listings": 9100
        }
    ],
    "meta": {
        "endpoint_family": "locations",
        "billable": true,
        "attempts": 1
    }
}

Errors

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

422

Unknown Location

The `state` or `city` slug is not known to Metros Cubicos (`unknown_location`). The site would turn it into a text search, so the request is rejected. Non-billable.

{
    "meta": {
        "attempts": 0,
        "billable": false,
        "retryable": false,
        "endpoint_family": "locations"
    },
    "error": {
        "code": "unknown_location",
        "message": "Unknown location. Use a state or city slug from /api/metroscubicos/locations."
    },
    "success": false
}
422

Validation Error

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

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

Upstream Unavailable

Metros Cubicos could not be reached after retries, answered with an error, or returned an unexpected answer (`upstream_unavailable`, `upstream_blocked`, `upstream_changed`). Retryable and never billed. Clients are never rate limited.

{
    "meta": {
        "attempts": 4,
        "billable": false,
        "retryable": true,
        "endpoint_family": "locations"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "Metros Cubicos 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.