# Relocate — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search relocation guides and compare countries across visa requirements, job opportunities, salaries, cost of living, and healthcare information. Get detailed country overviews and salary data to make informed decisions about where to relocate for work.

**Category:** Travel | **Website:** [relocate.me/](https://relocate.me/) | **Docs:** [parse.bot/marketplace/747f3294-dc36-46ad-b554-95bc4e2383c4/relocate-me-api](https://parse.bot/marketplace/747f3294-dc36-46ad-b554-95bc4e2383c4/relocate-me-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-relocate-me-api-747f3294/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_countries_list

Returns all countries with relocation guides on relocate.me. Each country includes a name, URL slug, and direct link. Use the slug as input to all country-specific endpoints.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-relocate-me-api-747f3294/get_countries_list \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_country_cost_of_living

Returns cost of living details for a country, organized by topic sections such as rent, utilities, food, transport, and comparisons with other countries. Each section contains informational text.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `country_slug` | string | Yes | Country slug as returned by get_countries_list (e.g. 'germany', 'netherlands'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-relocate-me-api-747f3294/get_country_cost_of_living \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"country_slug":"<string>"}'
```

### get_country_healthcare

Returns a healthcare system overview for a country, organized by topic sections covering the healthcare system structure, insurance types, accessing care, and emergencies.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `country_slug` | string | Yes | Country slug as returned by get_countries_list (e.g. 'germany', 'netherlands'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-relocate-me-api-747f3294/get_country_healthcare \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"country_slug":"<string>"}'
```

### get_country_jobs

Returns currently listed tech job positions for a given country. Results vary based on live job postings and may be empty if no positions are currently available for that country.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `country_slug` | string | Yes | Country slug as returned by get_countries_list (e.g. 'germany', 'netherlands', 'portugal'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-relocate-me-api-747f3294/get_country_jobs \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"country_slug":"<string>"}'
```

### get_country_overview

Returns a country's relocation overview including a textual description, key facts (capital, currency, population, tax info), and metadata (author, moderator, last updated). The country_slug must match one returned by get_countries_list.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `country_slug` | string | Yes | Country slug as returned by get_countries_list (e.g. 'germany', 'united-kingdom', 'netherlands'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-relocate-me-api-747f3294/get_country_overview \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"country_slug":"<string>"}'
```

### get_country_salaries

Returns salary data for various tech roles in a country, including an average salary summary and per-role salary breakdowns.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `country_slug` | string | Yes | Country slug as returned by get_countries_list (e.g. 'germany', 'netherlands'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-relocate-me-api-747f3294/get_country_salaries \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"country_slug":"<string>"}'
```

### get_country_visas

Returns available visa types for a given country. Each visa entry has a type name and optionally a description or URL link to the detailed visa page.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `country_slug` | string | Yes | Country slug as returned by get_countries_list (e.g. 'germany', 'netherlands'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-relocate-me-api-747f3294/get_country_visas \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"country_slug":"<string>"}'
```

### get_salaries_overview

Returns a global salary comparison showing countries ranked by highest average monthly net salary. Useful for comparing earning potential across relocation destinations.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-relocate-me-api-747f3294/get_salaries_overview \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_visas_overview

Returns a global visas overview listing all countries that have visa guides available on relocate.me. Each entry includes the country name, slug, and URL.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-relocate-me-api-747f3294/get_visas_overview \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
