# Relocate — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.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 for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/relocate/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## 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.beta.paywithlocus.com/api/wrapped/credits/relocate/get-countries-list \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/relocate/get-country-cost-of-living \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/relocate/get-country-healthcare \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/relocate/get-country-jobs \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/relocate/get-country-overview \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/relocate/get-country-salaries \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/relocate/get-country-visas \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/relocate/get-salaries-overview \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/relocate/get-visas-overview \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.