# Airdna — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search short-term rental markets to instantly access comprehensive performance metrics like average daily rates, occupancy rates, revenue, RevPAR, and market scores. Get detailed market overviews that help you compare rental performance across different locations and make data-driven decisions about investment opportunities.

**Category:** Real Estate | **Website:** [www.airdna.co/](https://www.airdna.co/) | **Docs:** [parse.bot/marketplace/67a87373-66bc-45fb-8d89-cc70348ad0e7/airdna-co-api](https://parse.bot/marketplace/67a87373-66bc-45fb-8d89-cc70348ad0e7/airdna-co-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/airdna/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get market overview

Get market-level short-term rental performance metrics for a city, including ADR, occupancy rate, annual revenue, RevPAR, active listings count, year-over-year changes, and AirDNA Market Score with subscores. Data covers the trailing twelve months. The city, state, and country inputs correspond to URL slugs (lowercase, hyphens for spaces).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | Yes | City or market name slug, lowercase with hyphens for spaces (e.g. 'denver', 'miami-beach'). |
| `country` | string | Yes | Country code slug (e.g. 'us', 'uk', 'ca'). |
| `state` | string | Yes | State or region name slug, lowercase with hyphens for spaces (e.g. 'colorado', 'new-york'). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/airdna/get-market-overview \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>","country":"<string>","state":"<string>"}'
```

### Search markets

Search for short-term rental markets and submarkets by name. Returns market IDs, location hierarchy, and region level (market or submarket). Use the returned country_code, state_name, and market_name to construct inputs for get_market_overview.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return (1-50). |
| `query` | string | Yes | Search query for a city, market, or neighborhood name (e.g. 'Denver', 'Miami Beach'). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/airdna/search-markets \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","query":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.