Search Couchsurfing locations

Try in Playground

Search Couchsurfing cities, regions and countries by name and get the location slugs used by the events, hosts and travelers endpoints, ranked by relevance.

GET/v1/couchsurfing/locationsx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

querystringrequiredquery

Required place name, 2 to 100 characters.

min 2 chars · max 100 chars

Examplelisbon

cursorstringquery

Optional pagination cursor: pass nextCursor from the previous response. Omit for the first page.

max 5 chars

limitstringdefault: "10"query

Optional page size from 1 to 50; default 10.

default: "10" · max 2 chars

Response fields

requestIdstring

Request correlation UUID.

Upstream HTTP exchanges, decoded response bytes and duration in milliseconds.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

successboolean

True when usable public data is returned.

statusenum

success, partial, failed or challenged; HTTP 200 may be partial.

one of: success, partial

sourceUrlstring

Couchsurfing location search source.

absolute HTTPS URL

fetchedAtstring

UTC retrieval timestamp.

Complete refers only to supported fields; coverage.source is public_api. Warnings: record_limit.

coverage.sourceenum

Always included.

one of: public_api, public_page

coverage.completeboolean

Always included.

coverage.warningsstring[]

Always included.

locationsobject[]

Matching locations in source relevance order.

up to 50 items

totalCountintegernullable

Source total for the query, or null when unavailable. Very large result sets report the source cap.

hasNextPagebooleannullable

True when the source reports more records after this page.

nextCursorstringnullable

Cursor for the next page, or null on the last page.

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
200	`partial`	Usable page data with explicit coverage warnings.
400	`invalid_request`	Missing, duplicate, unsupported or malformed parameters.
401	`unauthorized`	Missing or invalid service key.
403	`restricted`	Private member profile.
404	`not_found`	Missing or deleted profile, event or location.
429	`upstream_rate_limited`	Source throttled retrieval.
502	`upstream_challenged`	The source challenged the request.
502	`unsupported_page`	Missing, malformed or mismatched structured source data.
502	`response_too_large` `payload_too_complex`	Byte, node or depth limit exceeded.
502	`unsafe_redirect` `request_limit` `upstream_error`	Bounded retrieval failed.
503	`busy`	All slots are occupied.
504	`timeout`	Deadline expired.

Code example

curl "https://api.scrapeatlas.com/v1/couchsurfing/locations?query=lisbon" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/couchsurfing/locations?query=lisbon",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/couchsurfing/locations?query=lisbon",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Couchsurfing request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/couchsurfing/locations",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "query": "lisbon"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/couchsurfing/locations?query=lisbon", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/couchsurfing/locations?query=lisbon"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "sourceUrl": "https://www.couchsurfing.com/api/locations.searchLocations",
  "fetchedAt": "2026-09-23T00:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 1400,
    "durationMs": 600
  },
  "locations": [
    {
      "locationId": "2pdz2WJdmBip066AlDnLGLMAHM0_lc",
      "description": "Lisbon, Lisbon District, Portugal",
      "country": "Portugal",
      "country2": "PT",
      "country3": "PRT",
      "region": "Lisbon District",
      "place": "Lisbon",
      "type": 0,
      "slug": "lisbon-lisbon-district-portugal",
      "relevanceScore": 23.82
    }
  ],
  "totalCount": 164,
  "hasNextPage": true,
  "nextCursor": "1"
}

Missing, duplicate, unsupported or malformed parameters.

{
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "success": false,
  "status": "failed",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}