---
title: "Search Couchsurfing hosts by location"
method: GET
path: "/v1/couchsurfing/hosts"
tags: ["Couchsurfing"]
---

# Search Couchsurfing hosts by location

`GET /v1/couchsurfing/hosts`

## Request

- Base URL: `https://api.scrapeatlas.com`
- URL: `https://api.scrapeatlas.com/v1/couchsurfing/hosts`
- Auth: API key in header `x-api-key`

Search the public hosts of a Couchsurfing location with optional sleeping-arrangement, pets, family, wheelchair, smoking and recent-activity filters: member cards with languages, interests, home location and reference counts, paged with a cursor. Each successful request costs 1 account credit, including partial results. Failed requests cost 0 credits.

## Query parameters

- `location` string, required
- `cursor` string
- `limit` string
- `sleepingArrangement` 'common_area' | 'private_room' | 'shared_room' | 'floor_or_tent' | 'other'
- `petsAllowed` 'true' | 'false'
- `familyFriendly` 'true' | 'false'
- `wheelchairAccessible` 'true' | 'false'
- `smokingAllowed` 'true' | 'false'
- `recentlyActive` 'true' | 'false'

## Response `200`

Inspect the response status and failure or coverage fields.

- union
  - object
    - `requestId` string, uuid, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_api' | 'public_page', required
      - `complete` boolean, required
      - `warnings` string[], required
    - `location` object, required
    - `hosts` object[], required
    - `totalCount` integer, nullable, required
    - `hasNextPage` boolean, nullable, required
    - `nextCursor` string, nullable, required
  - object
    - `requestId` string, uuid, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `failure` object, required
      - `code` 'restricted' | 'invalid_request' | 'unauthorized' | 'not_found' | 'upstream_challenged' | 'upstream_rate_limited' | 'upstream_error' | 'unsupported_page' | 'response_too_large' | 'unsafe_redirect' | 'request_limit' | 'timeout' | 'busy' | 'payload_too_complex', required
      - `message` string, required

## Other responses

- `400`: Request could not complete; inspect error or failure.code.
- `401`: Request could not complete; inspect error or failure.code.
- `402`: Request could not complete; inspect error or failure.code.
- `403`: Request could not complete; inspect error or failure.code.
- `404`: Request could not complete; inspect error or failure.code.
- `408`: Request could not complete; inspect error or failure.code.
- `413`: Request could not complete; inspect error or failure.code.
- `429`: Request could not complete; inspect error or failure.code.
- `500`: Request could not complete; inspect error or failure.code.
- `502`: Request could not complete; inspect error or failure.code.
- `503`: Request could not complete; inspect error or failure.code.
- `504`: Request could not complete; inspect error or failure.code.

---

[API](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api.md) · [All operations](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/revisions/9ba049316894?raw)