https://github.com/aceasin/patreonbadge

Custom badge and scraper that utilizes Patreon's API without the need for authorization.
https://github.com/aceasin/patreonbadge

aceasin badge patreon scraper shields

Last synced: about 1 year ago
JSON representation

Custom badge and scraper that utilizes Patreon's API without the need for authorization.

• Host: GitHub
• URL: https://github.com/aceasin/patreonbadge
• Owner: AceAsin
• License: mit
• Created: 2020-08-23T19:44:02.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-04-29T23:05:49.000Z (about 3 years ago)
• Last Synced: 2025-04-05T07:02:25.280Z (over 1 year ago)
• Topics: aceasin, badge, patreon, scraper, shields
• Language: JavaScript
• Homepage:
• Size: 44.9 KB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: .GitHub/README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Patreon

[![Patreon](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fwww.patreon.com%2Fapi%2Fcampaigns%2F1839759&query=data.attributes.patron_count&suffix=%20Patrons&color=FF5441&label=Patreon&logo=Patreon&logoColor=FF5441&style=for-the-badge)](https://patreon.com/AceAsin)

[![Patreon](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fwww.patreon.com%2Fapi%2Fcampaigns%2F1839759&query=data.attributes.pledge_sum&prefix=$%20&suffix=%20USD%20/%20MO&color=FF5441&label=Patreon&logo=Patreon&logoColor=FF5441&style=for-the-badge)](https://patreon.com/AceAsin)

## About

> - A campaign identification is required in order to use this method. Visit a Patreon page and inspect it, then type one of the options below on the browser console to get the campaign identification. Alternatively, you're able to get a campaign identification by running the scraper app and entering a username when prompted.

> - The monthly pledge sum will not display if the owner of the page has their earnings set to private. It is recommended to set your earnings to public in order to be able to get the pledge sum.

> - Replace any text inside angle brackets with your own, usually '\' and or '\'. Don't forget to exclude the angle brackets, please do not include '<' or '>' once the text inside has been replaced.

## Console

### Campaign

```css

window.patreon.bootstrap.campaign.data.id

```

### Creator

```css

window.patreon.bootstrap.creator.data.id

```

## Scraper

### Install

```js

  npm i

```

### Start

```js

  npm start

```

## Badge

### Documentation

- [Shields](https://shields.io/#/endpoint)

- [Patreon](https://docs.patreon.com/#api-endpoints)

### Usage

- Endpoint

  - Decoded: `https://www.patreon.com/api/campaigns/`

  - Encoded: `https%3A%2F%2Fwww.patreon.com%2Fapi%2Fcampaigns%2F`

- Hypertext Markup Language (HTML)

  - Patron Count

    ```HTML

     

    ```

  - Pledge Sum

    ```HTML

     

    ```

- Markdown (MD)

  - Patron Count

    ```MD

    [![Patreon](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fwww.patreon.com%2Fapi%2Fcampaigns%2F&query=data.attributes.patron_count&suffix=%20Patrons&color=FF5441&label=Patreon&logo=Patreon&logoColor=FF5441&style=for-the-badge)](https://patreon.com/)

    ```

  - Pledge Sum

    ```MD

    [![Patreon](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fwww.patreon.com%2Fapi%2Fcampaigns%2F&query=data.attributes.pledge_sum&prefix=$%20&suffix=%20USD%20/%20MO&color=FF5441&label=Patreon&logo=Patreon&logoColor=FF5441&style=for-the-badge)](https://patreon.com/)

    ```

### Example

- Endpoint

  - Decoded: [`https://www.patreon.com/api/campaigns/1839759`](https://www.patreon.com/api/campaigns/1839759)

  - Encoded: [`https%3A%2F%2Fwww.patreon.com%2Fapi%2Fcampaigns%2F1839759`](https%3A%2F%2Fwww.patreon.com%2Fapi%2Fcampaigns%2F1839759)

- Hypertext Markup Language (HTML)

  - Patron Count

    ```HTML

     

    ```

  - Pledge Sum

    ```HTML

     

    ```

- Markdown (MD)

  - Patron Count

    ```MD

    [![Patreon](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fwww.patreon.com%2Fapi%2Fcampaigns%2F1839759&query=data.attributes.patron_count&suffix=%20Patrons&color=FF5441&label=Patreon&logo=Patreon&logoColor=FF5441&style=for-the-badge)](https://patreon.com/AceAsin)

    ```

  - Pledge Sum

    ```MD

    [![Patreon](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fwww.patreon.com%2Fapi%2Fcampaigns%2F1839759&query=data.attributes.pledge_sum&prefix=$%20&suffix=%20USD%20/%20MO&color=FF5441&label=Patreon&logo=Patreon&logoColor=FF5441&style=for-the-badge)](https://patreon.com/AceAsin)

    ```