# Patreon Search

## Overview

| Property | Value |
|----------|-------|
| **Status** | active |
| **Method** | `GET` |
| **Endpoint** | `/v2/patreon/search` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 1 credit per call |
| **Documentation** | https://www.piloterr.com/library/patreon-search |

## Description

Search Patreon creators by keyword and retrieve campaign cards with patron counts, post counts, and profile URLs.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/patreon/search' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Search creators by keyword

```json
{
  "query": "creator",
  "results": [
    {
      "id": "6730893",
      "url": "https://www.patreon.com/mrtini23",
      "name": "MrTini23",
      "thumb": "https://c10.patreonusercontent.com/4/patreon-media/p/campaign/6730893/45f72094d4704e4ebc38656dc63a91e3/eyJ3IjoyNDB9/3.jpg?token-time=2145916800&token-hash=NjIGYFK6C8zd6-nfelA2hysljSu-2dnpLQWzvOz1TRw%3D",
      "avatar": "https://c10.patreonusercontent.com/4/patreon-media/p/campaign/6730893/45f72094d4704e4ebc38656dc63a91e3/eyJ3IjoyNDB9/3.jpg?token-time=2145916800&token-hash=NjIGYFK6C8zd6-nfelA2hysljSu-2dnpLQWzvOz1TRw%3D",
      "is_nsfw": false,
      "summary": null,
      "post_count": 14,
      "creator_name": "MrTini23",
      "patron_count": null,
      "creation_name": "Retro Football Manager Content Creator",
      "primary_theme_color": "35236"
    },
    {
      "id": "3634516",
      "url": "https://www.patreon.com/cfemen",
      "name": "cfemen",
      "thumb": "https://c10.patreonusercontent.com/4/patreon-media/p/campaign/3634516/d98be5b6694e45c58ba758d186b5a0b1/eyJ3IjoyNDB9/1.jpg?token-time=2145916800&token-hash=Ohlsjl91t-EeaBRJyM0CbV3Z81ried7BEwlqQ5xYgOw%3D",
      "avatar": "https://c10.patreonusercontent.com/4/patreon-media/p/campaign/3634516/d98be5b6694e45c58ba758d186b5a0b1/eyJ3IjoyNDB9/1.jpg?token-time=2145916800&token-hash=Ohlsjl91t-EeaBRJyM0CbV3Z81ried7BEwlqQ5xYgOw%3D",
      "is_nsfw": false,
      "summary": null,
      "post_count": 1,
      "creator_name": "cfemen",
      "patron_count": 10465,
      "creation_name": "Game Content Creator",
      "primary_theme_color": "36491"
    },
    {
      "id": "10175206",
      "url": "https://www.patreon.com/JoshDaly",
      "name": "JoshDaly",
      "thumb": "https://c10.patreonusercontent.com/4/patreon-media/p/campaign/10175206/e0ce470692e845af8cf5671d2612cb6a/eyJ3IjoyNDB9/3.jpg?token-time=2145916800&token-hash=sMkJSJgskUydmu0ZZ73OrpoOHo2PYwfEPQvjU9ClJ54%3D",
      "avatar": "https://c10.patreonusercontent.com/4/patreon-media/p/campaign/10175206/e0ce470692e845af8cf5671d2612cb6a/eyJ3IjoyNDB9/3.jpg?token-time=2145916800&token-hash=sMkJSJgskUydmu0ZZ73OrpoOHo2PYwfEPQvjU9ClJ54%3D",
      "is_nsfw": false,
      "summary": null,
      "post_count": 1379,
      "creator_name": "JoshDaly",
      "patron_count": 9052,
      "creation_name": "Youtube Content Creator ",
      "primary_theme_color": "419450"
    }
  ],
  "pagination": {
    "next": "https://www.patreon.com/api/search?query=creator&page%5Bnumber%5D=3",
    "page": 2,
    "prev": "https://www.patreon.com/api/search?query=creator&page%5Bnumber%5D=1",
    "hits_total": 66,
    "pages_total": 4,
    "has_next_page": true,
    "has_prev_page": true
  }
}
```

## Documentation

## Overview
Search Patreon creators by keyword and retrieve structured campaign cards with profile URLs, patron counts, post counts, creation category, and NSFW flags. Piloterr handles Patreon access via request-mode crawling and returns clean JSON.

## Quickstart
```
GET https://api.piloterr.com/v2/patreon/search?query=creator
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Search keyword (e.g. creator name, niche, or topic) |

## Response fields
| Field | Type | Description |
|---|---|---|
| `query` | string | Echo of the search keyword |
| `results` | array | Matching creator campaigns |
| `results[].id` | string | Patreon campaign ID |
| `results[].url` | string | Public Patreon page URL |
| `results[].name` | string | Campaign display name |
| `results[].thumb` | string | Campaign thumbnail image URL |
| `results[].avatar` | string | Avatar image URL |
| `results[].is_nsfw` | boolean | Whether the campaign is marked NSFW |
| `results[].summary` | string \| null | Short campaign summary when available |
| `results[].post_count` | integer | Number of published posts |
| `results[].creator_name` | string | Creator display name |
| `results[].patron_count` | integer \| null | Total patrons when exposed |
| `results[].creation_name` | string | Campaign category label |
| `results[].primary_theme_color` | string \| null | Theme color identifier |
| `pagination.page` | integer | Current page number |
| `pagination.pages_total` | integer | Total number of pages |
| `pagination.hits_total` | integer | Total matching results |
| `pagination.has_next_page` | boolean | Whether another page exists |
| `pagination.has_prev_page` | boolean | Whether a previous page exists |
| `pagination.next` | string \| null | Next page API URL |
| `pagination.prev` | string \| null | Previous page API URL |

## Notes
- `patron_count` may be `null` when Patreon hides the count on search cards.
- Pagination metadata is returned under `pagination`.

## Main use cases
- Discover creators in a niche for influencer outreach
- Monitor patron growth across competitor campaigns
- Build creator discovery tools with live Patreon search data
- Feed CRM or marketing workflows with campaign URLs and metrics