# Cryptoslam — 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 NFT market trends and collection performance with access to global stats, collection rankings, sales history, and rarity data across multiple blockchains. Search collections, monitor top sales, and analyze blockchain performance metrics to stay informed on the NFT market.

**Category:** Web3 & Onchain | **Website:** [cryptoslam.io/](https://cryptoslam.io/) | **Docs:** [parse.bot/marketplace/484a8888-73b8-4891-b037-ac8f635036b1/cryptoslam-io-api](https://parse.bot/marketplace/484a8888-73b8-4891-b037-ac8f635036b1/cryptoslam-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-cryptoslam-io-api-484a8888/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_blockchain_rankings

Returns rankings of all blockchains by NFT sales volume, including detailed volume, wash sale statistics, buyer/seller counts, and transaction counts for each blockchain.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `period` | string | No | Time period filter. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cryptoslam-io-api-484a8888/get_blockchain_rankings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"period":"<string>"}'
```

### get_blockchain_stats

Returns NFT market statistics for a specific blockchain, including sales volume in USD, unique buyers, unique sellers, transaction count, and wash sale data. The chain is matched case-insensitively against the blockchain rankings list.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `chain` | string | Yes | Blockchain name (case-insensitive match). Confirmed working values include: Ethereum, BNB, Polygon, Solana, Cardano, Avalanche, Bitcoin, Arbitrum, Flow, ImmutableX. |
| `period` | string | No | Time period filter. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cryptoslam-io-api-484a8888/get_blockchain_stats \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"chain":"<string>","period":"<string>"}'
```

### get_collection_details

Returns detailed header statistics for a specific NFT collection by slug, including sales volume, transaction count, total owners, average hold time, buyers, and sellers. Each stat includes a time-series dataSeries array for charting.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `period` | string | No | Time period filter. |
| `slug` | string | Yes | Collection slug identifier (e.g. 'cryptopunks'). Obtainable from search_collections results (contractName field). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cryptoslam-io-api-484a8888/get_collection_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"period":"<string>","slug":"<string>"}'
```

### get_collection_historical_volume

Returns historical sales volume chart data for a specific NFT collection, grouped daily or monthly. Each record includes date, sales in USD, unique buyers, sellers, total transactions, and average price. Includes full history from collection inception.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `grouping` | string | No | Grouping type for the time series. |
| `slug` | string | Yes | Collection slug identifier (e.g. 'cryptopunks'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cryptoslam-io-api-484a8888/get_collection_historical_volume \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"grouping":"<string>","slug":"<string>"}'
```

### get_collection_rankings

Returns ranked list of NFT collections sorted by sales volume. Each entry includes collection name, volume in USD, buyer/seller counts, transaction counts, and platform info. Supports pagination via offset and limit.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results to return. |
| `offset` | integer | No | Offset for pagination. |
| `period` | string | No | Time period filter. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cryptoslam-io-api-484a8888/get_collection_rankings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","offset":"<integer>","period":"<string>"}'
```

### get_collection_rarity

Returns rarity scores and rankings for individual NFTs within a collection, sorted by rarity rank ascending. Each token includes its rarity rank, odds score, owner address, last sale price, and mint/burn timestamps.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results to return. |
| `slug` | string | Yes | Collection slug identifier (e.g. 'cryptopunks'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cryptoslam-io-api-484a8888/get_collection_rarity \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","slug":"<string>"}'
```

### get_collection_sales_history

Returns historical sales transactions for a specific NFT collection, ordered by most recent. Each sale includes buyer/seller addresses, price in USD and native token, token info, rarity rank, and wash sale flag.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results to return. |
| `slug` | string | Yes | Collection slug identifier (e.g. 'cryptopunks'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cryptoslam-io-api-484a8888/get_collection_sales_history \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","slug":"<string>"}'
```

### get_collection_top_sales

Returns the top individual NFT sales within a specific collection, ranked by price. Each sale includes token details, price, buyer/seller addresses, rarity rank, and timestamp. Supports pagination via offset and limit.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results to return. |
| `offset` | integer | No | Offset for pagination. |
| `period` | string | No | Time period filter. |
| `slug` | string | Yes | Collection slug identifier (e.g. 'cryptopunks'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cryptoslam-io-api-484a8888/get_collection_top_sales \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","offset":"<integer>","period":"<string>","slug":"<string>"}'
```

### get_global_market_stats

Returns global NFT market statistics including total sales volume, number of transactions, buyers, sellers, and market cap. The period parameter controls the time window for change-percentage calculations.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `period` | string | No | Time period filter for change percentages. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cryptoslam-io-api-484a8888/get_global_market_stats \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"period":"<string>"}'
```

### get_top_nft_sales

Returns a ranked list of the top individual NFT sales across all collections and blockchains. Each sale includes token details, price in USD and native token, marketplace info, and timestamp. Supports pagination via offset and limit.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results to return. |
| `offset` | integer | No | Offset for pagination. |
| `period` | string | No | Time period filter. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cryptoslam-io-api-484a8888/get_top_nft_sales \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","offset":"<integer>","period":"<string>"}'
```

### search_collections

Searches for NFT collections by name keyword. Returns matching collections with their slugs (contractName field, used as the slug parameter in collection endpoints), display names, and icon URLs.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword to match against collection names. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cryptoslam-io-api-484a8888/search_collections \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```
