API Endpoints

Explore all available endpoints in the XpatAI API.

Overview

The XpatAI API is organized around REST. Our API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL:

https://api.xpatai.xyz/v1

Countries

GET/countries

Returns a list of all available countries with basic information.

GET /v1/countries

GET/countries/:id

Returns detailed information about a specific country.

GET /v1/countries/japan

Cities

GET/cities

Returns a list of cities with basic information.

GET /v1/cities?country=japan

GET/cities/:id

Returns detailed information about a specific city.

GET /v1/cities/tokyo

Data

GET/data/cost-of-living/:city

Returns detailed cost of living data for a specific city.

GET /v1/data/cost-of-living/tokyo

GET/data/quality-of-life/:city

Returns quality of life metrics for a specific city.

GET /v1/data/quality-of-life/tokyo