Skip to content
ScoutingAPI
Docs

Getting started

Quickstart

Zero to your first successful call in under five minutes. Grab a free key, export it, and run one request — no infrastructure, no partner application.

1 · Get a free key

Create an account — 300 credits, no credit card. On sign-up you can create two kinds of key:

  1. Sandbox keys (stay_test_…) return deterministic fixtures at zero credits and work immediately — perfect for building and CI.
  2. Live keys (stay_live_…) run real cross-platform scrapes. Live credits unlock after a one-click email verification.

Export your key

Keep the key out of source control. Set it once in your shell:
export STAYINGAPI_KEY="stay_test_…"

2 · Make your first call

Search for stays across two platforms at once. The same request works with a sandbox or a live key and returns the identical data schema — but the transport differs: sandbox (and live cache hits) answer synchronously, while a live scrape is asynchronous.

curl -sS "https://api.stayingapi.com/v1/search?location=Split,HR&platforms=airbnb,booking&limit=5" \
  -H "Authorization: Bearer $STAYINGAPI_KEY"

Live calls return a 202 you poll — the SDK handles it

A stay_test_ key returns 200 with results directly. A stay_live_ call that has to scrape returns 202 with a data.jobId; poll GET /v1/jobs/{jobId} (free) until it completes and read the payload from data.result. Jobs can take several minutes. The SDK auto-polls for you, so the JavaScript example above works unchanged on a live key.

3 · Read the response

Every response is the same three-part envelope: data (normalized to the unified schema), and meta (request id, per-platform results, credits, pagination, warnings). Learn the shape on the response envelope page.

4 · Run it here, no sign-up

The console below makes a real sandbox call from your browser — a genuine 200, zero credits. Edit the fields and run it, or paste your own key.

Try itsandbox · 0 credits · no sign-up
GET/v1/search

Runs against the deterministic Airbnb + Booking sandbox fixtures — a real 200, zero credits.

Response

Run the call to see a live, deterministic sandbox response.

Copy as curl
curl -sS "https://api.stayingapi.com/v1/search" \
  -H "Authorization: Bearer $STAYINGAPI_KEY"

Next steps

Add authentication details, explore the flagship price-compare endpoint, or install the TypeScript SDK. Need your plan or remaining credits from code? Call GET /v1/account — free, synchronous, live or sandbox.