Skip to main content

Cost of Living API

Cost of Living is a cost of living API that provides index values for US regions based on major metropolitan area data. Compare the relative cost of living between states or cities, each mapped to its Census region, and calculate salary equivalents for relocation decisions on paid plans.

PyPI version

This is a Python wrapper for the Cost of Living API


Installation

Using pip:

pip install apiverve-costofliving

Using pip3:

pip3 install apiverve-costofliving

Configuration

Before using the Cost of Living API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_costofliving.apiClient import CostlivingAPIClient

# Initialize the client with your APIVerve API key
api = CostlivingAPIClient("[YOUR_API_KEY]")

query = { "location": "California" }

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Cost of Living API documentation is found here: https://docs.apiverve.com/ref/costliving. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_costofliving.apiClient import CostlivingAPIClient

# Initialize the client with your APIVerve API key
api = CostlivingAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = { "location": "California" }
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "searchedLocation": "California",
    "region": "west-large",
    "regionName": "West Large Metros (LA, SF, Seattle, Phoenix, Denver area)",
    "costIndex": 107,
    "description": "7% above average",
    "cpi": 356.993,
    "usAverageCPI": 334.98,
    "period": "2026-08",
    "note": "Cost index is relative to US average (100). Values above 100 indicate higher than average cost of living."
  }
}

Error Handling

The API client provides comprehensive error handling through the CostlivingAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_costofliving.apiClient import CostlivingAPIClient, CostlivingAPIClientError

api = CostlivingAPIClient("[YOUR_API_KEY]")

query = { "location": "California" }

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except CostlivingAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_costofliving.apiClient import CostlivingAPIClient, CostlivingAPIClientError

api = CostlivingAPIClient("[YOUR_API_KEY]")

query = { "location": "California" }

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except CostlivingAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_costofliving.apiClient import CostlivingAPIClient, CostlivingAPIClientError

query = { "location": "California" }

# Using context manager ensures proper cleanup
with CostlivingAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except CostlivingAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_costofliving.apiClient import CostlivingAPIClient

# Enable debug mode
api = CostlivingAPIClient("[YOUR_API_KEY]", debug=True)

query = { "location": "California" }

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_costofliving.apiClient import CostlivingAPIClient

api = CostlivingAPIClient("[YOUR_API_KEY]")

query = { "location": "California" }

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Metadata

Release files for apiverve-costofliving 1.2.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apiverve-costofliving 1.2.4
File Size Uploaded Provenance Actions
apiverve_costofliving-1.2.4.tar.gz 10.7 kB Without provenance Details for apiverve_costofliving-1.2.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for apiverve-costofliving 1.2.4
File Interpreter ABI Platform Actions
apiverve_costofliving-1.2.4-py3-none-any.whl Python 3 none any Details for apiverve_costofliving-1.2.4-py3-none-any.whl

Total release size: 21.2 kB

Release files / apiverve_costofliving-1.2.4.tar.gz

Download URL apiverve_costofliving-1.2.4.tar.gz
Size 10.7 kB
Tags Source
SHA-256 checksum
How to use checksums
c447eed5ad3f965767276eb6adfb8b9ecbbcdbe266a2b86d3deea93633c9aa4b
BLAKE2b-256 checksum
How to use checksums
420c64f34d8d6c0fa1cb4e156451e3b28ac68cc427069be8206486dfeecbf39b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.6

Release files / apiverve_costofliving-1.2.4-py3-none-any.whl

Download URL apiverve_costofliving-1.2.4-py3-none-any.whl
Size 10.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
18882a92780673fc0067f27e4fadafe78b7626511db03161ef800983a2e14b8f
BLAKE2b-256 checksum
How to use checksums
8641a1ea2720656c55112583c146c846989b1f68ee0cf01fafe7d000b104ed74
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.6

Security for apiverve-costofliving 1.2.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page