Skip to main content
POST
/
v2
/
listing
/
quietness
Multiple Locations Quietness
curl --request POST \
  --url https://api.calmyx.com/v2/listing/quietness \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "listings": [
    {}
  ]
}
'
{
    "status": "OK",
    "summary": {
        "total": 3,
        "successful": 3,
        "failed": 0
    },
    "results": [
        {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "status": "OK",
            "request": {
                "lat": 35.0925734,
                "lng": -106.5883558
            },
            "response": {
                "listing_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                "lat": 35.092573,
                "lng": -106.588356,
                "quiet_score": 70,
                "quiet_score_range": {
                    "min": 0,
                    "max": 100
                },
                "quietness_level": "Quiet",
                "quietness_description": "Generally calm with occasional everyday sounds.",
                "quiet_day_night": {
                    "day_window_local": "07:00-22:00",
                    "night_window_local": "22:00-07:00",
                    "quiet_score_day": 75,
                    "quiet_score_night": 65,
                    "estimated_noise_db_day": 48.2,
                    "estimated_noise_db_night": 42.5,
                    "noise_db_unit": "dBA"
                },
                "noise_sources": [
                    {
                        "name": "Highways/Freeways",
                        "nearest_source": "Freeway Ramp",
                        "distance": 0.72,
                        "category": "major_highways",
                        "estimated_effective_db": 73.5
                    }
                ],
                "quiet_score_confidence": "high",
                "quiet_score_confidence_values": ["low", "medium", "high"],
                "created_at": "2026-01-15T05:17:16.471569",
                "updated_at": "2026-01-15T05:17:16.471569"
            }
        },
        {
            "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
            "status": "OK",
            "request": {
                "lat": 37.7749,
                "lng": -122.4194
            },
            "response": {
                "listing_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
                "lat": 37.7749,
                "lng": -122.4194,
                "quiet_score": 45,
                "quiet_score_range": {
                    "min": 0,
                    "max": 100
                },
                "quietness_level": "Moderate",
                "quietness_description": "Typical city or suburban noise you'll notice but likely get used to.",
                "quiet_day_night": {
                    "day_window_local": "07:00-22:00",
                    "night_window_local": "22:00-07:00",
                    "quiet_score_day": 42,
                    "quiet_score_night": 55,
                    "estimated_noise_db_day": 58.5,
                    "estimated_noise_db_night": 48.2,
                    "noise_db_unit": "dBA"
                },
                "noise_sources": [...],
                "quiet_score_confidence": "high",
                "quiet_score_confidence_values": ["low", "medium", "high"],
                "created_at": "2026-01-15T05:17:18.123456",
                "updated_at": "2026-01-15T05:17:18.123456"
            }
        },
        {
            "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
            "status": "OK",
            "request": {
                "lat": 40.7128,
                "lng": -74.0060
            },
            "response": {
                "listing_id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
                "lat": 40.7128,
                "lng": -74.006,
                "quiet_score": 25,
                "quiet_score_range": {
                    "min": 0,
                    "max": 100
                },
                "quietness_level": "Noisy",
                "quietness_description": "Frequent noise that can affect comfort, focus, or sleep.",
                "quiet_day_night": {
                    "day_window_local": "07:00-22:00",
                    "night_window_local": "22:00-07:00",
                    "quiet_score_day": 20,
                    "quiet_score_night": 35,
                    "estimated_noise_db_day": 72.1,
                    "estimated_noise_db_night": 62.5,
                    "noise_db_unit": "dBA"
                },
                "noise_sources": [...],
                "quiet_score_confidence": "high",
                "quiet_score_confidence_values": ["low", "medium", "high"],
                "created_at": "2026-01-10T12:00:00.000000",
                "updated_at": "2026-01-15T05:17:20.789012"
            }
        }
    ],
    "timestamp_utc": "2026-01-15T05:17:21.000000"
}

​
Overview

The Multiple Locations Quietness API calculates the Quiet Score™ for multiple locations at once and automatically manages your listings. This is the batch version of the quietness API - ideal for processing multiple properties at once.
To obtain an API key, register for an account and subscribe to a plan.

​
How It Works

For each listing in your request:
  1. Check Listing: Verifies if you already have a listing at this geolocation
  2. Check Freshness: If listing exists, checks if the quietness data needs refresh based on your plan
  3. Calculate: If needed, calculates the Quiet Score™ using our patent-pending AI
  4. Update: Creates or updates your listing with the latest quietness data

​
Refresh Rates by Plan

PlanRefresh Rate
Trial1 day
Insight30 days
Intelligence7 days
Enterprise1 day

​
Authorization

​
Authorization
string
required
Your API key for authentication

​
Request Body

​
listings
array
required
Array of listing objects to get quietness for. Each object must contain lat (float) and lng (float) coordinates.

​
Request Structure

FieldTypeRequiredDescription
listingsarrayYesArray of listing objects
listings[].latfloatYesLatitude coordinate of the location
listings[].lngfloatYesLongitude coordinate of the location
{
    "status": "OK",
    "summary": {
        "total": 3,
        "successful": 3,
        "failed": 0
    },
    "results": [
        {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "status": "OK",
            "request": {
                "lat": 35.0925734,
                "lng": -106.5883558
            },
            "response": {
                "listing_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                "lat": 35.092573,
                "lng": -106.588356,
                "quiet_score": 70,
                "quiet_score_range": {
                    "min": 0,
                    "max": 100
                },
                "quietness_level": "Quiet",
                "quietness_description": "Generally calm with occasional everyday sounds.",
                "quiet_day_night": {
                    "day_window_local": "07:00-22:00",
                    "night_window_local": "22:00-07:00",
                    "quiet_score_day": 75,
                    "quiet_score_night": 65,
                    "estimated_noise_db_day": 48.2,
                    "estimated_noise_db_night": 42.5,
                    "noise_db_unit": "dBA"
                },
                "noise_sources": [
                    {
                        "name": "Highways/Freeways",
                        "nearest_source": "Freeway Ramp",
                        "distance": 0.72,
                        "category": "major_highways",
                        "estimated_effective_db": 73.5
                    }
                ],
                "quiet_score_confidence": "high",
                "quiet_score_confidence_values": ["low", "medium", "high"],
                "created_at": "2026-01-15T05:17:16.471569",
                "updated_at": "2026-01-15T05:17:16.471569"
            }
        },
        {
            "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
            "status": "OK",
            "request": {
                "lat": 37.7749,
                "lng": -122.4194
            },
            "response": {
                "listing_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
                "lat": 37.7749,
                "lng": -122.4194,
                "quiet_score": 45,
                "quiet_score_range": {
                    "min": 0,
                    "max": 100
                },
                "quietness_level": "Moderate",
                "quietness_description": "Typical city or suburban noise you'll notice but likely get used to.",
                "quiet_day_night": {
                    "day_window_local": "07:00-22:00",
                    "night_window_local": "22:00-07:00",
                    "quiet_score_day": 42,
                    "quiet_score_night": 55,
                    "estimated_noise_db_day": 58.5,
                    "estimated_noise_db_night": 48.2,
                    "noise_db_unit": "dBA"
                },
                "noise_sources": [...],
                "quiet_score_confidence": "high",
                "quiet_score_confidence_values": ["low", "medium", "high"],
                "created_at": "2026-01-15T05:17:18.123456",
                "updated_at": "2026-01-15T05:17:18.123456"
            }
        },
        {
            "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
            "status": "OK",
            "request": {
                "lat": 40.7128,
                "lng": -74.0060
            },
            "response": {
                "listing_id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
                "lat": 40.7128,
                "lng": -74.006,
                "quiet_score": 25,
                "quiet_score_range": {
                    "min": 0,
                    "max": 100
                },
                "quietness_level": "Noisy",
                "quietness_description": "Frequent noise that can affect comfort, focus, or sleep.",
                "quiet_day_night": {
                    "day_window_local": "07:00-22:00",
                    "night_window_local": "22:00-07:00",
                    "quiet_score_day": 20,
                    "quiet_score_night": 35,
                    "estimated_noise_db_day": 72.1,
                    "estimated_noise_db_night": 62.5,
                    "noise_db_unit": "dBA"
                },
                "noise_sources": [...],
                "quiet_score_confidence": "high",
                "quiet_score_confidence_values": ["low", "medium", "high"],
                "created_at": "2026-01-10T12:00:00.000000",
                "updated_at": "2026-01-15T05:17:20.789012"
            }
        }
    ],
    "timestamp_utc": "2026-01-15T05:17:21.000000"
}

​
Summary Response Fields

FieldTypeDescription
totalnumberTotal number of listings in the request
successfulnumberNumber of listings successfully processed
failednumberNumber of listings that failed to process

​
Individual Result Fields

Each result in the results array is a dictionary with an id field containing the listing_id (UUID format) for successful results, or a temporary ID (like error_1, limit_reached_2) for errors.
FieldTypeDescription
idstringListing ID (UUID) for successful results, or error identifier (e.g., error_1, limit_reached_2) for failures
statusstring”OK” for success, “ERROR” for general failure, “LIMIT_REACHED” when listing limit is hit
request.latnumberOriginal latitude from the request
request.lngnumberOriginal longitude from the request
responseobjectFull listing data (same as single location quietness response) - only present for successful results
errorstringError message (present when status is “ERROR” or “LIMIT_REACHED”)

​
Status Values

StatusDescription
OKListing was successfully created/updated
ERRORGeneral error (invalid coordinates, server error, etc.)
LIMIT_REACHEDYour plan’s listing limit has been reached. Quietness data may still be included in the response, but no listing was created.

​
Response Fields (for each successful listing)

FieldTypeDescription
listing_idstringUnique identifier for your listing
latnumberLatitude of the listing (rounded to 6 decimal places)
lngnumberLongitude of the listing (rounded to 6 decimal places)
quiet_scorenumberScore from 0-100 (higher = quieter)
quiet_score_rangeobjectThe valid range for the quiet score (min: 0, max: 100)
quietness_levelstringHuman-readable rating
quietness_descriptionstringDescription of what living there feels like
quiet_day_nightobjectDay/night specific quietness data
noise_sourcesarrayArray of noise source objects
quiet_score_confidencestringConfidence level: “low”, “medium”, or “high”
created_atstringISO 8601 timestamp of when the listing was created
updated_atstringISO 8601 timestamp of when the listing was last updated

​
Day/Night Fields (quiet_day_night)

The quiet_day_night object provides separate quietness analysis for daytime and nighttime periods:
FieldTypeDescription
day_window_localstringDaytime hours (e.g., “07:00-22:00”)
night_window_localstringNighttime hours (e.g., “22:00-07:00”)
quiet_score_daynumberQuiet Score™ during daytime (0-100)
quiet_score_nightnumberQuiet Score™ during nighttime (0-100)
estimated_noise_db_daynumberEstimated noise level during day in dBA
estimated_noise_db_nightnumberEstimated noise level during night in dBA
noise_db_unitstringUnit of measurement for dB values (“dBA”)

​
Limits

  • Maximum listings per request: 20
  • Each listing counts against your plan’s listing limit
  • If you hit your listing limit mid-batch, subsequent locations will have status: "LIMIT_REACHED"

​
Handling Listing Limit

When you hit your plan’s listing limit during a batch request:
  1. The API will not break - it continues processing all locations
  2. Locations that exceed the limit will have status: "LIMIT_REACHED"
  3. The summary.failed count will include these limit-reached items
  4. Quietness data may still be calculated and returned (but no listing is created)

​
Example: Partial Success with Limit Reached

{
    "status": "OK",
    "summary": {
        "total": 3,
        "successful": 2,
        "failed": 1
    },
    "results": [
        {
            "id": "a1b2c3d4-...",
            "status": "OK",
            "request": { "lat": 35.09, "lng": -106.58 },
            "response": { ... }
        },
        {
            "id": "b2c3d4e5-...",
            "status": "OK", 
            "request": { "lat": 37.77, "lng": -122.41 },
            "response": { ... }
        },
        {
            "id": "limit_reached_3",
            "status": "LIMIT_REACHED",
            "request": { "lat": 40.71, "lng": -74.00 },
            "error": "Listing limit reached (100). Please upgrade or delete existing listings.",
            "response": {
                "quiet_score": 45,
                "quietness_level": "Moderate",
                "quiet_day_night": {
                    "day_window_local": "07:00-22:00",
                    "night_window_local": "22:00-07:00",
                    "quiet_score_day": 42,
                    "quiet_score_night": 55,
                    "estimated_noise_db_day": 58.5,
                    "estimated_noise_db_night": 48.2,
                    "noise_db_unit": "dBA"
                },
                ...
            }
        }
    ],
    "timestamp_utc": "2026-01-15T05:17:21.000000"
}

​
Notes

  • Results are processed in parallel for optimal performance
  • Failed listings don’t stop the processing of remaining locations
  • Coordinates should be in decimal degrees format (WGS84)
  • Each result contains an id field: listing_id (UUID) for successful results, or error identifiers like error_1, limit_reached_2 for failures
  • Results are returned in the same order as the input request
  • Day/night scores help users understand noise patterns throughout the day - night scores are typically higher (quieter) for residential areas