Beginner
10 min

Use AirROI API with Postman

Access Airbnb revenue data, market analytics, and listing details without writing a single line of code. This step-by-step guide walks you through every click in Postman.

1

Install Postman

Download the Postman desktop app from postman.com/downloads for Windows, macOS, or Linux. Alternatively, use the web version directly in your browser at web.postman.co.

Tip

If you just want to try one request quickly, the web version is fastest — no download required. For ongoing API testing, the desktop app offers better collection management and offline access.

2

Create a New GET Request

Click the + tab to open a new request. Set the method dropdown to GET and enter the following URL:

url

https://api.airroi.com/calculator/estimate

Next, navigate to the Headers tab and add a new header:

Key

Value

X-API-KEY

YOUR_API_KEY

3

Add Query Parameters

Switch to the Params tab in Postman and add the following key-value pairs. Postman will automatically append them to the URL.

Key

Value

Description

lat

34.052235

Latitude of the property (Downtown LA)

lng

-118.243683

Longitude of the property (Downtown LA)

bedrooms

2

Number of bedrooms

baths

1

Number of bathrooms

guests

4

Maximum guest capacity

currency

usd

Currency for monetary values

Your complete URL should now read: https://api.airroi.com/calculator/estimate?lat=34.052235&lng=-118.243683&bedrooms=2&baths=1&guests=4&currency=usd

4

Send and Read the Response

Click the blue Send button. Postman will display the JSON response in the body panel below. Here is what each key field means:

revenue

$52,400

Projected annual revenue

average_daily_rate

$195

Average nightly price

occupancy

0.74 (74%)

Projected booking rate

percentiles

p25-p90

Performance distribution for revenue, ADR, and occupancy

monthly_revenue_distributions

12 values

Month-by-month revenue breakdown (Jan-Dec)

comparable_listings

Array

Actual listings used to generate the projection

json

{
  "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"
}

5

Try a POST Request

Some endpoints use POST requests with a JSON body. Let's search for Airbnb listings in Los Angeles. Create a new request, change the method to POST, and enter:

url

https://api.airroi.com/listings/search/market

Add the same X-API-KEY header, plus a Content-Type: application/json header. Then go to the Body tab, select raw, choose JSON from the dropdown, and paste:

json

{
  "market": {
    "country": "us",
    "region": "california",
    "locality": "los angeles"
  },
  "filter": {},
  "sort": {},
  "pagination": {
    "page_size": 10,
    "offset": 0
  },
  "currency": "usd"
}

Click Send. The response will contain an array of listings matching the market criteria, each with detailed property information, performance metrics, and pricing data. Use pagination.offset to page through results.

6

Export Results

Once you have a response you want to save, Postman gives you several options:

  • Save as JSON — Click the three-dot menu next to the response body and select "Save Response" then "Save to a file". Choose a location and save the .json file for further analysis.

  • Copy to clipboard — Click anywhere in the response body, press Ctrl+A (or Cmd+A) to select all, then copy. Paste into any text editor, spreadsheet, or data tool.

  • Export collection — Right-click your collection in the sidebar and choose "Export". This saves all your requests, headers, and parameters as a portable JSON file you can share with colleagues.

Pro tip

Create a Postman environment with your API key stored as a variable. Use {{api_key}} in the X-API-KEY header value so you never have to paste your key into every request manually.

Continue Learning

Keep exploring the AirROI API with these related tutorials.

Frequently Asked Questions

Yes. Postman offers a free plan that includes all the features you need for API testing. You can create collections, save requests, and test endpoints without paying anything. The free plan supports up to 25 requests per month in collections that use monitoring, but manual testing has no limits.

Both work. Postman is available as a desktop application for Windows, macOS, and Linux, or as a web application at postman.com. The web version has nearly identical functionality, so you can start testing immediately without installing anything.

Create a Collection in Postman (click the "+" icon in the sidebar). Save each request to the collection with a descriptive name. You can organize requests into folders (e.g., "Revenue", "Markets", "Listings") and share the entire collection with your team.

Yes, and this is recommended. Go to Environments in Postman, create a new environment called "AirROI", and add a variable named "api_key" with your key as the value. Then reference it in headers as {{api_key}}. This way you never hardcode your key into individual requests.

GET requests are used for simple lookups with query parameters in the URL (e.g., /calculator/estimate, /listings). POST requests are used for complex queries with a JSON body (e.g., /listings/search/market, /markets/summary). The API documentation specifies the method for each endpoint.

Ready to Build?

Get your API key and start making calls in minutes.
made with