Your First API Call in 5 Minutes

Get Your API Key

Sign up at the AirROI Developer Portal. Account creation is instant — no approval process, no waiting period. Once signed in, add a minimum of $10 in API credits to activate your key. Then copy your API key from the Developer Dashboard.

Make Your First Request

Let's estimate the revenue potential for a 2-bedroom apartment in downtown Los Angeles. The /calculator/estimate endpoint takes latitude, longitude, bedrooms, baths, and guest count — and returns projected annual revenue, ADR, and occupancy with percentile breakdowns.

curl -X GET \
  "https://api.airroi.com/calculator/estimate?lat=34.052235&lng=-118.243683&bedrooms=2&baths=1&guests=4&currency=usd" \
  -H "X-API-KEY: YOUR_API_KEY"

Read the Response

The API returns a comprehensive revenue projection. Here is what each field means:

The percentiles object provides performance distributions (p25, p50, p75, p90) for revenue, ADR, and occupancy. The monthly_revenue_distributions array contains 12 monthly revenue values, and comparable_listings shows the actual listings used to generate the projection.

{
  "revenue": 52400,
  "average_daily_rate": 195,
  "occupancy": 0.74,
  "percentiles": {
    "revenue": {
      "avg": 52400, "p25": 38200, "p50": 49800,
      "p75": 61500, "p90": 78300
    },
    "average_daily_rate": {
      "avg": 195, "p25": 145, "p50": 185,
      "p75": 235, "p90": 310
    },
    "occupancy": {
      "avg": 0.74, "p25": 0.58, "p50": 0.72,
      "p75": 0.85, "p90": 0.93
    }
  },
  "monthly_revenue_distributions": [
    3200, 3400, 4100, 4800, 5600, 5900,
    6200, 5800, 4600, 3900, 3100, 3800
  ],
  "comparable_listings": [
    {
      "listing_id": "12345678",
      "revenue": 48200,
      "average_daily_rate": 180,
      "occupancy": 0.73,
      "bedrooms": 2,
      "distance_miles": 0.3
    }
  ],
  "currency": "usd"
}

Try 3 Core Workflows

Now that you have the basics, explore the three main ways to query AirROI data.

A. Search a Market

Find all active Airbnb listings in a market. Use POST /listings/search/market with a market object specifying country, region, and locality.

curl -X POST "https://api.airroi.com/listings/search/market" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "market": {
      "country": "us",
      "region": "california",
      "locality": "los angeles"
    },
    "pagination": { "page_size": 10, "offset": 0 },
    "currency": "usd"
  }'

B. Look Up a Listing

Get detailed data on a specific Airbnb listing by its ID using GET /listings?id=12345678. Returns listing info, host info, location, property details, pricing, ratings, and performance metrics.

curl -X GET \
  "https://api.airroi.com/listings?id=12345678&currency=usd" \
  -H "X-API-KEY: YOUR_API_KEY"

C. Get Market Metrics

Pull aggregate market statistics using POST /markets/summary. Returns occupancy, ADR, RevPAR, revenue, booking lead time, length of stay, and active listings count.

curl -X POST "https://api.airroi.com/markets/summary" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "market": {
      "country": "us",
      "region": "california",
      "locality": "los angeles"
    },
    "currency": "usd",
    "num_months": 12
  }'

Next Steps

You have made your first API call and explored the three core workflows. Here is where to go next: