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

> Discover trending NFT collections, search for specific projects, and view detailed collection information including top collectors and sponsors on Highlight.xyz. Find related projects and stay informed on what's gaining momentum in the NFT market.

**Category:** Web3 & Onchain | **Website:** [highlight.xyz/](https://highlight.xyz/) | **Docs:** [parse.bot/marketplace/f7e50f79-1d10-438f-b988-e89eb6c26244/highlight-xyz-api](https://parse.bot/marketplace/f7e50f79-1d10-438f-b988-e89eb6c26244/highlight-xyz-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-highlight-xyz-api-f7e50f79/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_collection_collectors

Retrieves wallet addresses that have minted from a collection, ordered by token count descending. Includes ENS names when available. Supports offset-based pagination via cursor. The totalCount in the response reflects the total number of unique collectors visible at the current depth (capped by the API).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `collection_id` | string | Yes | Collection onchain ID in format 'chain:address' (e.g. 'base:0x552404547278bC2ACd1dEF223e261473c78380e9'). |
| `cursor` | integer | No | Pagination offset. 0 for first page, increment by limit for subsequent pages. |
| `limit` | integer | No | Number of collectors per page. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-highlight-xyz-api-f7e50f79/get_collection_collectors \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"collection_id":"<string>","cursor":"<integer>","limit":"<integer>"}'
```

### get_collection_details

Fetches full details of a single NFT collection including contract address, token standard, collection type, size/supply, creator info, mint vectors (pricing options), and editions. The collection_id uses the onchain format 'chain:address' (e.g. 'base:0x...'). Returns null/stale_input if the collection does not exist.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `collection_id` | string | Yes | Collection onchain ID in format 'chain:address' or 'chain:address:tokenId' (e.g. 'base:0x552404547278bC2ACd1dEF223e261473c78380e9'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-highlight-xyz-api-f7e50f79/get_collection_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"collection_id":"<string>"}'
```

### get_collection_related_projects

Retrieves related collections by the same creator. Returns up to 9 collections from the same creator account. Useful for discovering a creator's portfolio after finding one of their collections.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `collection_id` | string | Yes | Collection onchain ID in format 'chain:address' (e.g. 'base:0x552404547278bC2ACd1dEF223e261473c78380e9'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-highlight-xyz-api-f7e50f79/get_collection_related_projects \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"collection_id":"<string>"}'
```

### get_collection_top_sponsors

Retrieves the top sponsors for a specific mint vector. Sponsors are users who paid for others' mints. The mint_vector_id is obtained from get_collection_details response's mintVectors[*].id field. Returns an empty sponsors array if no sponsorship activity exists for the vector.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Number of sponsors per page. |
| `mint_vector_id` | string | Yes | Mint vector ID from get_collection_details response's mintVectors[*].id field. |
| `page` | integer | No | Page number for pagination (1-based). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-highlight-xyz-api-f7e50f79/get_collection_top_sponsors \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","mint_vector_id":"<string>","page":"<integer>"}'
```

### get_trending_collections

Fetches trending NFT collections from Highlight.xyz ranked by recent mint activity. Returns up to 20 collections sorted by total mints within the specified time window. Each result includes mint count, pricing, supply, and creator info. The period_hours parameter controls the lookback window for calculating trending rank.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `period_hours` | integer | No | Time period in hours for calculating trending rank. 168 = 1 week, 24 = 1 day. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-highlight-xyz-api-f7e50f79/get_trending_collections \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"period_hours":"<integer>"}'
```

### search_collections

Searches for NFT collections by keyword against collection names. Returns up to 10 matching results. Each result includes basic collection info (id, chain, supply) and creator details. Useful for discovering collections before fetching full details.

**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-highlight-xyz-api-f7e50f79/search_collections \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```