> ## 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.

# API examples

Runnable examples in cURL, Node.js, Python and Go. Each example makes one bounded request; no automatic retries or pagination.

## Get the examples

Clone the public examples repository: [https://github.com/realtycrawl/realtycrawl-api-examples](https://github.com/realtycrawl/realtycrawl-api-examples). Use Node.js 22+, Python 3.9+, or Go 1.22+. Set REALTYCRAWL\_API\_KEY in your environment for authenticated operations.

```bash theme={null}
git clone https://github.com/realtycrawl/realtycrawl-api-examples.git
cd realtycrawl-api-examples
node examples/node/01-capabilities.mjs
```

## Run a bounded search

First inspect capabilities for your platform and country. Set REALTYCRAWL\_IDEMPOTENCY\_KEY to a new unique value for a new logical search; keep it for a deliberate retry. The sample Zillow sale search has limit=1 and X-Max-Credits=50. Stored listing reads cost 1 credit. Run examples individually.

```bash theme={null}
export REALTYCRAWL_IDEMPOTENCY_KEY="my-search-unique-id"
node examples/node/02-search.mjs
```

## Keep the evidence

Read data together with meta.completeness, meta.sources, warnings and pagination. Keep price currency, period, area units, source URL and observation time. Never replace unknown values with zero.


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