# Vfat — 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 yield farming opportunities, compare token liquidity and lending rates across 30+ blockchains, and monitor your DeFi portfolio performance in real-time. Analyze farm details, platform statistics, and market data to make informed decisions about where to deploy your assets.

**Category:** Web3 & Onchain | **Website:** [vfat.io/](https://vfat.io/) | **Docs:** [parse.bot/marketplace/78a55a37-e140-4ffe-a9ce-a3a5a5479164/vfat-io-api](https://parse.bot/marketplace/78a55a37-e140-4ffe-a9ce-a3a5a5479164/vfat-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-vfat-io-api-78a55a37/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_chains

Retrieve the list of supported blockchains on vfat.io, including RPC URLs, contract addresses, and native currency details. Returns all chains in a single response with no pagination.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-vfat-io-api-78a55a37/get_chains \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_data_freshness

Retrieve the data freshness status for each supported blockchain, showing block lag and time delay of aggregated data.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-vfat-io-api-78a55a37/get_data_freshness \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_farm_detail

Retrieve detailed data for a specific farm by searching for its contract address on a given chain. Returns pool composition, rewards, APR, and liquidity metrics. Returns input_not_found if no farm matches.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `address` | string | Yes | Farm contract address (e.g. 0x4f09bab2f0e15e2a078a227fe1537665f55b8360). |
| `chain_id` | integer | Yes | Blockchain chain ID (e.g. 8453 for Base, 1 for Ethereum). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-vfat-io-api-78a55a37/get_farm_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"<string>","chain_id":"<integer>"}'
```

### get_farms

Retrieve a paginated list of yield farms sorted by TVL descending. Supports filtering by chain ID and searching by contract address. Each farm includes APR, TVL, protocol info, and pool composition.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `address` | string | No | Search by farm contract address to find a specific farm. |
| `chain_id` | integer | No | Filter by blockchain chain ID (e.g. 8453 for Base, 1 for Ethereum, 56 for BNB Chain, 42161 for Arbitrum). |
| `page` | integer | No | Page number for pagination. |
| `page_size` | integer | No | Number of farms per page. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-vfat-io-api-78a55a37/get_farms \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"<string>","chain_id":"<integer>","page":"<integer>","page_size":"<integer>"}'
```

### get_lending_markets

Retrieve the list of DeFi lending markets (compound-style) across all supported chains. Returns market addresses, underlying token details, and borrow/supply metrics.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-vfat-io-api-78a55a37/get_lending_markets \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_platform_stats

Retrieve vfat.io platform-wide statistics including total TVL, unique users, positions count, and per-chain breakdowns.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-vfat-io-api-78a55a37/get_platform_stats \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_portfolio

Retrieve the full portfolio data for a given wallet address including native token balances, farm positions, and compound lending positions across all supported chains.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `wallet` | string | Yes | Wallet address (e.g. 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-vfat-io-api-78a55a37/get_portfolio \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"wallet":"<string>"}'
```

### get_portfolio_chains

Retrieve the chain-by-chain USD balance breakdown of a portfolio. Returns only chains where the wallet has non-zero balances.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `wallet` | string | Yes | Wallet address (e.g. 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-vfat-io-api-78a55a37/get_portfolio_chains \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"wallet":"<string>"}'
```

### get_token_detail

Retrieve detailed data for a specific token including its liquidity pools across DEXes. Token metadata may be empty if the token is not in the main index but pools will still be returned.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `address` | string | Yes | Token contract address (e.g. 0x6b175474e89094c44da98b954eedeac495271d0f for DAI). |
| `chain_id` | integer | Yes | Blockchain chain ID (e.g. 1 for Ethereum, 8453 for Base). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-vfat-io-api-78a55a37/get_token_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"<string>","chain_id":"<integer>"}'
```

### get_tokens

Retrieve a paginated list of tokens tracked on vfat.io, sorted by liquidity descending. Returns token metadata including price, symbol, and 24h change.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number. |
| `page_size` | integer | No | Number of tokens per page. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-vfat-io-api-78a55a37/get_tokens \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","page_size":"<integer>"}'
```

### get_yield_deposits

Retrieve active yield farming deposit positions for a wallet tracked by vfat.io. Returns an empty array if the wallet has no active vfat-tracked positions.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `wallet` | string | Yes | Wallet address (e.g. 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-vfat-io-api-78a55a37/get_yield_deposits \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"wallet":"<string>"}'
```