apiverve/costliving

Cost of Living provides cost of living indices for US regions based on major metropolitan area data. Compare the relative cost of living between states, cities, or regions and calculate salary equivalents for relocation decisions.

dev-main 2026-07-16 20:12 UTC

Requires

• php: >=7.4
• guzzlehttp/guzzle: ^7.0

Requires (Dev)

• phpunit/phpunit: ^9.0

MIT

• APIVerve

• api
• apiverve
• costliving
• cost of living
• cost of living index
• city comparison
• state comparison
• living expenses

Published on Packagist.org on 2026-07-16 20:23 UTC

README

Cost of Living provides cost of living indices for US regions based on major metropolitan area data. Compare the relative cost of living between states, cities, or regions and calculate salary equivalents for relocation decisions.

The Cost of Living API provides a simple, reliable way to integrate cost of living functionality into your applications. Built for developers who need production-ready cost of living capabilities without the complexity of building from scratch.

View API Details →

Available on:

Quick Start

Using JavaScript

async function callCostofLivingAPI() {
    try {
        const params = new URLSearchParams({
            location: 'California'
        });

        const response = await fetch(`https://api.apiverve.com/v1/costliving?${params}`, {
            method: 'GET',
            headers: {
                'x-api-key': 'YOUR_API_KEY_HERE'
            }
        });

        const data = await response.json();
        console.log(data);
    } catch (error) {
        console.error('Error:', error);
    }
}

callCostofLivingAPI();

Using cURL

curl -X GET "https://api.apiverve.com/v1/costliving?location=California" \
  -H "x-api-key: YOUR_API_KEY_HERE"

Get your API key: https://apiverve.com

📁 For more examples, see the examples folder

Installation

Choose your preferred programming language:

📦 NPM (JavaScript/Node.js)

npm install @apiverve/costliving

View NPM Package → | Package Code →

🔷 NuGet (.NET/C#)

dotnet add package APIVerve.API.CostofLiving

View NuGet Package → | Package Code →

🐍 Python (PyPI)

pip install apiverve-costliving

View PyPI Package → | Package Code →

💎 Ruby (RubyGems)

gem install apiverve_costliving

View RubyGems Package → | Package Code →

🐘 PHP (Packagist)

composer require apiverve/costliving

View Packagist Package → | Package Code →

🎯 Dart (pub.dev)

dart pub add apiverve_costliving

View pub.dev Package → | Package Code →

🤖 Android (JitPack)

implementation 'com.github.apiverve:costliving-api:1.0.0'

Package Code →

🐹 Go

go get github.com/apiverve/costliving-api/go

Package Code →

Why Use This API?

Feature	Benefit
Multi-language SDKs	Native packages for JavaScript, Python, C#, Go, and Android
Simple Integration	Single API key authentication, consistent response format
Production Ready	99.9% uptime SLA, served from 24 global regions
Comprehensive Docs	Full examples, OpenAPI spec, and dedicated support

Documentation

• 🏠 API Home: Cost of Living API
• 📚 API Reference: docs.apiverve.com/ref/costliving
• 📖 OpenAPI Spec: openapi.yaml
• 💡 Examples: examples/

What Can You Build?

The Cost of Living API is commonly used for:

• Web Applications - Add cost of living features to your frontend or backend
• Mobile Apps - Native SDKs for Android development
• Automation - Integrate with n8n, Zapier, or custom workflows
• SaaS Products - Enhance your product with cost of living capabilities
• Data Pipelines - Process and analyze data at scale

API Reference

Authentication

All requests require an API key in the header:

x-api-key: YOUR_API_KEY_HERE

Get your API key: https://apiverve.com

Response Format

Every APIVerve endpoint returns the same envelope — check status, then read data:

{
  "status": "ok",
  "error": null,
  "data": { ... }
}

Example Response

A real response from the Cost of Living API:

{
  "status": "ok",
  "error": null,
  "data": {
    "from": {
      "searchedLocation": "California",
      "region": "west-large",
      "regionName": "West Large Metros (LA, SF, Seattle, Phoenix, Denver area)",
      "costIndex": 118
    },
    "to": {
      "searchedLocation": "Texas",
      "region": "south-large",
      "regionName": "South Large Metros (Dallas, Houston, Atlanta, Miami, DC area)",
      "costIndex": 103
    },
    "comparison": {
      "costDifference": -12.7,
      "direction": "less expensive",
      "salaryEquivalent": {
        "description": "A $100,000 salary in California is equivalent to $87,288 in Texas",
        "fromSalary": 100000,
        "equivalentSalary": 87288
      }
    }
  }
}

Support & Community

• 🏠 API Home: Cost of Living API
• 💬 Support: https://apiverve.com/contact
• 🐛 Issues: GitHub Issues
• 📖 Documentation: https://docs.apiverve.com
• 🌐 Website: https://apiverve.com

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Security

For security concerns, please review our Security Policy.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Built with ❤️ by APIVerve

Copyright © 2026 APIVerve. All rights reserved.