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

> 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 for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/bitcoin-well/`
**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 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.beta.paywithlocus.com/api/wrapped/credits/bitcoin-well/get-atm-detail \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/bitcoin-well/get-atm-filter-types \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/bitcoin-well/get-atm-locations \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/bitcoin-well/get-atm-locations-by-city \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/bitcoin-well/get-atm-locations-by-province \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/bitcoin-well/get-bitcoin-price-cad \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/bitcoin-well/get-bitcoin-price-usd \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/bitcoin-well/get-blog-posts \
  -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.