# Bitcoin Well — 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.

> Access live Bitcoin prices in CAD and USD, find Bitcoin Well ATM locations across Canada by province or city, and read the latest blog posts from Bitcoin Well. Filter ATMs by type and view detailed information about specific locations to plan your cryptocurrency transactions.

**Category:** Web3 & Onchain | **Website:** [bitcoinwell.com/](https://bitcoinwell.com/) | **Docs:** [parse.bot/marketplace/63ea9ea4-0b0e-4be6-9d73-eb7bd320f35b/bitcoinwell-com-api](https://parse.bot/marketplace/63ea9ea4-0b0e-4be6-9d73-eb7bd320f35b/bitcoinwell-com-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-bitcoinwell-com-api-63ea9ea4/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_atm_detail

Get full details for a specific Bitcoin ATM by its slug path. Searches the map widget data by slug name match and returns the ATM's name, address, phone, hours, coordinates, and image URL.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug` | string | Yes | Slug in format province/city/atm-slug (e.g. alberta/calgary/pine-creek-convenience, manitoba/winnipeg/winnipeg, ontario/hamilton/heritage-smoke). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bitcoinwell-com-api-63ea9ea4/get_atm_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"slug":"<string>"}'
```

### get_atm_filter_types

Get available ATM filter/service types from the map widget categories. Returns the list of service types that ATMs can be filtered by.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bitcoinwell-com-api-63ea9ea4/get_atm_filter_types \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_atm_locations

Get all Bitcoin ATM locations in Canada and US from the map widget. Returns all locations in a single response.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bitcoinwell-com-api-63ea9ea4/get_atm_locations \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_atm_locations_by_city

Get Bitcoin ATM locations in a specific city. Searches all ATM addresses for the city name match.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | Yes | City name to search for in ATM addresses (e.g. Calgary, Winnipeg, Edmonton). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bitcoinwell-com-api-63ea9ea4/get_atm_locations_by_city \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>"}'
```

### get_atm_locations_by_province

Get Bitcoin ATM locations grouped by city for a specific province. Returns normalized ATM data grouped by parsed city name.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `province` | string | Yes | Province name. Accepted values: Alberta, Manitoba, Ontario, British-Columbia, Saskatchewan, Quebec, Nova-Scotia, New-Brunswick. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bitcoinwell-com-api-63ea9ea4/get_atm_locations_by_province \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"province":"<string>"}'
```

### get_bitcoin_price_cad

Get current live Bitcoin price in Canadian Dollars (CAD) including buy/sell prices with spread and hourly OHLC chart data for the past 168 hours.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bitcoinwell-com-api-63ea9ea4/get_bitcoin_price_cad \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_bitcoin_price_usd

Get current live Bitcoin price in US Dollars (USD) including buy/sell prices with spread and hourly OHLC chart data for the past 168 hours.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bitcoinwell-com-api-63ea9ea4/get_bitcoin_price_usd \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_blog_posts

Get all recent blog posts from Bitcoin Well. Returns posts in reverse chronological order with title, description, author, cover image, and publication date.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bitcoinwell-com-api-63ea9ea4/get_blog_posts \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```