> ## Documentation Index
> Fetch the complete documentation index at: https://docs.realtycrawl.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Your first request

Check a source, request one listing, then reuse its source-linked observation. The base URL is [https://realtycrawl.dev](https://realtycrawl.dev).

## 1. Create a live API key

Sign in at realtycrawl.dev/dashboard and create a live API key. Save the full value when it is shown; the server stores only its hash. Set REALTYCRAWL\_API\_KEY in your server or agent environment. Test keys do not execute source requests.

## 2. Check availability

This public endpoint needs no key. Confirm that searchPlatformListings has status active and that its geographies and supported\_filters cover your request. Availability is scoped to an operation and market.

```bash theme={null}
curl "https://realtycrawl.dev/v1/meta/capabilities?platform=zillow&country=US"
```

## 3. Search one sale listing

This verified Zillow request uses a contiguous-US bounding box in west, south, east, north order. X-Max-Credits limits this source crawl to 1 credit. Use a new idempotency key for a new logical request and preserve the same key and body if retrying.

```bash theme={null}
curl https://realtycrawl.dev/v1/zillow/listings/search \
  -H "Authorization: Bearer $REALTYCRAWL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "X-Max-Credits: 1" \
  -H "Idempotency-Key: my-first-zillow-search" \
  -d '{"location":{"kind":"bbox","bbox":[-97.82,30.2,-97.65,30.35]},"transaction":"sale","limit":1}'
```

## 4. Use the returned listing ID

Read the ID from data\[0].id. Listing and media endpoints read your account’s saved observation for up to 24 hours. They do not refresh the source. The deployed contract advertises 1 credit for a single-platform source search. Each stored-observation read uses 1 credit.

```bash theme={null}
curl "https://realtycrawl.dev/v1/listings/$LISTING_ID" \
  -H "Authorization: Bearer $REALTYCRAWL_API_KEY" \
  -H "X-Max-Credits: 1"
```

## 5. Try unified search

POST /v1/listings/search accepts the same selectors plus platforms. Start with one source: \{"platforms":\["zillow"],"location":\{"kind":"bbox","bbox":\[-97.82,30.2,-97.65,30.35]},"transaction":"sale","limit":1}. Check each source’s selectors before requesting a different platform. Do not infer that all 200 researched platforms are available.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.