# Freecash — 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.

> Track Freecash earnings and platform activity by accessing the public leaderboard, recent withdrawals, real-time stats, available offers, and cashout methods. Monitor top earners, browse featured money-making opportunities, and see what payout options are available.

**Category:** Finance & Markets | **Website:** [freecash.io/](https://freecash.io/) | **Docs:** [parse.bot/marketplace/0076fa84-e4a6-48e3-977f-2e7c5164d00b/freecash-io-api](https://parse.bot/marketplace/0076fa84-e4a6-48e3-977f-2e7c5164d00b/freecash-io-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-freecash-io-api-0076fa84/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_cashout_methods

Retrieve available cashout/withdrawal methods on Freecash, including cash options, cryptocurrencies, and gift cards.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-freecash-io-api-0076fa84/get_cashout_methods \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_featured_offers

Retrieve featured offers shown on the Freecash homepage. Returns offer names extracted from the current homepage content. The list changes periodically as offers are rotated.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-freecash-io-api-0076fa84/get_featured_offers \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_leaderboard

Retrieve the earnings leaderboard showing top earners on the platform.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results per page. |
| `page` | integer | No | Page number. |
| `period` | string | No | Time period: DAILY, WEEKLY, MONTHLY. |
| `source` | string | No | Earning source, usually COINS. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-freecash-io-api-0076fa84/get_leaderboard \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","page":"<integer>","period":"<string>","source":"<string>"}'
```

### get_offer_categories

Retrieve available offer categories on Freecash. Returns a static list of category types users can earn from.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-freecash-io-api-0076fa84/get_offer_categories \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_stats

Retrieve overall platform statistics shown on the Freecash homepage, including total earnings, average withdrawal yesterday, registered user count, and average time to first cash.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-freecash-io-api-0076fa84/get_stats \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_withdrawals

Retrieve the recent withdrawal activity feed from Freecash. Returns real-time withdrawal transactions including username, amount, method, and country. Paginates via limit parameter; results are ordered by most recent first.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `country_code` | string | No | Filter by country code. Accepted values: ALL (no filter), US, CA, DE, GB, SE, PL, and other ISO 2-letter country codes. |
| `limit` | integer | No | Number of withdrawal items to retrieve. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-freecash-io-api-0076fa84/get_withdrawals \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"country_code":"<string>","limit":"<integer>"}'
```